JSDoc: Class: shaka.media.PreferenceBasedCriteria

Class: shaka.media.PreferenceBasedCriteria

Constructor

new PreferenceBasedCriteria()

Implements:

shaka.media.AdaptationSetCriteria

Source:

lib/media/preference_based_criteria.js, line 21

Members

config_ :shaka.media.AdaptationSetCriteria.Configuration

Type:

shaka.media.AdaptationSetCriteria.Configuration

Source:

lib/media/preference_based_criteria.js, line 25

Methods

filterByLanguage_(variantsnon-null, preferredLanguage) → {Array.<shaka.extern.Variant>}

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`preferredLanguage`	string

Source:

lib/media/preference_based_criteria.js, line 149

Returns:

Type: Array.<shaka.extern.Variant>

filterVariantsByAudioChannelCount_(variantsnon-null, channelCount) → {Array.<shaka.extern.Variant>}

Filter Variants by channelCount.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`channelCount`	number

Source:

lib/media/preference_based_criteria.js, line 241

Returns:

Type: Array.<shaka.extern.Variant>

filterVariantsByAudioCodec_(variantsnon-null, audioCodec)

Filters variants according to the given audio codec.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`audioCodec`	string

Source:

lib/media/preference_based_criteria.js, line 325

filterVariantsByAudioLabel_(variantsnon-null, preferredLabel) → {Array.<shaka.extern.Variant>}

Filter Variants by audio label.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`preferredLabel`	string

Source:

lib/media/preference_based_criteria.js, line 201

Returns:

Type: Array.<shaka.extern.Variant>

filterVariantsByHDRLevel_(variantsnon-null, hdrLevel)

Filters variants according to the given hdr level config.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`hdrLevel`	string

Source:

lib/media/preference_based_criteria.js, line 258

filterVariantsByRole_(variantsnon-null, preferredRole) → {Array.<shaka.extern.Variant>}

Filter Variants by role.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`preferredRole`	string

Source:

lib/media/preference_based_criteria.js, line 179

Returns:

Type: Array.<shaka.extern.Variant>

filterVariantsBySpatialAudio_(variantsnon-null, spatialAudio)

Filters variants according to the given spatial audio config.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`spatialAudio`	boolean

Source:

lib/media/preference_based_criteria.js, line 308

filterVariantsByVideoLabel_(variantsnon-null, preferredLabel) → {Array.<shaka.extern.Variant>}

Filter Variants by video label.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`preferredLabel`	string

Source:

lib/media/preference_based_criteria.js, line 221

Returns:

Type: Array.<shaka.extern.Variant>

filterVariantsByVideoLayout_(variantsnon-null, videoLayout)

Filters variants according to the given video layout config.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`videoLayout`	string

Source:

lib/media/preference_based_criteria.js, line 290

configure(config)

Sets the AdaptationSetCriteria configuration.

Parameters:

Name	Type	Description
`config`	shaka.media.AdaptationSetCriteria.Configuration

Implements:

shaka.media.AdaptationSetCriteria#configure

Source:

lib/media/preference_based_criteria.js, line 31

create(variantsnon-null) → {shaka.media.AdaptationSet}

Take a set of variants, and return a subset of variants that can be adapted between.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>

Implements:

shaka.media.AdaptationSetCriteria#create

Source:

lib/media/preference_based_criteria.js, line 38

Returns:

Type: shaka.media.AdaptationSet