Tractor class. More...
#include <mlt_tractor.h>
Public Member Functions | |
| void | mlt_tractor_close (mlt_tractor self) |
| Close the tractor and free its resources. | |
| int | mlt_tractor_connect (mlt_tractor self, mlt_service producer) |
| Connect the tractor. | |
| mlt_field | mlt_tractor_field (mlt_tractor self) |
| Get the field self tractor is harvesting. | |
| mlt_producer | mlt_tractor_get_track (mlt_tractor self, int index) |
| Get the producer for a specific track. | |
| mlt_tractor | mlt_tractor_init () |
| Construct a tractor without a field or multitrack. | |
| mlt_multitrack | mlt_tractor_multitrack (mlt_tractor self) |
| Get the multitrack a tractor is pulling. | |
| mlt_tractor | mlt_tractor_new () |
| Construct a tractor as well as a field and multitrack. | |
| mlt_producer | mlt_tractor_producer (mlt_tractor self) |
| Get the producer object associated to the tractor. | |
| mlt_properties | mlt_tractor_properties (mlt_tractor self) |
| Get the properties object associated to the tractor. | |
| void | mlt_tractor_refresh (mlt_tractor self) |
| Ensure the tractors in/out points match the multitrack. | |
| mlt_service | mlt_tractor_service (mlt_tractor self) |
| Get the service object associated to the tractor. | |
| int | mlt_tractor_set_track (mlt_tractor self, mlt_producer producer, int index) |
| Set the producer for a specific track. | |
Data Fields | |
| struct mlt_producer_s | parent |
| A producer is a service. | |
| mlt_service | producer |
Detailed Description
Tractor class.
The tractor is a convenience class that works with the field class to manage a multitrack, track filters, and transitions.
- Property:
- multitrack holds a reference to the mulitrack object that a tractor manages
- Property:
- field holds a reference to the field object that a tractor manages
- Property:
- producer holds a reference to an encapsulated producer
- Property:
- global_feed a flag to indicate whether this tractor feeds to the consumer or stops here
- Property:
- global_queue is something for the data_feed functionality in the core module
- Property:
- data_queue is something for the data_feed functionality in the core module
Member Function Documentation
| void mlt_tractor_close | ( | mlt_tractor | self | ) |
Close the tractor and free its resources.
- Parameters:
-
self a tractor
| int mlt_tractor_connect | ( | mlt_tractor | self, |
| mlt_service | producer | ||
| ) |
Connect the tractor.
- Parameters:
-
self a tractor producer a producer
- Returns:
- true on error
| mlt_field mlt_tractor_field | ( | mlt_tractor | self | ) |
Get the field self tractor is harvesting.
- Parameters:
-
self a tractor
- Returns:
- a field or NULL if there is no field for this tractor
| mlt_producer mlt_tractor_get_track | ( | mlt_tractor | self, |
| int | index | ||
| ) |
Get the producer for a specific track.
- Parameters:
-
self a tractor index the 0-based track index
- Returns:
- the producer for track
index
| mlt_tractor mlt_tractor_init | ( | ) |
Construct a tractor without a field or multitrack.
Sets the resource property to "<tractor>", the mlt_type to "mlt_producer", and mlt_service to "tractor".
- Returns:
- the new tractor
| mlt_multitrack mlt_tractor_multitrack | ( | mlt_tractor | self | ) |
Get the multitrack a tractor is pulling.
- Parameters:
-
self a tractor
- Returns:
- a multitrack or NULL if there is none
| mlt_tractor mlt_tractor_new | ( | ) |
Construct a tractor as well as a field and multitrack.
Sets the resource property to "<tractor>", the mlt_type to "mlt_producer", and mlt_service to "tractor".
- Returns:
- the new tractor
| mlt_producer mlt_tractor_producer | ( | mlt_tractor | self | ) |
Get the producer object associated to the tractor.
- Parameters:
-
self a tractor
- Returns:
- the parent producer object
- See also:
- MLT_TRACTOR_PRODUCER
| mlt_properties mlt_tractor_properties | ( | mlt_tractor | self | ) |
Get the properties object associated to the tractor.
- Parameters:
-
self a tractor
- Returns:
- the tractor's property list
- See also:
- MLT_TRACTOR_PROPERTIES
| void mlt_tractor_refresh | ( | mlt_tractor | self | ) |
Ensure the tractors in/out points match the multitrack.
- Parameters:
-
self a tractor
| mlt_service mlt_tractor_service | ( | mlt_tractor | self | ) |
Get the service object associated to the tractor.
- Parameters:
-
self a tractor
- Returns:
- the parent service object
- See also:
- MLT_TRACTOR_SERVICE
| int mlt_tractor_set_track | ( | mlt_tractor | self, |
| mlt_producer | producer, | ||
| int | index | ||
| ) |
Set the producer for a specific track.
- Parameters:
-
self a tractor producer a producer index the 0-based track index
- Returns:
- true on error
Field Documentation
A producer is a service.
Reimplemented from mlt_producer_s.
The documentation for this struct was generated from the following files:
