doxygen/mlt__consumer_8h_source.html

 #ifndef MLT_CONSUMER_H

 #define MLT_CONSUMER_H


 #include "mlt_events.h"

 #include "mlt_service.h"

 #include <pthread.h>


 struct mlt_consumer_s

 {

     struct mlt_service_s parent;


     int (*start)(mlt_consumer);


     int (*stop)(mlt_consumer);


     int (*is_stopped)(mlt_consumer);


     void (*purge)(mlt_consumer);


     void (*close)(mlt_consumer);


     void *local;

     void *child;

 };


 #define MLT_CONSUMER_SERVICE(consumer) (&(consumer)->parent)

 #define MLT_CONSUMER_PROPERTIES(consumer) MLT_SERVICE_PROPERTIES(MLT_CONSUMER_SERVICE(consumer))


 extern int mlt_consumer_init(mlt_consumer self, void *child, mlt_profile profile);

 extern mlt_consumer mlt_consumer_new(mlt_profile profile);

 extern mlt_service mlt_consumer_service(mlt_consumer self);

 extern mlt_properties mlt_consumer_properties(mlt_consumer self);

 extern int mlt_consumer_connect(mlt_consumer self, mlt_service producer);

 extern int mlt_consumer_start(mlt_consumer self);

 extern void mlt_consumer_purge(mlt_consumer self);

 extern int mlt_consumer_put_frame(mlt_consumer self, mlt_frame frame);

 extern mlt_frame mlt_consumer_get_frame(mlt_consumer self);

 extern mlt_frame mlt_consumer_rt_frame(mlt_consumer self);

 extern int mlt_consumer_stop(mlt_consumer self);

 extern int mlt_consumer_is_stopped(mlt_consumer self);

 extern void mlt_consumer_stopped(mlt_consumer self);

 extern void mlt_consumer_close(mlt_consumer);

 extern mlt_position mlt_consumer_position(mlt_consumer);


 #endif

mlt_events.h
event handling

mlt_service.h
interface declaration for all service classes

mlt_position
int32_t mlt_position
Definition: mlt_types.h:217

mlt_consumer
struct mlt_consumer_s * mlt_consumer
pointer to Consumer object
Definition: mlt_types.h:255

mlt_consumer_s
Consumer abstract service class.
Definition: mlt_consumer.h:94

mlt_consumer_s::mlt_consumer_start
int mlt_consumer_start(mlt_consumer self)
Start the consumer.
Definition: mlt_consumer.c:461

mlt_consumer_s::mlt_consumer_get_frame
mlt_frame mlt_consumer_get_frame(mlt_consumer self)
Protected method for consumer to get frames from connected service.
Definition: mlt_consumer.c:618

mlt_consumer_s::is_stopped
int(* is_stopped)(mlt_consumer)
Get whether the consumer is running or stopped (virtual function).
Definition: mlt_consumer.h:117

mlt_consumer_s::purge
void(* purge)(mlt_consumer)
Purge the consumer of buffered data (virtual function).
Definition: mlt_consumer.h:123

mlt_consumer_s::mlt_consumer_is_stopped
int mlt_consumer_is_stopped(mlt_consumer self)
Determine if the consumer is stopped.
Definition: mlt_consumer.c:1680

mlt_consumer_s::mlt_consumer_properties
mlt_properties mlt_consumer_properties(mlt_consumer self)
Get the consumer properties.
Definition: mlt_consumer.c:381

mlt_consumer_s::close
void(* close)(mlt_consumer)
The destructor virtual function.
Definition: mlt_consumer.h:129

mlt_consumer_s::mlt_consumer_stopped
void mlt_consumer_stopped(mlt_consumer self)
Callback for the implementation to indicate a stopped condition.
Definition: mlt_consumer.c:1604

mlt_consumer_s::local
void * local
instance object
Definition: mlt_consumer.h:131

mlt_consumer_s::mlt_consumer_purge
void mlt_consumer_purge(mlt_consumer self)
Flush the read/render thread's buffer.
Definition: mlt_consumer.c:1312

mlt_consumer_s::mlt_consumer_close
void mlt_consumer_close(mlt_consumer self)
Close and destroy the consumer.
Definition: mlt_consumer.c:1695

mlt_consumer_s::stop
int(* stop)(mlt_consumer)
Stop the consumer (virtual function).
Definition: mlt_consumer.h:110

mlt_consumer_s::parent
struct mlt_service_s parent
A consumer is a service.
Definition: mlt_consumer.h:96

mlt_consumer_s::mlt_consumer_new
mlt_consumer mlt_consumer_new(mlt_profile profile)
Create a new consumer.
Definition: mlt_consumer.c:345

mlt_consumer_s::start
int(* start)(mlt_consumer)
Start the consumer to pull frames (virtual function).
Definition: mlt_consumer.h:103

mlt_consumer_s::mlt_consumer_stop
int mlt_consumer_stop(mlt_consumer self)
Stop the consumer.
Definition: mlt_consumer.c:1618

mlt_consumer_s::mlt_consumer_rt_frame
mlt_frame mlt_consumer_rt_frame(mlt_consumer self)
Get the next frame from the producer connected to a consumer.
Definition: mlt_consumer.c:1526

mlt_consumer_s::mlt_consumer_connect
int mlt_consumer_connect(mlt_consumer self, mlt_service producer)
Connect the consumer to the producer.
Definition: mlt_consumer.c:397

mlt_consumer_s::mlt_consumer_position
mlt_position mlt_consumer_position(mlt_consumer consumer)
Get the position of the last frame shown.
Definition: mlt_consumer.c:1732

mlt_consumer_s::mlt_consumer_service
mlt_service mlt_consumer_service(mlt_consumer self)
Get the parent service object.
Definition: mlt_consumer.c:368

mlt_consumer_s::mlt_consumer_put_frame
int mlt_consumer_put_frame(mlt_consumer self, mlt_frame frame)
An alternative method to feed frames into the consumer.
Definition: mlt_consumer.c:577

mlt_consumer_s::child
void * child
the object of a subclass
Definition: mlt_consumer.h:132

mlt_consumer_s::mlt_consumer_init
int mlt_consumer_init(mlt_consumer self, void *child, mlt_profile profile)
Initialize a consumer service.
Definition: mlt_consumer.c:105

mlt_frame_s
Frame class.
Definition: mlt_frame.h:90

mlt_profile_s
Profile class.
Definition: mlt_profile.h:35

mlt_properties_s
Properties class.
Definition: mlt_properties.h:40

mlt_service_s
Service abstract base class.
Definition: mlt_service.h:58

mlt_service_s::child
void * child
the object of a subclass
Definition: mlt_service.h:75