GoBrain 1.0.36

Class: IMediaPlayer

GoBrain.Pdk.Interfaces. IMediaPlayer

abstractnew GoBrain.Pdk.Interfaces.IMediaPlayer()

GoBrain.Pdk/src/interfaces/imedia-player.js, line 1

This interface declares the minimum functionality a media player used by the framework is expected to have.

This interface declares the minimum functionality a media player used by the framework is expected to have.

Properties:
Name Type Description
Dom GoBrain.Dom

Contains scoped DOM manipulation functionality.
Logger GoBrain.Logger

Instance specific logger to use for all logging.
Settings Object

Runtime settings for the media player.

Classes

IMediaPlayerDelegate

Methods

delegate(delegate){GoBrain.Pdk.Interfaces.IMediaPlayer|GoBrain.Pdk.Interfaces.IMediaPlayer~IMediaPlayerDelegate}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 200

Gets or sets media player delegate.

Gets or sets media player delegate.

Name Type Description
delegate GoBrain.Pdk.Interfaces.IMediaPlayer~IMediaPlayerDelegate
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer | GoBrain.Pdk.Interfaces.IMediaPlayer~IMediaPlayerDelegate

abstractdestroy()

GoBrain.Pdk/src/interfaces/imedia-player.js, line 59

Destroys the media player.

Destroys the media player.

abstractduration(duration){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 76

Gets or sets (if applicable) duration of the current clip.

Gets or sets (if applicable) duration of the current clip.

Name Type Description
duration Number optional

The new duration.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractfullscreen(enter){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 86

Requests the media player to enter or exit from fullscreen.

Requests the media player to enter or exit from fullscreen.

Name Type Description
enter Boolean

Whether to enter or exit from fullscreen.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractinitialize(container, onInitialized){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 48

Initializes the media player.

Initializes the media player.

Name Type Description
container HTMLElement

The container element for the media player.
onInitialized function

Callback for when the media player is initialized.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractpause(){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 96

Pauses playback.

Pauses playback.

Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractplay(){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 105

Starts playback.

Starts playback.

Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractplaybackRate(playbackRate){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 114

Gets or sets playbackRate.

Gets or sets playbackRate.

Name Type Description
playbackRate Number optional

The new playbackRate.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractposition(position){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 124

Gets or sets position in the current clip.

Gets or sets position in the current clip.

Name Type Description
position Number optional

The new position.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractquality(quality){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 144

Gets or sets quality of the current clip.

Gets or sets quality of the current clip.

Name Type Description
quality GoBrain.Dtos.Specifications.Video optional

The new quality.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractreset(){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 67

Resets the media player.

Resets the media player.

Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractsource(playbackItem){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 134

Switches to a new playback item to be played.

Switches to a new playback item to be played.

Name Type Description
playbackItem GoBrain.Dtos.PlaybackItem

The new playback item.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractstop(){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 154

Stops playback.

Stops playback.

Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractsubtitle(language){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 163

Sets the new language to use as default for subtitles (if any exists).

Sets the new language to use as default for subtitles (if any exists).

Name Type Description
language GoBrain.Dtos.Language optional

The new language.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer

abstractvolume(volume){GoBrain.Pdk.Interfaces.IMediaPlayer}

GoBrain.Pdk/src/interfaces/imedia-player.js, line 173

Gets or sets volume of the current clip.

Gets or sets volume of the current clip.

Name Type Description
volume Number optional

The new volume. Valid values are between 0 and 1.
Returns:
Type Description
GoBrain.Pdk.Interfaces.IMediaPlayer