JSDoc: Class: shaka.util.Platform

Class: shaka.util.Platform

Constructor

new Platform()

Source:

lib/util/platform.js, line 17

Members

cachedMediaElement_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/util/platform.js, line 453

cacheExpirationTimer_ :shaka.util.Timer

Type:

shaka.util.Timer

Source:

lib/util/platform.js, line 450

Methods

anyMediaElement() → {HTMLMediaElement}

For canPlayType queries, we just need any instance. First, use a cached element from a previous query. Second, search the page for one. Third, create a temporary one. Cached elements expire in one second so that they can be GC'd or removed.

Source:

lib/util/platform.js, line 396

Returns:

Type: HTMLMediaElement

chromeVersion() → {number}

Returns a major version number for Chrome, or Chromium-based browsers. For example: - Chrome 106.0.5249.61 returns 106. - Edge 106.0.1370.34 returns 106 (since this is based on Chromium). - Safari returns null (since this is independent of Chromium).

Source:

lib/util/platform.js, line 176

Returns:

A major version number or null if not Chromium-based.

Type: number

isAmazonFireTV() → {boolean}

Check if the current platform is Amazon Fire TV. https://developer.amazon.com/docs/fire-tv/identify-amazon-fire-tv-devices.html

Source:

lib/util/platform.js, line 270

Returns:

Type: boolean

isApple() → {boolean}

Check if the current platform is from Apple. Returns true on all iOS browsers and on desktop Safari. Returns false for non-Safari browsers on macOS, which are independent of Apple.

Source:

lib/util/platform.js, line 212

Returns:

Type: boolean

isChrome() → {boolean}

Check if the current platform is Google Chrome.

Source:

lib/util/platform.js, line 195

Returns:

Type: boolean

isChromecast() → {boolean}

Check if the current platform is a Google Chromecast.

Source:

lib/util/platform.js, line 162

Returns:

Type: boolean

isEdge() → {boolean}

Check if the current platform is MS Edge.

Source:

lib/util/platform.js, line 57

Returns:

Type: boolean

isEOS() → {boolean}

Check if the current platform is an EOS set-top box.

Source:

lib/util/platform.js, line 326

Returns:

Type: boolean

isHisense()

Check if the current platform is Hisense.

Source:

lib/util/platform.js, line 245

isIE() → {boolean}

Check if the current platform is MS IE.

Source:

lib/util/platform.js, line 87

Returns:

Type: boolean

isLegacyEdge() → {boolean}

Check if the current platform is Legacy Edge.

Source:

lib/util/platform.js, line 72

Returns:

Type: boolean

isMac() → {boolean}

Return true if the platform is a Mac, regardless of the browser.

Source:

lib/util/platform.js, line 362

Returns:

Type: boolean

isMediaKeysPolyfilled() → {boolean}

Returns true if MediaKeys is polyfilled

Source:

lib/util/platform.js, line 440

Returns:

Type: boolean

isMobile() → {boolean}

Guesses if the platform is a mobile one (iOS or Android).

Source:

lib/util/platform.js, line 335

Returns:

Type: boolean

isOrange()

Check if the current platform is Orange.

Source:

lib/util/platform.js, line 260

isPS4()

Check if the current platform is Playstation 4.

Source:

lib/util/platform.js, line 238

isPS5() → {boolean}

Check if the current platform is Playstation 5. Returns true on Playstation 5 browsers. Returns false for Playstation 5 browsers

Source:

lib/util/platform.js, line 231

Returns:

Type: boolean

isSafari() → {boolean}

Check if the current platform is Apple Safari or Safari-based iOS browsers.

Source:

lib/util/platform.js, line 317

Returns:

Type: boolean

isTizen() → {boolean}

Check if the current platform is a Tizen TV.

Source:

lib/util/platform.js, line 105

Returns:

Type: boolean

isTizen2() → {boolean}

Check if the current platform is a Tizen 2 TV.

Source:

lib/util/platform.js, line 132

Returns:

Type: boolean

isTizen3() → {boolean}

Check if the current platform is a Tizen 3 TV.

Source:

lib/util/platform.js, line 123

Returns:

Type: boolean

isTizen4() → {boolean}

Check if the current platform is a Tizen 4 TV.

Source:

lib/util/platform.js, line 114

Returns:

Type: boolean

isVirginMedia()

Check if the current platform is Virgin Media device.

Source:

lib/util/platform.js, line 253

isWebOS() → {boolean}

Check if the current platform is a WebOS.

Source:

lib/util/platform.js, line 141

Returns:

Type: boolean

isWebOS3() → {boolean}

Check if the current platform is a WebOS 3.

Source:

lib/util/platform.js, line 150

Returns:

Type: boolean

isXboxOne() → {boolean}

Check if the current platform is an Xbox One.

Source:

lib/util/platform.js, line 96

Returns:

Type: boolean

requiresEncryptionInfoInAllInitSegments() → {boolean}

Returns true if the platform requires encryption information in all init segments. For such platforms, MediaSourceEngine will attempt to work around a lack of such info by inserting fake encryption information into initialization segments.

Source:

lib/util/platform.js, line 430

See:

https://github.com/shaka-project/shaka-player/issues/2759

Returns:

Type: boolean

safariVersion() → {number}

Returns a major version number for Safari, or Safari-based iOS browsers. For example: - Safari 13.0.4 on macOS returns 13. - Safari on iOS 13.3.1 returns 13. - Chrome on iOS 13.3.1 returns 13 (since this is based on Safari/WebKit). - Chrome on macOS returns null (since this is independent of Apple). Returns null on Firefox on iOS, where this version information is not available.

Source:

lib/util/platform.js, line 288

Returns:

A major version number or null if not iOS.

Type: number

supportsMediaSource() → {boolean}

Check if the current platform supports media source. We assume that if the current platform supports media source, then we can use media source as per its design.

Source: