You.i Engine
CYIAbstractVideoPlayer::TimedMetadata Struct Reference

Detailed Description

Describes timed metadata that is contained at a specific time within the media.

#include <player/YiAbstractVideoPlayer.h>

Public Member Functions

 TimedMetadata ()
 

Public Attributes

CYIString identifier
 
CYIString value
 
std::chrono::microseconds timestamp
 
std::chrono::microseconds duration
 
std::map< CYIString, CYIStringadditionalData
 

Constructor & Destructor Documentation

◆ TimedMetadata()

CYIAbstractVideoPlayer::TimedMetadata::TimedMetadata ( )

Creates an initialized TimedMetadata object.

Member Data Documentation

◆ additionalData

std::map<CYIString, CYIString> CYIAbstractVideoPlayer::TimedMetadata::additionalData

Provides additional data associated with the timed metadata. This data is contextual to the identifier.

See also
CYIAbstractVideoPlayer::TimedMetadataAdditionalDataKeys

◆ duration

std::chrono::microseconds CYIAbstractVideoPlayer::TimedMetadata::duration

The time duration for which the metadata is relevant within the media.

Note
If the duration of the metadata is not available this will be set to std::chrono::duration::max.

◆ identifier

CYIString CYIAbstractVideoPlayer::TimedMetadata::identifier

Identifies the metadata value contents. For example when the metadata is of the ID3 format this may be a frame type such as TXXX or PRIV. When the metadata is a DASH Event Message the identifier will be EMSG.

◆ timestamp

std::chrono::microseconds CYIAbstractVideoPlayer::TimedMetadata::timestamp

The presentation time at which the metadata is located within the media.

◆ value

CYIString CYIAbstractVideoPlayer::TimedMetadata::value

The metadata value. The value contents will match that described by the identifier.


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