Module: bigscreenplayer/bigscreenplayer

Source: bigscreenplayer.js, line 1

Methods

(static) areSubtitlesCustomisable()

Returns if a device supports the customisation of subtitles

Source: bigscreenplayer.js, line 519

Returns:

boolean

(static) canPause()

Source: bigscreenplayer.js, line 583

Returns:

Returns whether the current media asset is pausable.

(static) canSeek()

Source: bigscreenplayer.js, line 572

Returns:

Returns whether the current media asset is seekable.

(static) clearResize()

Clear any resize properties added with resize

Source: bigscreenplayer.js, line 486

(static) clearSubtitleExample()

Clear the example subtitle string

Source: bigscreenplayer.js, line 549

(static) convertEpochMsToVideoTimeSeconds(epochTime)

Parameters:

Name	Type	Description
`epochTime`	Number	Unix Epoch based time in milliseconds.

Source: bigscreenplayer.js, line 645

Returns:

the time in seconds within the current sliding window.

(static) convertVideoTimeSecondsToEpochMs(time)

Parameters:

Name	Type	Description
`time`	Number	Seconds

Source: bigscreenplayer.js, line 659

Returns:

the time in milliseconds within the current sliding window.

(static) customiseSubtitles(styleOpts)

Customise the rendered subitles style

Parameters:

Name	Type	Description
`styleOpts`	SubtitlesCustomisationOptions

Source: bigscreenplayer.js, line 527

(static) getCurrentTime() → {Number}

Returns the media asset's current time in seconds.

Source: bigscreenplayer.js, line 374

Returns:

Type:: Number

(static) getDuration()

Source: bigscreenplayer.js, line 430

Returns:

the duration of the media asset.

(static) getFrameworkVersion()

Source: bigscreenplayer.js, line 652

Returns:

The runtime version of the library.

(static) getLiveWindowData() → {Object}

Source: bigscreenplayer.js, line 413

Returns:

An object of the shape {windowStartTime: Number, windowEndTime: Number, initialPlaybackTime: Number, serverDate: Date}

Type:: Object

(static) getLogLevels() → {Object}

Source: bigscreenplayer.js, line 671

Returns:

Key value pairs of available log levels

Type:: Object

(static) getMediaKind()

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

Source: bigscreenplayer.js, line 381

(static) getPlaybackRate() → {Number}

Get the current playback rate

Source: bigscreenplayer.js, line 367

Returns:

the current media playback rate

Type:: Number

(static) getPlayerElement()

Source: bigscreenplayer.js, line 638

Returns:

The media element currently being used.

(static) getSeekableRange() → {Object}

Returns an object including the current start and end times.

Source: bigscreenplayer.js, line 395

Returns:

{start: Number, end: Number}

Type:: Object

(static) getWindowType()

Returns the current window type.

Source: bigscreenplayer.js, line 388
See: module:bigscreenplayer/models/windowtypes

(static) isEnded()

Source: bigscreenplayer.js, line 442

Returns:

if the media asset has ended.

(static) isPaused()

Source: bigscreenplayer.js, line 436

Returns:

if the player is paused.

(static) isPlayingAtLiveEdge() → {boolean}

Source: bigscreenplayer.js, line 401

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: bigscreenplayer.js, line 512

Returns:

Returns whether or not subtitles are currently enabled.

(static) isSubtitlesEnabled()

Source: bigscreenplayer.js, line 506

Returns:

if subtitles are currently enabled.

(static) mock(opts)

Return a mock for in place testing.

Parameters:

Name	Type	Description
`opts`	*

Source: bigscreenplayer.js, line 592

(static) mockJasmine(opts)

Return a mock for unit tests.

Parameters:

Name	Type	Description
`opts`	*

Source: bigscreenplayer.js, line 609

(static) pause(opts)

Pause the media asset.

Parameters:

Name Type Description

opts

Properties

Name	Type	Description
`userPause`	boolean
`disableAutoResume`	boolean

Source: bigscreenplayer.js, line 460

(static) play()

Play the media assest from the current point in time.

Source: bigscreenplayer.js, line 448

(static) registerForStateChanges(callback)

Pass a function to call whenever the player transitions state.

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 272
See: module:models/mediastate

(static) registerForSubtitleChanges(callback)

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

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 316

(static) registerForTimeUpdates(callback)

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

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 294

(static) registerPlugin(plugin)

Parameters:

Name	Type	Description
`plugin`	*

Source: bigscreenplayer.js, line 618

(static) renderSubtitleExample(xmlString, styleOpts, safePosition)

Render an example subtitles string with a given style and location

Parameters:

Name	Type	Description
`xmlString`	string	EBU-TT-D compliant XML String
`styleOpts`	SubtitlesCustomisationOptions
`safePosition`	DOMRect

Source: bigscreenplayer.js, line 540

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

Resize the video container div in the most compatible way

Parameters:

Name	Type	Description
`top`	Number	px
`left`	Number	px
`width`	Number	px
`height`	Number	px
`zIndex`	Number

Source: bigscreenplayer.js, line 477

(static) setCurrentTime(time)

Sets the current time of the media asset.

Parameters:

Name	Type	Description
`time`	Number	In seconds

Source: bigscreenplayer.js, line 338

(static) setLogLevel(logLevel)

Parameters:

Name	Type	Description
`logLevel`		log level to display @see getLogLevels

Source: bigscreenplayer.js, line 677

(static) setPlaybackRate(rate)

Set the media element playback rate

Parameters:

Name	Type	Description
`rate`	Number

Source: bigscreenplayer.js, line 356

(static) setSubtitlesEnabled(value)

Set whether or not subtitles should be enabled.

Parameters:

Name	Type	Description
`value`	boolean

Source: bigscreenplayer.js, line 500

(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:

Name	Type	Description
`position`	*

Source: bigscreenplayer.js, line 562

(static) toggleDebug()

Toggle the visibility of the debug tool overlay.

Source: bigscreenplayer.js, line 665

(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: bigscreenplayer.js, line 632

(static) unmock()

Unmock the player.

Source: bigscreenplayer.js, line 600

(static) unregisterForStateChanges(callback)

Unregisters a previously registered callback.

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 282

(static) unregisterForSubtitleChanges(callback)

Unregisters a previously registered callback for changes to subtitles.

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 326

(static) unregisterForTimeUpdates(callback)

Unregisters a previously registered callback.

Parameters:

Name	Type	Description
`callback`	function

Source: bigscreenplayer.js, line 304

(static) unregisterPlugin(plugin)

Unregister a previously registered plugin.

Parameters:

Name	Type	Description
`plugin`	*

Source: bigscreenplayer.js, line 625

(inner) getLiveSupport(device)

Parameters:

Name	Type	Description
`device`	TALDevice

Source: bigscreenplayer.js, line 687

Returns:

the live support of the device.

(inner) init(playbackElement, bigscreenPlayerData, newWindowType, enableSubtitles, callbacks)

Call first to initialise bigscreen player for playback.

Parameters:

Name	Type	Description
`playbackElement`	HTMLDivElement	The Div element where content elements should be rendered
`bigscreenPlayerData`	InitData
`newWindowType`	WindowTypes
`enableSubtitles`	boolean	Enable subtitles on initialisation
`callbacks`	InitCallbacks

Source: bigscreenplayer.js, line 184

(inner) tearDown()

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

Source: bigscreenplayer.js, line 233