MLT 6.22.1
mlt_consumer.h
Go to the documentation of this file.
1
23#ifndef MLT_CONSUMER_H
24#define MLT_CONSUMER_H
25
26#include "mlt_service.h"
27#include "mlt_events.h"
28#include <pthread.h>
29
88{
91
97 int ( *start )( mlt_consumer );
98
104 int ( *stop )( mlt_consumer );
105
112
117 void ( *purge )( mlt_consumer );
118
123 void ( *close )( mlt_consumer );
124
125 void *local;
126 void *child;
127};
128
129#define MLT_CONSUMER_SERVICE( consumer ) ( &( consumer )->parent )
130#define MLT_CONSUMER_PROPERTIES( consumer ) MLT_SERVICE_PROPERTIES( MLT_CONSUMER_SERVICE( consumer ) )
131
132extern int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile );
136extern int mlt_consumer_connect( mlt_consumer self, mlt_service producer );
147
148#endif
event handling
interface declaration for all service classes
int32_t mlt_position
Definition: mlt_types.h:163
struct mlt_consumer_s * mlt_consumer
pointer to Consumer object
Definition: mlt_types.h:200
Consumer abstract service class.
Definition: mlt_consumer.h:88
int mlt_consumer_start(mlt_consumer self)
Start the consumer.
Definition: mlt_consumer.c:515
mlt_frame mlt_consumer_get_frame(mlt_consumer self)
Protected method for consumer to get frames from connected service.
Definition: mlt_consumer.c:673
int(* is_stopped)(mlt_consumer)
Get whether the consumer is running or stopped (virtual function).
Definition: mlt_consumer.h:111
void(* purge)(mlt_consumer)
Purge the consumer of buffered data (virtual function).
Definition: mlt_consumer.h:117
int mlt_consumer_is_stopped(mlt_consumer self)
Determine if the consumer is stopped.
Definition: mlt_consumer.c:1704
mlt_properties mlt_consumer_properties(mlt_consumer self)
Get the consumer properties.
Definition: mlt_consumer.c:433
void(* close)(mlt_consumer)
The destructor virtual function.
Definition: mlt_consumer.h:123
void mlt_consumer_stopped(mlt_consumer self)
Callback for the implementation to indicate a stopped condition.
Definition: mlt_consumer.c:1630
void * local
instance object
Definition: mlt_consumer.h:125
void mlt_consumer_purge(mlt_consumer self)
Flush the read/render thread's buffer.
Definition: mlt_consumer.c:1334
void mlt_consumer_close(mlt_consumer self)
Close and destroy the consumer.
Definition: mlt_consumer.c:1719
int(* stop)(mlt_consumer)
Stop the consumer (virtual function).
Definition: mlt_consumer.h:104
struct mlt_service_s parent
A consumer is a service.
Definition: mlt_consumer.h:90
mlt_consumer mlt_consumer_new(mlt_profile profile)
Create a new consumer.
Definition: mlt_consumer.c:394
int(* start)(mlt_consumer)
Start the consumer to pull frames (virtual function).
Definition: mlt_consumer.h:97
int mlt_consumer_stop(mlt_consumer self)
Stop the consumer.
Definition: mlt_consumer.c:1644
mlt_frame mlt_consumer_rt_frame(mlt_consumer self)
Get the next frame from the producer connected to a consumer.
Definition: mlt_consumer.c:1553
int mlt_consumer_connect(mlt_consumer self, mlt_service producer)
Connect the consumer to the producer.
Definition: mlt_consumer.c:449
mlt_position mlt_consumer_position(mlt_consumer consumer)
Get the position of the last frame shown.
Definition: mlt_consumer.c:1760
mlt_service mlt_consumer_service(mlt_consumer self)
Get the parent service object.
Definition: mlt_consumer.c:420
int mlt_consumer_put_frame(mlt_consumer self, mlt_frame frame)
An alternative method to feed frames into the consumer.
Definition: mlt_consumer.c:628
void * child
the object of a subclass
Definition: mlt_consumer.h:126
int mlt_consumer_init(mlt_consumer self, void *child, mlt_profile profile)
Initialize a consumer service.
Definition: mlt_consumer.c:106
Frame class.
Definition: mlt_frame.h:74
Profile class.
Definition: mlt_profile.h:35
Properties class.
Definition: mlt_properties.h:37
Service abstract base class.
Definition: mlt_service.h:58
void * child
the object of a subclass
Definition: mlt_service.h:75