Class: SrgSsr

new SrgSsr()

Source: middleware/srgssr.js, line 21

Methods

(static) addBlockedSegments(player, segmentsopt)

Adds blocked segments to the player.

Parameters:

Name	Type	Attributes	Default	Description
`player`	Player
`segments`	Array.<Segment>	<optional>	[]

Source: middleware/srgssr.js, line 31

(static) addChapters(player, chapterUrn, chaptersopt)

Adds chapters to the player.

Parameters:

Name	Type	Attributes	Default	Description
`player`	Player
`chapterUrn`	string			The URN of the main chapter.
`chapters`	Array.<Chapter>	<optional>	[]

Source: middleware/srgssr.js, line 121

(static) addIntervals(player, intervalsopt)

Adds intervals to the player.

Parameters:

Name	Type	Attributes	Default	Description
`player`	Player
`intervals`	Array.<TimeInterval>	<optional>	[]

Source: middleware/srgssr.js, line 148

(static) addRemoteTextTracks(player, subtitlesopt)

Adds remote text tracks from an array of subtitles.

Parameters:

Name	Type	Attributes	Default	Description
`player`	Player
`subtitles`	Array.<Subtitle>	<optional>	[]

Source: middleware/srgssr.js, line 60

(static) addTextTrackCue(textTrack, data)

Add a new cue to a text track with the given data.

Parameters:

Name	Type	Description
`textTrack`	TextTrack
`data`	Segment \| Chapter \| TimeInterval	SRG SSR's cue-like representation

Source: middleware/srgssr.js, line 88

(static) addTextTracks(player, srcMediaObj)

Add multiple text tracks to the player.

Parameters:

Name	Type	Description
`player`	Player
`srcMediaObj`	ComposedSrcMediaData

Source: middleware/srgssr.js, line 107

(static) blockingReason(player, srcMediaObj) → {undefined|Boolean}

Set a blocking reason according to the block reason returned by mediaData.

Parameters:

Name	Type	Description
`player`	Player
`srcMediaObj`	ComposedSrcMediaData

Source: middleware/srgssr.js, line 176

Returns:

Type:: undefined | Boolean

(async, static) composeAkamaiResources(resources) → {Promise.<Array.<MainResourceWithKeySystems>>}

Add the Akamai token to all resources if at least one of them has tokenType set to Akamai.

Parameters:

Name	Type	Description
`resources`	Array.<MainResourceWithKeySystems>

Source: middleware/srgssr.js, line 202

Returns:

Type:: Promise.<Array.<MainResourceWithKeySystems>>

(static) composeKeySystemsResources(resources) → {Array.<MainResourceWithKeySystems>}

Add the keySystems property to all resources if at least one of them has DRM.

Parameters:

Name	Type	Description
`resources`	Array.<MainResource>

Source: middleware/srgssr.js, line 219

Returns:

Type:: Array.<MainResourceWithKeySystems>

(static) composeMainResources(mediaComposition) → {Promise.<Array.<MainResourceWithKeySystems>>}

Get the main resources from a mediaComposition. May add an Akamai token or key systems if required by the resource.

Parameters:

Name	Type	Description
`mediaComposition`	MediaComposition

Source: middleware/srgssr.js, line 238

Returns:

Type:: Promise.<Array.<MainResourceWithKeySystems>>

(static) composeSrcMediaData(srcObj, resource) → {ComposedSrcMediaData}

Compose source options with media data. MediaData properties from source options overwrite mediaData from IL.

Parameters:

Name Type Description

srcObj

any

Properties

Name	Type	Description
`mediaData`	any	overrides or adds metadata to the composed mediaData.
`disableTrackers`	boolean

resource MainResourceWithKeySystems

Source: middleware/srgssr.js, line 257

Returns:

Type:: ComposedSrcMediaData

(static) createTextTrack(player, trackId) → {Promise.<TextTrack>}

Create a new metadata text track.

Parameters:

Name	Type	Description
`player`	Player
`trackId`	String	Text track unique ID

Source: middleware/srgssr.js, line 285

Returns:

Type:: Promise.<TextTrack>

(static) cuechangeEventProxy(player)

Proxy SRG SSR chapters and intervals cuechange events at player level.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 304

(static) dataProvider(player) → {DataProvider}

SRG SSR data provider singleton.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 324

Returns:

Type:: DataProvider

(static) dataProviderError(player, error) → {undefined|true}

Set an error if something goes wrong with the data provider.

Parameters:

