Wasabi ExpressPlay SDK for Desktop Systems  1.23.0
Data Fields
WSB_PlaylistProxy_MediaSourceParams Struct Reference

Playlist Proxy URL parameters. More...

#include <WsbPlaylistProxy.h>

Data Fields

const char * source_content_type
 The source media mime type. More...
 
const char * content_type
 The URL response mime type. More...
 
unsigned int duration_seconds
 Required for BBTS without index as the content duration. More...
 
unsigned int bitrate_bps
 Required for BBTS without index, ignored for other content types. More...
 
const char * language
 Language desired for the audio. More...
 
const char * audio_codecs
 Supported audio codecs (MPEG DASH only). More...
 
const char * video_codecs
 Supported video codecs (MPEG DASH only). More...
 
const char * bbts_index_url
 Optional BBTS Index URL. More...
 
const char * master_playlist_appendix
 Additional contents to be appended to the master playlist produced by the proxy. More...
 
WSB_PlaylistProxy_TrackSelector audio_track_selector
 Designate the index space referenced by audio_track. More...
 
WSB_UInt32 audio_track
 Audio track selected. More...
 
WSB_PlaylistProxy_TrackSelector video_track_selector
 Designate the index space referenced by video_track. More...
 
WSB_UInt32 video_track
 Video track selected. More...
 
const char * extra_content_access_http_headers
 Additional HTTP headers passed in content access HTTP requests. More...
 
const char * extra_client_http_headers
 Additional HTTP headers passed from the Playlist Proxy to the HTTP client. More...
 
const char * subtitle_name
 Web VTT subtitles: UTF-8 Subtitle track name. More...
 
const char * subtitle_lang
 Web VTT subtitles: RFC 5646 language code. More...
 
const char * subtitle_url
 Web VTT subtitles: Absolute URL of the WebVTT file. More...
 

Detailed Description

Playlist Proxy URL parameters.

See also
WSB_PlaylistProxy_MakeUrl

Field Documentation

◆ audio_codecs

const char* WSB_PlaylistProxy_MediaSourceParams::audio_codecs

Supported audio codecs (MPEG DASH only).

The value is a comma separated list of codecs as in MPEG DASH representation @codecs attribute. A required codec is supported if there is a codec on this list with which the required codec name starts.

NULL or empty string implies "mp4a" codec support.

◆ audio_track

WSB_UInt32 WSB_PlaylistProxy_MediaSourceParams::audio_track

Audio track selected.

Track index or track ID depending on the audio_track_selector value. Ignored if audio_track_selector equals WSB_PP_TRACK_ANY. (Affects PDCF and Fragmented MP4 formats only.)

Since
1.13.4

◆ audio_track_selector

WSB_PlaylistProxy_TrackSelector WSB_PlaylistProxy_MediaSourceParams::audio_track_selector

Designate the index space referenced by audio_track.

Since
1.13.4

◆ bbts_index_url

const char* WSB_PlaylistProxy_MediaSourceParams::bbts_index_url

Optional BBTS Index URL.

Since
1.7

◆ bitrate_bps

unsigned int WSB_PlaylistProxy_MediaSourceParams::bitrate_bps

Required for BBTS without index, ignored for other content types.

◆ content_type

const char* WSB_PlaylistProxy_MediaSourceParams::content_type

The URL response mime type.

Can be NULL in which case content mime-type is assigned automatically.

◆ duration_seconds

unsigned int WSB_PlaylistProxy_MediaSourceParams::duration_seconds

Required for BBTS without index as the content duration.

Since
1.7 also designates PDCF content fragment duration.

◆ extra_client_http_headers

const char* WSB_PlaylistProxy_MediaSourceParams::extra_client_http_headers

Additional HTTP headers passed from the Playlist Proxy to the HTTP client.

String containing a comma separated list of colon separated pairs of header name and header value strings. Any characters in the header name and header value from the set of the three characters: ',' (comma), ':' (colon), and '' (percent), must be percent encoded (i.e. % followed by two hexadecimal digits equal to the corresponding ASCII code of the character being encoded).

Since
1.17

◆ extra_content_access_http_headers

const char* WSB_PlaylistProxy_MediaSourceParams::extra_content_access_http_headers

Additional HTTP headers passed in content access HTTP requests.

String containing a comma separated list of colon separated pairs of header name and header value strings. Any characters in the header name and header value from the set of the three characters: ',' (comma), ':' (colon), and '' (percent), must be percent encoded (i.e. % followed by two hexadecimal digits equal to the corresponding ASCII code of the character being encoded).

Since
1.15

◆ language

const char* WSB_PlaylistProxy_MediaSourceParams::language

Language desired for the audio.

NULL means any language. (MPEG DASH only)

◆ master_playlist_appendix

const char* WSB_PlaylistProxy_MediaSourceParams::master_playlist_appendix

Additional contents to be appended to the master playlist produced by the proxy.

Typically, the additional contents would specify a fallback low bandwidth media stream variant. Can be NULL if no additional contents is to be appended.

Since
1.9

◆ source_content_type

const char* WSB_PlaylistProxy_MediaSourceParams::source_content_type

The source media mime type.

Can be NULL in which case source media mime type is detected automatically.

◆ subtitle_lang

const char* WSB_PlaylistProxy_MediaSourceParams::subtitle_lang

Web VTT subtitles: RFC 5646 language code.

Will be used for the LANGUAGE attribute in the HLS playlist. Note that although not mandatory in the playlist, MAC Quicktime player will ignore subtitle information if the LANGUAGE is not present

Since
1.17

◆ subtitle_name

const char* WSB_PlaylistProxy_MediaSourceParams::subtitle_name

Web VTT subtitles: UTF-8 Subtitle track name.

Will be used for the NAME attribute in the HLS playlist

Since
1.17

◆ subtitle_url

const char* WSB_PlaylistProxy_MediaSourceParams::subtitle_url

Web VTT subtitles: Absolute URL of the WebVTT file.

Will be used for the URI attribute in the HLS playlist Note that WebVTT insertion only works for STATIC DASH proxy operation

Since
1.17

◆ video_codecs

const char* WSB_PlaylistProxy_MediaSourceParams::video_codecs

Supported video codecs (MPEG DASH only).

The value is a comma separated list of codecs as in MPEG DASH representation @codecs attribute. A required codec is supported if there is a codec on this list with which the required codec name starts.

NULL or empty string implies all "avc1" codec support.

◆ video_track

WSB_UInt32 WSB_PlaylistProxy_MediaSourceParams::video_track

Video track selected.

Track index or track ID depending on the video_track_selector value. Ignored if video_track_selector equals WSB_PP_TRACK_ANY. (Affects PDCF and Fragmented MP4 formats only.)

Since
1.13.4

◆ video_track_selector

WSB_PlaylistProxy_TrackSelector WSB_PlaylistProxy_MediaSourceParams::video_track_selector

Designate the index space referenced by video_track.

Since
1.13.4

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