The mm-renderer properties reported by the event.


All the mm-renderer properties reported by the event, represented as a dictionary object stored in the data field of the mmr_event_t data structure. Some events, such as STATE, ERROR, and WARNING events, have all their properties pre-parsed into other mmr_event_t fields, so no additional information can be found in the data field. Other events, notably events that indicate updates to mm-renderer parameters or metadata, have most of their properties stored in the data field, so clients must extract this information from the dictionary.

Which properties are stored in the dictionary depends also on the configuration of the attached input and outputs. For instance, the properties returned with events that indicate updates to input, track, or output parameters consist of the latest parameters the client passed into the Client API, plus the track URL and type. The properties returned with METADATA events vary with the input type (e.g. the file format, and whether the input is a track or playlist).

To look up parameter values in a strm_dict_t dictionary object by name, see the strm_dict_find_value() function in the Dictionary Object API.

The event types with information stored in the data field, and the associated dictionary contents are as follows:

Event type Property name(s) Description
MMR_EVENT_STATUS position The play position. This is the same value stored in the pos_str field in the mmr_event_t structure.
bufferstatus The status or current activity of the buffer: buffering, playing, or idle
bufferlevel The buffer level as two decimal numbers (in milliseconds) separated by a slash: level/capacity
volume Available only for audio recording. The current volume level of the input signal against the maximum volume level, separated by a slash: current_level/maximum_level
MMR_EVENT_METADATA md_title_name The track name
md_title_artist The artist name
md_title_album The album name
md_title_genre The title genre (classical, rock, funk, etc.)
md_title_comment Text information about the track. The source of this information depends on the track format. For example, the information is taken from the COMM frame for ID3 tracks.
md_title_duration The track length
md_title_track The track number, if the track was ripped from a CD
md_title_disc The disc number, if the track was ripped from a multi-disc album
md_title_samplerate The number of samples (measurements) taken from the input signal per time unit (typically, a second) during recording. For audio content, this field refers to the audio sampling rate; for video, it's the video frame rate.
md_title_bitrate The track bit rate. This is only an approximate value, based on the total bit rate from all media streams in the input track and ignoring any potential variation in bit rate throughout playback.
md_title_protected A boolean attribute (either 0 or 1) that indicates if the track is DRM-protected
md_title_seekable A boolean attribute (either 0 or 1) that indicates if the track supports seeking
md_title_pausable A boolean attribute (either 0 or 1) that indicates if the track can be paused
md_title_mediatype The track media type (2 for video only, 4 for audio only, and 6 for audio and video)
md_video_width The video width, in physical units
md_video_height The video height, in phyiscal units
md_video_pixel_width The video width, in pixels
md_video_pixel_height The video height, in pixels
md_video_capture_format The media file format in which the video was recorded
MMR_EVENT_PLAYLIST All playlist information fields The playlist information fields contained in the mmr_event_playlist structure, which is stored in the details field of the mmr_event structure for playlist events.
MMR_EVENT_INPUT All input parameters and the input URL and type The input parameters specified in the last call to mmr_input_parameters.html, and the input URL and type specified in the last call to mmr_input_attach.html. Some input parameters may have been changed by mm-renderer.
MMR_EVENT_OUTPUT All output parameters and the output URL and type The output parameters specified in the last call to mmr_output_parameters.html, the output type specified in the last call to mmr_output_attach.html, and the output URL specified in the last call to either of these two functions.
MMR_EVENT_CTXTPAR updateinterval The frequency of mm-renderer status updates requested by the client. Currently, this parameter is supported only for the MMF audio/video player routing plugin.
MMR_EVENT_TRKPAR All track parameters The track parameters specified in the last call to mmr_track_parameters.html