PlayerConfiguration class

https://shaka-player-demo.appspot.com/docs/api/shaka.extern.html#.PlayerConfiguration

Annotations

• @JS('PlayerConfiguration')

Constructors

PlayerConfiguration()

Properties

abr ↔ AbrConfiguration

shaka.extern.AbrConfiguration ABR configuration and settings.

getter/setter pair

abrFactory ↔ JsFunction

JsFunction is shaka.extern.AbrManager.Factory A factory to construct an abr manager.

getter/setter pair

ads ↔ AdsConfiguration

shaka.extern.AdsConfiguration Ads configuration and settings.

getter/setter pair

autoShowText ↔ AutoShowText

shaka.config.AutoShowText Controls behavior of auto-showing text tracks on load().

getter/setter pair

cmcd ↔ CmcdConfiguration

shaka.extern.CmcdConfiguration CMCD configuration and settings. (Common Media Client Data)

getter/setter pair

drm ↔ DrmConfiguration

shaka.extern.DrmConfiguration DRM configuration and settings.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

lcevc ↔ LcevcConfiguration

shaka.extern.LcevcConfiguration MPEG-5 LCEVC configuration and settings. (Low Complexity Enhancement Video Codec)

getter/setter pair

manifest ↔ ManifestConfiguration

shaka.extern.ManifestConfiguration Manifest configuration and settings.

getter/setter pair

mediaSource ↔ MediaSourceConfiguration

shaka.extern.MediaSourceConfiguration Media source configuration and settings.

getter/setter pair

offline ↔ OfflineConfiguration

shaka.extern.OfflineConfiguration Offline configuration and settings.

getter/setter pair

playRangeEnd ↔ num?

number Optional playback and seek end time in seconds. Defaults to the end of the presentation if not provided.

getter/setter pair

playRangeStart ↔ num?

number Optional playback and seek start time in seconds. Defaults to 0 if not provided.

getter/setter pair

preferForcedSubs ↔ bool

boolean If true, a forced text track is preferred. Defaults to false. If the content has no forced captions and the value is true, no text track is chosen. Changing this during playback will not affect the current playback.

getter/setter pair

preferredAudioChannelCount ↔ num

number The preferred number of audio channels.

getter/setter pair

preferredAudioCodecs ↔ List<String>

Array.

getter/setter pair

preferredAudioLabel ↔ String

string The preferred label to use for audio tracks

getter/setter pair

preferredAudioLanguage ↔ String

string The preferred language to use for audio tracks. If not given it will use the 'main' track. Changing this during playback will not affect the current playback.

getter/setter pair

preferredDecodingAttributes ↔ List<String>

Array.

getter/setter pair

preferredTextLanguage ↔ String

string The preferred language to use for text tracks. If a matching text track is found, and the selected audio and text tracks have different languages, the text track will be shown. Changing this during playback will not affect the current playback.

getter/setter pair

preferredTextRole ↔ String

string The preferred role to use for text tracks.

getter/setter pair

preferredVariantRole ↔ String

string The preferred role to use for variants.

getter/setter pair

preferredVideoCodecs ↔ List<String>

Array.

getter/setter pair

preferredVideoHdrLevel ↔ String

string The preferred HDR level of the video. If possible, this will cause the player to filter to assets that either have that HDR level, or no HDR level at all. Can be 'SDR', 'PQ', 'HLG', 'AUTO' for auto-detect, or '' for no preference. Defaults to 'AUTO'. Note that one some platforms, such as Chrome, attempting to play PQ content may cause problems.

getter/setter pair

restrictions ↔ Restrictions

shaka.extern.Restrictions The application restrictions to apply to the tracks. These are "hard" restrictions. Any track that fails to meet these restrictions will not appear in the track list. If no tracks meet these restrictions, playback will fail.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

streaming ↔ StreamingConfiguration

shaka.extern.StreamingConfiguration Streaming configuration and settings.

getter/setter pair

textDisplayFactory ↔ dynamic

JsFunction is shaka.extern.TextDisplayer.Factory A factory to construct a text displayer. Note that, if this is changed during playback, it will cause the text tracks to be reloaded.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited