List of pre-defined event types

Classes
struct	MMAL_EVENT_END_OF_STREAM_T
struct	MMAL_EVENT_FORMAT_CHANGED_T
struct	MMAL_EVENT_PARAMETER_CHANGED_T

Typedefs
typedef struct MMAL_EVENT_END_OF_STREAM_T	MMAL_EVENT_END_OF_STREAM_T
typedef struct MMAL_EVENT_FORMAT_CHANGED_T	MMAL_EVENT_FORMAT_CHANGED_T
typedef struct MMAL_EVENT_PARAMETER_CHANGED_T	MMAL_EVENT_PARAMETER_CHANGED_T

Functions
MMAL_EVENT_FORMAT_CHANGED_T *	mmal_event_format_changed_get (MMAL_BUFFER_HEADER_T *buffer)

Pre-defined event FourCCs
#define	MMAL_EVENT_ERROR   MMAL_FOURCC('E','R','R','O')
#define	MMAL_EVENT_EOS   MMAL_FOURCC('E','E','O','S')
#define	MMAL_EVENT_FORMAT_CHANGED   MMAL_FOURCC('E','F','C','H')
#define	MMAL_EVENT_PARAMETER_CHANGED   MMAL_FOURCC('E','P','C','H')

Detailed Description

This defines a list of standard event types. Components can still define proprietary event types by using their own FourCC and defining their own event structures.

Macro Definition Documentation

MMAL_EVENT_EOS

#define MMAL_EVENT_EOS   MMAL_FOURCC('E','E','O','S')

End-of-stream event. Data contains a MMAL_EVENT_END_OF_STREAM_T

Definition at line 51 of file mmal_events.h.

MMAL_EVENT_ERROR

#define MMAL_EVENT_ERROR   MMAL_FOURCC('E','R','R','O')

Error event. Data contains a MMAL_STATUS_T

Definition at line 48 of file mmal_events.h.

MMAL_EVENT_FORMAT_CHANGED

#define MMAL_EVENT_FORMAT_CHANGED   MMAL_FOURCC('E','F','C','H')

Format changed event. Data contains a MMAL_EVENT_FORMAT_CHANGED_T

Definition at line 54 of file mmal_events.h.

MMAL_EVENT_PARAMETER_CHANGED

#define MMAL_EVENT_PARAMETER_CHANGED   MMAL_FOURCC('E','P','C','H')

Parameter changed event. Data contains the new parameter value, see MMAL_EVENT_PARAMETER_CHANGED_T

Definition at line 59 of file mmal_events.h.

Typedef Documentation

MMAL_EVENT_END_OF_STREAM_T

typedef struct MMAL_EVENT_END_OF_STREAM_T MMAL_EVENT_END_OF_STREAM_T

End-of-stream event.

MMAL_EVENT_FORMAT_CHANGED_T

typedef struct MMAL_EVENT_FORMAT_CHANGED_T MMAL_EVENT_FORMAT_CHANGED_T

Format changed event data.

MMAL_EVENT_PARAMETER_CHANGED_T

typedef struct MMAL_EVENT_PARAMETER_CHANGED_T MMAL_EVENT_PARAMETER_CHANGED_T

Parameter changed event data. This is a variable sized event. The full parameter is included in the event data, not just the header. Use the MMAL_PARAMETER_HEADER_T::id field to determine how to cast the structure. The MMAL_PARAMETER_HEADER_T::size field can be used to check validity.

Function Documentation

mmal_event_format_changed_get()

MMAL_EVENT_FORMAT_CHANGED_T* mmal_event_format_changed_get

(

MMAL_BUFFER_HEADER_T *

buffer

)

Get a pointer to the MMAL_EVENT_FORMAT_CHANGED_T structure contained in the buffer header. Note that the pointer will point inside the data contained in the buffer header so doesn't need to be freed explicitly.

Parameters

buffer

buffer header containing the MMAL_EVENT_FORMAT_CHANGED event.

Returns

pointer to a MMAL_EVENT_FORMAT_CHANGED_T structure.