Name	Type	Description
`player`	Player
`error`	Object

Source: middleware/srgssr.js, line 352

Returns:

Type:: undefined | true

(static) error(player, error)

Set player error.

Parameters:

Name	Type	Description
`player`	Player
`error`	Object

Source: middleware/srgssr.js, line 378

(static) filterIncompatibleResources(resources) → {Array.<MainResource>}

Filter out incompatible resources such as RTMP and HDS.

Parameters:

Name	Type	Description
`resources`	Array.<MainResource>	Resources to filter

Source: middleware/srgssr.js, line 395

Returns:

The filtered resources

Type:: Array.<MainResource>

(static) getBlockedSegment(player) → {VTTCue|undefined}

Get the current blocked segment from the player.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 408

Returns:

The blocked segment cue object, or undefined

Type:: VTTCue | undefined

(static) getBlockedSegmentByTime(player, currentTime) → {VTTCue|undefined}

Get the VTT cue of a blocked segment.

Parameters:

Name	Type	Description
`player`	Player
`currentTime`	Number

Source: middleware/srgssr.js, line 428

Returns:

The VTT cue of a blocked segment, or undefined

Type:: VTTCue | undefined

(async, static) getMediaComposition(urn, requestHandler) → {Promise.<MediaComposition>}

Get mediaComposition from an URN.

Parameters:

Name	Type	Description
`urn`	String
`requestHandler`	function

Source: middleware/srgssr.js, line 447

Returns:

Type:: Promise.<MediaComposition>

(static) getMediaData(resources) → {MainResourceWithKeySystems}

Get the mediaData most likely to be compatible depending on the browser.

Parameters:

Name	Type	Description
`resources`	Array.<MainResourceWithKeySystems>

Source: middleware/srgssr.js, line 463

Returns:

By default, the first entry is used if none is compatible.

Type:: MainResourceWithKeySystems

(async, static) getSrcMediaObj(player, srcObj) → {Promise.<ComposedSrcMediaData>}

Get the source media object.

Parameters:

Name	Type	Description
`player`	Player
`srcObj`	any

Source: middleware/srgssr.js, line 480

Returns:

The composed source media data.

Type:: Promise.<ComposedSrcMediaData>

(static) handleCurrentTime(player, currentTime) → {number}

Handles the middleware's currentTime function.

If the current time is between the start and end of a blocked segment, the blocked portion will be skipped.

Note: This function should disappear as soon as this behavior is supported on the packaging side.

Parameters:

Name	Type	Description
`player`	Player
`currentTime`	number

Source: middleware/srgssr.js, line 518

Returns:

Type:: number

(static) handleSetCurrentTime(player, currentTime) → {number}

Handles the middleware's setCurrentTime function.

Modify the current time if the value is between the start and end of a blocked segment.

Note: This function should disappear as soon as this behavior is supported on the packaging side.

Parameters:

Name	Type	Description
`player`	Player
`currentTime`	number

Source: middleware/srgssr.js, line 550

Returns:

Type:: number

(async, static) handleSetSource(player, srcObj, next) → {Promise.<any>}

Handles the middleware's setSource function.

This function allows to:

resolve a URN into media that can be played by the player
initialize media playback tracking
update the title bar
handle blocking reasons
add remote subtitles

Parameters:

Name	Type	Description
`player`	Player
`srcObj`	any
`next`	function

Source: middleware/srgssr.js, line 574

Returns:

Type:: Promise.<any>

(static) middleware(player) → {Object}

Middleware to resolve SRG SSR URNs into playable media.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 682

Returns:

Type:: Object

(static) pillarboxMonitoring(player) → {PillarboxMonitoring}

PillarboxMonitoring monitoring singleton.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 625

Returns:

instance of PillarboxMonitoring

Type:: PillarboxMonitoring

(static) srgAnalytics(player)

SRG SSR analytics singleton.

Parameters:

Name	Type	Description
`player`	Player

Source: middleware/srgssr.js, line 599

(static) updatePoster(player, srcMediaObj, imageService)

Update player's poster.

Parameters:

Name	Type	Description
`player`	Player
`srcMediaObj`	ComposedSrcMediaData
`imageService`	Image

Source: middleware/srgssr.js, line 652

(static) updateTitleBar(player, srcMediaObj)

Update player titleBar with title and description.

Parameters:

Name	Type	Description
`player`	Player
`srcMediaObj`	ComposedSrcMediaData

Source: middleware/srgssr.js, line 666