On this page

MediaComposition

new MediaComposition()

Represents the composition of media content.

Properties

Name	Type	Description
`chapterUrn`	string	URN (Uniform Resource Name) of the associated chapter.
`segmentUrn`	string	URN of the associated segment.
`episode`	Episode	Associated episode.
`show`	Show	Associated show.
`channel`	Channel	Associated channel.
`chapterList`	Array.<Chapter>	List of associated chapters.
`topicList`	Array.<Topic>	List of associated topics.
`analyticsData`	Object.<String, String>	Analytics data associated with the media composition.
`analyticsMetadata`	Object.<String, String>	Metadata associated with analytics for the media composition.

Source: dataProvider/model/MediaComposition.js, line 1

Methods

findChapterByUrn(urn) → {Chapter}

Find a chapter by its URN.

Parameters:

Name	Type	Description
`urn`	String

Source: dataProvider/model/MediaComposition.js, line 23

Returns:

chapter

Type:: Chapter

findMainSegment() → {Segment|undefined}

Return a segment from main chapter following segmentUrn in mediaComposition.

Source: dataProvider/model/MediaComposition.js, line 40

Returns:

main segment

Type:: Segment | undefined

findResourceListByUrn(urn) → {Array.<Resource>|undefined}

Find resource list by URN.

Parameters:

Name	Type	Description
`urn`	String

Source: dataProvider/model/MediaComposition.js, line 59

Returns:

of resources

Type:: Array.<Resource> | undefined

getChapters() → {Array.<Chapter>}

A list of chapters.

Source: dataProvider/model/MediaComposition.js, line 74

Returns:

of chapters

Type:: Array.<Chapter>

getFilteredExternalSubtitles() → {Array.<Subtitle>}

Filter external text tracks that are already available internally.

Rules:

TTML format is filtered
If both are empty that means only internal text tracks will be displayed to the user as they are automatically loaded by the player.
If subtitleInformationList is missing from the MediaComposition and subtitleList is available but the media contains internal text tracks that are also available internally. It will result on a duplication client side.
If subtitleList and subtitleInformationList a merge between both will be operated, removing the external text tracks already available internally.

Source: dataProvider/model/MediaComposition.js, line 101

Returns:

external text tracks

Type:: Array.<Subtitle>

getMainBlockReason() → {string|undefined}

Block reason for main chapter. This also uses current date for STARTDATE.

Source: dataProvider/model/MediaComposition.js, line 139
See: BlockReason

Returns:

undefined if main chapter is not blocked

Type:: string | undefined

getMainBlockedSegments() → {Array.<Segment>}

Get blocked segments from the main chapter.

Source: dataProvider/model/MediaComposition.js, line 160

Returns:

of blocked segments

Type:: Array.<Segment>

getMainChapter() → {Chapter}

Get the mediaComposition's main chapter.

Source: dataProvider/model/MediaComposition.js, line 169

Returns:

Type:: Chapter

getMainChapterImageUrl() → {String|undefined}

Get the main chapter's image URL decorated with default width and format.

Source: dataProvider/model/MediaComposition.js, line 186

Returns:

image URL

Type:: String | undefined

getMainResources() → {Array.<MainResource>}

Get main resources.

Source: dataProvider/model/MediaComposition.js, line 202

Returns:

array of sources.

Type:: Array.<MainResource>

getMainSegments() → {Array.<Segment>}

Get segments of the main chapter ordered by markIn.

Source: dataProvider/model/MediaComposition.js, line 245

Returns:

of segments

Type:: Array.<Segment>

getMainTimeIntervals() → {Array.<TimeInterval>}

Retrieves an array of time intervals associated with the main chapter.

Source: dataProvider/model/MediaComposition.js, line 260

Returns:

An array of time intervals.

Type:: Array.<TimeInterval>

getMainValidFromDate() → {Date}

Compute a date from which this content is valid. Always return a date object.

Source: dataProvider/model/MediaComposition.js, line 273

Returns:

date specified in media composition or EPOCH when no date present.

Type:: Date

getMergedAnalyticsData(analyticsData) → {Object.<string, string>}

Get merged analytics data.

Parameters:

Name	Type	Description
`analyticsData`	Object.<string, string>

Source: dataProvider/model/MediaComposition.js, line 293

Returns:

Merged analytics data.

Type:: Object.<string, string>

getMergedAnalyticsMetadata(analyticsMetadata) → {Object.<string, string>}

Get merged analytics metadata.

Parameters:

Name	Type	Description
`analyticsMetadata`	Object.<string, string>

Source: dataProvider/model/MediaComposition.js, line 307

Returns:

Merged analytics metadata.

Type:: Object.<string, string>

getResourceList() → {Array.<Resource>}

Get the chapter's resource list

Source: dataProvider/model/MediaComposition.js, line 319

Returns:

of resources

Type:: Array.<Resource>