JSDoc: Class: shaka.util.StreamUtils

Constructor

new StreamUtils()

A set of utility functions for dealing with Streams and Manifests.

Source:

lib/util/stream_utils.js, line 27

Members

DecodingAttributes :string

Type:

string

Properties:

Name	Value	Type	Description
`SMOOTH`	smooth	string
`POWER`	powerEfficient	string

Source:

lib/util/stream_utils.js, line 1883

decodingConfigCache_ :Object.<(!string), (!MediaCapabilitiesDecodingInfo)>

A cache of results from mediaCapabilities.decodingInfo, indexed by the (stringified) decodingConfig.

Type:

Object.<(!string), (!MediaCapabilitiesDecodingInfo)>

Source:

lib/util/stream_utils.js, line 1874

minAvifImage_ :string

Type:

string

Source:

lib/util/stream_utils.js, line 1909

minImage_ :Map.<string, string>

Type:

Map.<string, string>

Source:

lib/util/stream_utils.js, line 1921

minWebPImage_ :string

Type:

string

Source:

lib/util/stream_utils.js, line 1901

nextTrackId_ :number

Type:

number

Source:

lib/util/stream_utils.js, line 1878

supportedImageMimeTypes_ :Map.<string, boolean>

Type:

Map.<string, boolean>

Source:

lib/util/stream_utils.js, line 1891

Methods

alphabeticalKeyOrderStringify_(objnon-null) → {string}

Constructs a string out of an object, similar to the JSON.stringify method. Unlike that method, this guarantees that the order of the keys is alphabetical, so it can be used as a way to reliably compare two objects.

Parameters:

Name	Type	Description
`obj`	Object

Source:

lib/util/stream_utils.js, line 518

Returns:

Type: string

applyRestrictions(variantsnon-null, restrictions, maxHwRes) → {boolean}

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`restrictions`	shaka.extern.Restrictions
`maxHwRes`	shaka.extern.Resolution

Source:

lib/util/stream_utils.js, line 328

Returns:

Whether the tracks changed.

Type: boolean

areStreamsCompatible_(s0, s1) → {boolean}

Parameters:

Name	Type	Description
`s0`	shaka.extern.Stream
`s1`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1203

Returns:

Type: boolean

checkEachDecodingConfigCombination_(decodingConfignon-null) → {Promise.<?Array.<!MediaCapabilitiesDecodingInfo>>}

Parameters:

Name	Type	Description
`decodingConfig`	MediaDecodingConfiguration

Source:

lib/util/stream_utils.js, line 618

Returns:

Type: Promise.<?Array.<!MediaCapabilitiesDecodingInfo>>

checkVariantSupported_(variantnon-null, keySystemnullable) → {boolean}

Parameters:

Name	Type	Attributes	Description
`variant`	shaka.extern.Variant
`keySystem`	string	<nullable>

Source:

lib/util/stream_utils.js, line 407

Returns:

Type: boolean

chooseCodecsAndFilterManifest(manifestnon-null, preferredVideoCodecsnon-null, preferredAudioCodecsnon-null, preferredDecodingAttributesnon-null)

In case of multiple usable codecs, choose one based on lowest average bandwidth and filter out the rest. Also filters out variants that have too many audio channels.

Parameters:

Name	Type	Description
`manifest`	shaka.extern.Manifest
`preferredVideoCodecs`	Array.<string>
`preferredAudioCodecs`	Array.<string>
`preferredDecodingAttributes`	Array.<string>

Source:

lib/util/stream_utils.js, line 37

choosePreferredCodecs(variantsnon-null, preferredVideoCodecsnon-null, preferredAudioCodecsnon-null) → {Array.<shaka.extern.Variant>}

Choose the codecs by configured preferred audio and video codecs.

Parameters:

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

Source:

lib/util/stream_utils.js, line 204

Returns:

Type: Array.<shaka.extern.Variant>

clearDecodingConfigCache()

Clears underlying decoding config cache.

Source:

lib/util/stream_utils.js, line 1861

filterByRestrictions(manifestnon-null, restrictions, maxHwResolution)

Filter the variants in |manifest| to only include the variants that meet the given restrictions.

Parameters:

Name	Type	Description
`manifest`	shaka.extern.Manifest
`restrictions`	shaka.extern.Restrictions
`maxHwResolution`	shaka.extern.Resolution

Source:

lib/util/stream_utils.js, line 237

filterImageStreams_(manifest)

Alters the given Manifest to filter out any unsupported image streams.

