Thrift module: media

ModuleServicesData typesConstants
media MediaEvent
MediaPlayback
MediaType

Enumerations

Enumeration: MediaType


UNKNOWN0
VIDEO1
AUDIO2

Enumeration: MediaEvent


UNKNOWN0
Unknown media type


REQUEST1
The media has been requested.
Currently, it appears this event is only received for pre-roll videos.


READY2
The media is ready to play.


PLAY3
The media has started playing.


PERCENT254
The media has played a quarter of the way through.
Currently, it appears that pre-roll videos do not send this event.


PERCENT505
The media has played half way though.
Currently, it appears that pre-roll videos do not send this event.


PERCENT756
The media has played three quarters of the way though.
Currently, it appears that pre-roll videos do not send this event.


THE_END7
The media has played to the end.
NB: "END" is a reserved word in thrift apparently


PAUSE8
The media has been paused before the end.


MUTE9
The media has been muted.


UNMUTE10
The media has been unmuted.


ENTER_FULLSCREEN11
The media has been displayed in fullscreen mode.


EXIT_FULLSCREEN12
The media has left fullscreen mode.


VIEW13
The media player has been displayed on the screen.
This is separate to the media being played, but may coincide if the player autoplays.



Data structures

Struct: MediaPlayback

KeyFieldTypeDescriptionRequirednessDefault value
1mediaIdstringThe id of the media asset, e.g. gu-video-454297906 This matches up with the media id within the content api. required
2mediaTypeMediaTypeThe media type required
3prerollboolIf true, this event relates to the pre-roll (ad) of this media. If false, this event reated to the core media content. required
4eventTypeMediaEventThe event type. required

Details about media playback progress
Note: currently only guardian-hosted videos are reported.