mlt_field_s Struct Reference

Field class. More...

Public Member Functions
void	mlt_field_close (mlt_field self)
	Close the field. More...
void	mlt_field_disconnect_service (mlt_field self, mlt_service service)
	Remove a filter or transition from the field. More...
mlt_field	mlt_field_init ()
	Construct a field, mulitrack, and tractor. More...
mlt_multitrack	mlt_field_multitrack (mlt_field self)
	Get the multitrack. More...
mlt_field	mlt_field_new (mlt_multitrack multitrack, mlt_tractor tractor)
	Construct a field and initialize with supplied multitrack and tractor. More...
int	mlt_field_plant_filter (mlt_field self, mlt_filter that, int track)
	Plant a filter. More...
int	mlt_field_plant_transition (mlt_field self, mlt_transition that, int a_track, int b_track)
	Plant a transition. More...
mlt_properties	mlt_field_properties (mlt_field self)
	Get the properties associated to this field. More...
mlt_service	mlt_field_service (mlt_field self)
	Get the service associated to this field. More...
mlt_tractor	mlt_field_tractor (mlt_field self)
	Get the tractor. More...

Data Fields
mlt_multitrack	multitrack
	Multitrack. More...
mlt_service	producer
	This is the producer we're connected to. More...
mlt_tractor	tractor
	Tractor. More...

Detailed Description

Field class.

The field is a convenience class that works with the tractor and multitrack classes to manage track filters and transitions.

Member Function Documentation

mlt_field_close()

void mlt_field_close

(

mlt_field

self

)

Close the field.

Parameters

self

a field

mlt_field_disconnect_service()

void mlt_field_disconnect_service	(	mlt_field	self,
		mlt_service	service
	)

Remove a filter or transition from the field.

Parameters

self	a field
service	the filter or transition to remove

mlt_field_init()

mlt_field mlt_field_init

(

)

Construct a field, mulitrack, and tractor.

Returns

a new field

mlt_field_multitrack()

mlt_multitrack mlt_field_multitrack

(

mlt_field

self

)

Get the multitrack.

Parameters

self

a field

Returns

the multitrack

mlt_field_new()

mlt_field mlt_field_new	(	mlt_multitrack	multitrack,
		mlt_tractor	tractor
	)

Construct a field and initialize with supplied multitrack and tractor.

Parameters

multitrack	a multitrack
tractor	a tractor

Returns

a new field

mlt_field_plant_filter()

int mlt_field_plant_filter	(	mlt_field	self,
		mlt_filter	that,
		int	track
	)

Plant a filter.

Parameters

self	a field
that	a filter
track	the track index

Returns

true if there was an error

mlt_field_plant_transition()

int mlt_field_plant_transition	(	mlt_field	self,
		mlt_transition	that,
		int	a_track,
		int	b_track
	)

Plant a transition.

Parameters

self	a field
that	a transition
a_track	input A's track index
b_track	input B's track index

Returns

true if there was an error

mlt_field_properties()

mlt_properties mlt_field_properties

(

mlt_field

self

)

Get the properties associated to this field.

Parameters

self

a field

Returns

a properties list

mlt_field_service()

mlt_service mlt_field_service

(

mlt_field

self

)

Get the service associated to this field.

Parameters

self

a field

Returns

the tractor as a service

mlt_field_tractor()

mlt_tractor mlt_field_tractor

(

mlt_field

self

)

Get the tractor.

Parameters

self

a field

Returns

the tractor

Field Documentation

multitrack

mlt_multitrack mlt_field_s::multitrack

Multitrack.

producer

mlt_service mlt_field_s::producer

This is the producer we're connected to.

tractor

mlt_tractor mlt_field_s::tractor

Tractor.

---

The documentation for this struct was generated from the following file:

• mlt_field.c