MLT 6.26.0
|
Events class. More...
Public Member Functions | |
void | mlt_events_block (mlt_properties self, void *service) |
Block all events for a given service. | |
void | mlt_events_close_wait_for (mlt_properties self, mlt_event event) |
Cleanup after waiting for an event. | |
void | mlt_events_disconnect (mlt_properties self, void *service) |
Disconnect all events for a given service. | |
int | mlt_events_fire (mlt_properties self, const char *id,...) |
Fire an event. | |
void | mlt_events_init (mlt_properties self) |
Initialise the events structure. | |
mlt_event | mlt_events_listen (mlt_properties self, void *service, const char *id, mlt_listener listener) |
Register a listener. | |
int | mlt_events_register (mlt_properties self, const char *id, mlt_transmitter transmitter) |
Register an event and transmitter. | |
mlt_event | mlt_events_setup_wait_for (mlt_properties self, const char *id) |
Prepare to wait for an event. | |
void | mlt_events_unblock (mlt_properties self, void *service) |
Unblock all events for a given service. | |
void | mlt_events_wait_for (mlt_properties self, mlt_event event) |
Wait for an event. | |
Data Fields | |
mlt_properties | list |
mlt_properties | owner |
Static Private Member Functions | |
static void | mlt_events_close (mlt_events events) |
Close the events object. | |
static mlt_events | mlt_events_fetch (mlt_properties self) |
Fetch the events object. | |
static void | mlt_events_listen_for (mlt_properties self, condition_pair *pair) |
The event listener callback for the wait functions. | |
Events class.
Events provide messages and notifications between services and the application. A service can register an event and fire/send it upon certain conditions or times. Likewise, a service or an application can listen/receive specific events on specific services.
void mlt_events_block | ( | mlt_properties | self, |
void * | service | ||
) |
Block all events for a given service.
self | a properties list |
service | an opaque pointer |
|
staticprivate |
Close the events object.
events | an events object |
void mlt_events_close_wait_for | ( | mlt_properties | self, |
mlt_event | event | ||
) |
Cleanup after waiting for an event.
self | a properties list |
event | an event |
void mlt_events_disconnect | ( | mlt_properties | self, |
void * | service | ||
) |
Disconnect all events for a given service.
self | a properties list |
service | an opaque pointer |
|
staticprivate |
Fetch the events object.
self | a properties list |
int mlt_events_fire | ( | mlt_properties | self, |
const char * | id, | ||
... | |||
) |
Fire an event.
This takes a variable number of arguments to supply to the listener.
self | a properties list |
id | the name of an event |
void mlt_events_init | ( | mlt_properties | self | ) |
Initialise the events structure.
self | a properties list |
mlt_event mlt_events_listen | ( | mlt_properties | self, |
void * | service, | ||
const char * | id, | ||
mlt_listener | listener | ||
) |
Register a listener.
self | a properties list |
service | an opaque pointer |
id | the name of the event to listen for |
listener | the callback to receive an event message |
|
staticprivate |
The event listener callback for the wait functions.
self | a properties list |
pair | a condition pair |
int mlt_events_register | ( | mlt_properties | self, |
const char * | id, | ||
mlt_transmitter | transmitter | ||
) |
Register an event and transmitter.
self | a properties list |
id | the name of an event |
transmitter | the callback function to send an event message |
mlt_event mlt_events_setup_wait_for | ( | mlt_properties | self, |
const char * | id | ||
) |
Prepare to wait for an event.
self | a properties list |
id | the name of the event to wait for |
void mlt_events_unblock | ( | mlt_properties | self, |
void * | service | ||
) |
Unblock all events for a given service.
self | a properties list |
service | an opaque pointer |
void mlt_events_wait_for | ( | mlt_properties | self, |
mlt_event | event | ||
) |
Wait for an event.
self | a properties list |
event | an event |
mlt_properties mlt_events_struct::list |
mlt_properties mlt_events_struct::owner |