mmr_event_type_t

Updated: April 19, 2023

The mm-renderer events reported by the API

Synopsis:

#include <mm/renderer/events.h>
typedef enum mmr_event_type {
    MMR_EVENT_NONE,
    MMR_EVENT_ERROR,
    MMR_EVENT_STATE,
    MMR_EVENT_OVERFLOW,
    MMR_EVENT_WARNING,
    MMR_EVENT_STATUS,
    MMR_EVENT_METADATA,
    MMR_EVENT_PLAYLIST,
    MMR_EVENT_INPUT,
    MMR_EVENT_OUTPUT,
    MMR_EVENT_CTXTPAR,
    MMR_EVENT_TRKPAR,
    MMR_EVENT_OTHER
} mmr_event_type_t;

Data:

MMR_EVENT_NONE
No pending events.
MMR_EVENT_ERROR
Playback has stopped due to an error or EOF.
MMR_EVENT_STATE
State or speed change, other than an error or EOF.
MMR_EVENT_OVERFLOW
Some state changes lost; the event contains the most recent state.
MMR_EVENT_WARNING
Warning event.
MMR_EVENT_STATUS
Status update (position, buffer level, etc.)
MMR_EVENT_METADATA
Metadata update for the attached input, or one track referenced by the attached input, such as a playlist entry.
MMR_EVENT_PLAYLIST
Playlist window update.
MMR_EVENT_INPUT
An input has been attached or detached, or input parameters changed.
MMR_EVENT_OUTPUT
An output has been attached or detached, or output parameters changed.
MMR_EVENT_CTXTPAR
Context parameters have changed.
MMR_EVENT_TRKPAR
Track parameters for an individual track or a playlist entry have changed.
MMR_EVENT_OTHER
None of the above, but something has changed; you can typically ignore this event type.

Library:

mmrndclient

Description:

The mmr_event_type_t enumerated type defines the events that can be observed through the mm-renderer API. These events include changes to the context state or playback speed, updates of metadata or the playlist window, and input and output attachments and detachments.

To obtain the type of the last event, call mmr_event_get() and examine the type field in the mmr_event_t structure returned by the function.