MLT  7.28.0
Public Member Functions | Data Fields
mlt_event_data Struct Reference

A container for data that may be supplied with an event. More...

#include <mlt_events.h>

Public Member Functions

mlt_event_data mlt_event_data_from_frame (mlt_frame frame)
 Initialize event data with a frame. More...
 
mlt_event_data mlt_event_data_from_int (int value)
 Initialize event data with an integer. More...
 
mlt_event_data mlt_event_data_from_object (void *value)
 Initialize event data with opaque data. More...
 
mlt_event_data mlt_event_data_from_string (const char *value)
 Initialize event data with a string. More...
 
mlt_event_data mlt_event_data_none ()
 Initialize an empty event data. More...
 
mlt_frame mlt_event_data_to_frame (mlt_event_data event_data)
 Get a frame from the event data. More...
 
int mlt_event_data_to_int (mlt_event_data event_data)
 Get an integer from the event data. More...
 
void * mlt_event_data_to_object (mlt_event_data event_data)
 Get a pointer from the event data. More...
 
const char * mlt_event_data_to_string (mlt_event_data event_data)
 Get a string from the event data. More...
 

Data Fields

union {
   int   i
 
   void *   p
 
u
 

Detailed Description

A container for data that may be supplied with an event.

Member Function Documentation

◆ mlt_event_data_from_frame()

mlt_event_data mlt_event_data_from_frame ( mlt_frame  frame)

Initialize event data with a frame.

Parameters
framethe frame with which to initialize the event data
Returns
an event data object

◆ mlt_event_data_from_int()

mlt_event_data mlt_event_data_from_int ( int  value)

Initialize event data with an integer.

Parameters
valuethe integer with which to initialize the event data
Returns
an event data object

◆ mlt_event_data_from_object()

mlt_event_data mlt_event_data_from_object ( void *  value)

Initialize event data with opaque data.

Parameters
valuethe pointer with which to initialize the event data
Returns
an event data object

◆ mlt_event_data_from_string()

mlt_event_data mlt_event_data_from_string ( const char *  value)

Initialize event data with a string.

Parameters
valuethe string with which to initialize the event data
Returns
an event data object

◆ mlt_event_data_none()

mlt_event_data mlt_event_data_none ( )

Initialize an empty event data.

Returns
an event data object

◆ mlt_event_data_to_frame()

mlt_frame mlt_event_data_to_frame ( mlt_event_data  event_data)

Get a frame from the event data.

Parameters
event_dataan event data object
Returns
a frame

◆ mlt_event_data_to_int()

int mlt_event_data_to_int ( mlt_event_data  event_data)

Get an integer from the event data.

Parameters
event_dataan event data object
Returns
an integer

◆ mlt_event_data_to_object()

void * mlt_event_data_to_object ( mlt_event_data  event_data)

Get a pointer from the event data.

Parameters
event_dataan event data object
Returns
a pointer

◆ mlt_event_data_to_string()

const char * mlt_event_data_to_string ( mlt_event_data  event_data)

Get a string from the event data.

Parameters
event_dataan event data object
Returns
a string

Field Documentation

◆ i

int mlt_event_data::i

◆ p

void* mlt_event_data::p

◆ 

union { ... } mlt_event_data::u

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