Source

Methods

(static) areSubtitlesCustomisable()

Returns if a device supports the customisation of subtitles

Source
Returns:

boolean

(static) canPause()

Source
Returns:

Returns whether the current media asset is pausable.

(static) canSeek()

Source
Returns:

Returns whether the current media asset is seekable.

(static) clearResize()

Clear any resize properties added with resize

Source

(static) clearSubtitleExample()

Clear the example subtitle string

Source

(static) customiseSubtitles(styleOpts)

Customise the rendered subitles style

Parameters:
NameTypeDescription
styleOptsSubtitlesCustomisationOptions
Source

(static) getCurrentTime() → {Number}

Returns the media asset's current time in seconds.

Source
Returns:
Type: 
Number

(static) getDuration()

Source
Returns:

the duration of the media asset.

(static) getFrameworkVersion()

Source
Returns:

The runtime version of the library.

(static) getLogLevels() → {Object}

Source
Returns:
  • Key value pairs of available log levels
Type: 
Object

(static) getMediaKind()

Returns the current media kind. 'audio' or 'video'

Source

(static) getPlaybackBitrate()

Returns current playback bitrate for media kind.

Source

(static) getPlaybackRate() → {Number}

Get the current playback rate

Source
Returns:

the current media playback rate

Type: 
Number

(static) getPlayerElement()

Source
Returns:

The media element currently being used.

(static) getSeekableRange() → {Object|null}

Returns an object including the current start and end times.

Source
Returns:

{start: Number, end: Number}

Type: 
Object | null

(static) isAudioDescribedAvailable() → {boolean}

Source
Returns:

true if an Audio Described track is available

Type: 
boolean

(static) isAudioDescribedEnabled() → {boolean}

Source
Returns:

true if the Audio Described track is currently being used

Type: 
boolean

(static) isEnded()

Source
Returns:

if the media asset has ended.

(static) isPaused()

Source
Returns:

if the player is paused.

(static) isPlayingAtLiveEdge() → {boolean}

Source
Returns:

Returns true if media is initialised and playing a live stream within a tolerance of the end of the seekable range (10 seconds).

Type: 
boolean

(static) isSubtitlesAvailable()

Source
Returns:

Returns whether or not subtitles are currently enabled.

(static) isSubtitlesEnabled()

Source
Returns:

if subtitles are currently enabled.

(static) mock(opts)

Return a mock for in place testing.

Parameters:
NameTypeDescription
opts*
Source

(static) mockJasmine(opts)

Return a mock for unit tests.

Parameters:
NameTypeDescription
opts*
Source

(static) pause(opts)

Pause the media asset.

Parameters:
NameTypeDescription
opts*
Properties
NameTypeDescription
userPauseboolean
Source

(static) play()

Play the media assest from the current point in time.

Source

(static) registerForAudioDescribedChanges(callback)

Pass a function to be called whenever Audio Described is enabled or disabled.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) registerForStateChanges(callback)

Pass a function to call whenever the player transitions state.

Parameters:
NameTypeDescription
callbackfunction
Source
See
  • module:models/mediastate

(static) registerForSubtitleChanges(callback)

Pass a function to be called whenever subtitles are enabled or disabled.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) registerForTimeUpdates(callback)

Pass a function to call whenever the player issues a time update.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) registerPlugin(plugin)

Register a plugin for extended events.

Parameters:
NameTypeDescription
plugin*
Source

(static) renderSubtitleExample(xmlString, styleOpts, safePosition)

Render an example subtitles string with a given style and location

Parameters:
NameTypeDescription
xmlStringstring

EBU-TT-D compliant XML String

styleOptsSubtitlesCustomisationOptions
safePositionDOMRect
Source

(static) resize(top, left, width, height, zIndex)

Resize the video container div in the most compatible way

Parameters:
NameTypeDescription
topNumber

px

leftNumber

px

widthNumber

px

heightNumber

px

zIndexNumber
Source

(static) setAudioDescribed() → {Promise.<void>}

Source
Returns:
Type: 
Promise.<void>

(static) setBitrateConstraint()

Set constrained bitrate given a min/max range and mediakind.

Source

(static) setCurrentTime(seconds, timeline)

Sets the current time of the media asset.

Parameters:
NameTypeDescription
secondsnumber
timelineTimeline
Source

(static) setLogLevel(logLevel)

Parameters:
NameTypeDescription
logLevel

log level to display @see getLogLevels

Source

(static) setPlaybackRate(rate)

Set the media element playback rate

Parameters:
NameTypeDescription
rateNumber
Source

(static) setSubtitlesEnabled(value)

Set whether or not subtitles should be enabled.

Parameters:
NameTypeDescription
valueboolean
Source

(static) setTransportControlsPosition(position)

An enum may be used to set the on-screen position of any transport controls (work in progress to remove this - UI concern).

Parameters:
NameTypeDescription
position*
Source

(static) toggleDebug()

Toggle the visibility of the debug tool overlay.

Source

(static) transitions()

Returns an object with a number of functions related to the ability to transition state given the current state and the playback strategy in use.

Source

(static) unmock()

Unmock the player.

Source

(static) unregisterForAudioDescribedChanges(callback)

Unregisters a previously registered callback for changes to Audio Described.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) unregisterForStateChanges(callback)

Unregisters a previously registered callback.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) unregisterForSubtitleChanges(callback)

Unregisters a previously registered callback for changes to subtitles.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) unregisterForTimeUpdates(callback)

Unregisters a previously registered callback.

Parameters:
NameTypeDescription
callbackfunction
Source

(static) unregisterPlugin(plugin)

Unregister a previously registered plugin.

Parameters:
NameTypeDescription
plugin*
Source

(inner) BigscreenPlayer()

Source

(inner) init(playbackElement, bigscreenPlayerData, callbacks)

Call first to initialise bigscreen player for playback.

Parameters:
NameTypeDescription
playbackElementHTMLDivElement

The Div element where content elements should be rendered

bigscreenPlayerDataInitData
callbacksInitCallbacks
Source

(inner) tearDown()

Should be called at the end of all playback sessions. Resets state and clears any UI.

Source

Type Definitions

PlaybackTimeInit

Type:
  • Object
Properties
NameTypeAttributesDescription
secondsnumber
timelineTimeline<optional>
Source