Parameters:

Name	Type	Description
`manifest`	shaka.extern.Manifest

Source:

lib/util/stream_utils.js, line 1143

filterManifest(drmEngine, manifest, preferredKeySystemsopt, non-null)

Alters the given Manifest to filter out any unplayable streams.

Parameters:

Name	Type	Attributes
`drmEngine`	shaka.media.DrmEngine
`manifest`	shaka.extern.Manifest
`preferredKeySystems`	Array.<string>	<optional>

Source:

lib/util/stream_utils.js, line 352

filterManifestByCurrentVariant(currentVariantnullable, manifest)

Alters the given Manifest to filter out any streams uncompatible with the current variant.

Parameters:

Name	Type	Attributes	Description
`currentVariant`	shaka.extern.Variant	<nullable>
`manifest`	shaka.extern.Manifest

Source:

lib/util/stream_utils.js, line 1083

filterManifestByMediaCapabilities(drmEngine, manifest, usePersistentLicenses, preferredKeySystemsnon-null)

Alters the given Manifest to filter out any streams unsupported by the platform via MediaCapabilities.decodingInfo() API.

Parameters:

Name	Type	Description
`drmEngine`	shaka.media.DrmEngine
`manifest`	shaka.extern.Manifest
`usePersistentLicenses`	boolean
`preferredKeySystems`	Array.<string>

Source:

lib/util/stream_utils.js, line 370

filterStreamsByLanguageAndRole(streams, preferredLanguage, preferredRole, preferredForced) → {!Array.<!shaka.extern.Stream>|!Array.<!shaka.extern.Track>}

Chooses streams according to the given config. Works both for Stream and Track types due to their similarities.

Parameters:

Name	Type	Description
`streams`	!Array.<!shaka.extern.Stream> \| !Array.<!shaka.extern.Track>
`preferredLanguage`	string
`preferredRole`	string
`preferredForced`	boolean

Source:

lib/util/stream_utils.js, line 1650

Returns:

Type: !Array.<!shaka.extern.Stream> | !Array.<!shaka.extern.Track>

filterStreamsByRole_(streams, preferredRole) → {!Array.<!shaka.extern.Stream>|!Array.<!shaka.extern.Track>}

Filter Streams by role. Works both for Stream and Track types due to their similarities.

Parameters:

Name	Type	Description
`streams`	!Array.<!shaka.extern.Stream> \| !Array.<!shaka.extern.Track>
`preferredRole`	string

Source:

lib/util/stream_utils.js, line 1739

Returns:

Type: !Array.<!shaka.extern.Stream> | !Array.<!shaka.extern.Track>

filterTextStreams_(manifest)

Alters the given Manifest to filter out any unsupported text streams.

Parameters:

Name	Type	Description
`manifest`	shaka.extern.Manifest

Source:

lib/util/stream_utils.js, line 1120

getCorrectAudioCodecs(codecs, mimeType) → {string}

Generates the correct audio codec for MediaDecodingConfiguration and for MediaSource.isTypeSupported.

Parameters:

Name	Type	Description
`codecs`	string
`mimeType`	string

Source:

lib/util/stream_utils.js, line 1004

Returns:

Type: string

getCorrectVideoCodecs(codec) → {string}

Generates the correct video codec for MediaDecodingConfiguration and for MediaSource.isTypeSupported.

Parameters:

Name	Type	Description
`codec`	string

Source:

lib/util/stream_utils.js, line 1041

Returns:

Type: string

getDecodingConfigs_(variantnon-null, usePersistentLicenses, srcEquals) → {Array.<!Array.<!MediaDecodingConfiguration>>}

Generate a batch of MediaDecodingConfiguration objects to get the decodingInfo results for each variant. Each batch shares the same DRM information, and represents the various fullMimeType combinations of the streams.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant
`usePersistentLicenses`	boolean
`srcEquals`	boolean

Source:

lib/util/stream_utils.js, line 749

Returns:

Type: Array.<!Array.<!MediaDecodingConfiguration>>

getDecodingInfosForVariant_(variantnon-null, decodingConfigsnon-null)

Queries mediaCapabilities for the decoding info for that decoding config, and assigns it to the given variant. If that query has been done before, instead return a cached result.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant
`decodingConfigs`	Array.<!MediaDecodingConfiguration>

Source:

lib/util/stream_utils.js, line 551

getDecodingInfosForVariants(variantsnon-null, usePersistentLicenses, srcEquals, preferredKeySystemsnon-null)

Get the decodingInfo results of the variants via MediaCapabilities. This should be called after the DrmEngine is created and configured, and before DrmEngine sets the mediaKeys.

Parameters:

Name	Type	Description
`variants`	Array.<shaka.extern.Variant>
`usePersistentLicenses`	boolean
`srcEquals`	boolean
`preferredKeySystems`	Array.<string>

Source:

lib/util/stream_utils.js, line 671

getPlayableVariants(variantsnon-null) → {Array.<!shaka.extern.Variant>}

Filters out unplayable variants.

Parameters:

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

Source:

lib/util/stream_utils.js, line 1633

Returns:

Type: Array.<!shaka.extern.Variant>

getStreamSummaryString_(stream) → {string}

Returns a string of an audio or video stream for log printing.

Parameters:

Name	Type	Description
`stream`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1833

Returns:

Type: string

getVariantStreams(variant) → {Array.<shaka.extern.Stream>}

Get all non-null streams in the variant as an array.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant

Source:

lib/util/stream_utils.js, line 1776

Returns:

Type: Array.<shaka.extern.Stream>

getVariantSummaryString_(variant) → {string}

Returns a string of a variant, with the attribute values of its audio and/or video streams for log printing.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant

Source:

lib/util/stream_utils.js, line 1814

Returns:

Type: string

html5AudioTrackToTrack(audioTrack) → {shaka.extern.Track}

Parameters:

Name	Type	Description
`audioTrack`	AudioTrack

Source:

lib/util/stream_utils.js, line 1536

Returns:

Type: shaka.extern.Track

html5TextTrackToTrack(textTrack) → {shaka.extern.Track}

Parameters:

Name	Type	Description
`textTrack`	TextTrack

Source:

lib/util/stream_utils.js, line 1506

Returns:

Type: shaka.extern.Track

html5TrackId(html5Track) → {number}

Generate and return an ID for this track, since the ID field is optional.

Parameters:

Name	Type	Description
`html5Track`	TextTrack \| AudioTrack

Source:

lib/util/stream_utils.js, line 1494

Returns:

The generated ID.

Type: number

html5TrackToGenericShakaTrack_(html5Track) → {shaka.extern.Track}

Creates a Track object with non-type specific fields filled out. The caller is responsible for completing the Track object with any type-specific information (audio or text).

Parameters:

Name	Type	Description
`html5Track`	TextTrack \| AudioTrack

Source:

lib/util/stream_utils.js, line 1567

Returns:

Type: shaka.extern.Track

imageStreamToTrack(stream) → {shaka.extern.Track}

Parameters:

Name	Type	Description
`stream`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1414

Returns:

Type: shaka.extern.Track

isAudio(stream) → {boolean}

Checks if the given stream is an audio stream.

Parameters:

Name	Type	Description
`stream`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1752

Returns:

Type: boolean

isFastSwitching(variant) → {boolean}

Indicates if some of the variant's streams are fastSwitching.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant

Source:

lib/util/stream_utils.js, line 1796

Returns:

Type: boolean

isImageSupported_(minImage) → {Promise.<boolean>}

Parameters:

Name	Type	Description
`minImage`	string

Source:

lib/util/stream_utils.js, line 1179

Returns:

Type: Promise.<boolean>

isPlayable(variantnon-null) → {boolean}

Determines if the given variant is playable.

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant

Source:

lib/util/stream_utils.js, line 1621

Returns:

Type: boolean

isVideo(stream) → {boolean}

Checks if the given stream is a video stream.

Parameters:

Name	Type	Description
`stream`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1764

Returns:

Type: boolean

meetsRestrictions(variant, restrictions, maxHwRes) → {boolean}

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant
`restrictions`	shaka.extern.Restrictions	Configured restrictions from the user.
`maxHwRes`	shaka.extern.Resolution	The maximum resolution the hardware can handle. This is applied separately from user restrictions because the setting should not be easily replaced by the user's configuration.

Source:

lib/util/stream_utils.js, line 255

Returns:

Type: boolean

textStreamToTrack(stream) → {shaka.extern.Track}

Parameters:

Name	Type	Description
`stream`	shaka.extern.Stream

Source:

lib/util/stream_utils.js, line 1361

Returns:

Type: shaka.extern.Track

variantToTrack(variant) → {shaka.extern.Track}

Parameters:

Name	Type	Description
`variant`	shaka.extern.Variant

Source:

lib/util/stream_utils.js, line 1225

Returns:

Type: shaka.extern.Track