GoBrain 1.0.36

Class: Widget

GoBrain.Pdk.Extensions. Widget

new GoBrain.Pdk.Extensions.Widget()

GoBrain.Pdk/src/extensions/widget.js, line 1
This:
Properties:
Name Type Description
Queue GoBrain.Pdk.Extensions.Widget~Queue
Fires:

Extends

Classes

Queue

Namespaces

External

Members

EventsString

Properties:
Name Type Default Description
duration String duration
error String error
initialized String initialized
loaded String loaded
notification String notification
pause String pause
play String play
playable String playable
playbackRate String playbackRate
playComplete String playComplete
position String position
queue String queue
queueComplete String queueComplete
queueItem String queueItem
queueItemUpdated String queueItemUpdated
ready String ready
seeked String seeked
seeking String seeking
volume String volume

Methods

data(url, headers, replace){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 30

Loads new or additional data.

Loads new or additional data.

This:
Name Type Default Description
url String

Url to data to load.
headers Object.<String, String> optional

Optional headers to override when making the data request.
replace Boolean true optional

Whether to replace the existing data or add to it.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

inherited destroy()

GoBrain.Core/src/gobrain.js, line 342

Destroys the widget.

Destroys the widget.

fullscreen(exit){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 64

Requests a fullscreen change.

Requests a fullscreen change. This function must be called within the scope of a user click to work.

This:
Name Type Description
exit Boolean

Pass true to exit fullscreen.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

hide(){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 79

Hides the widget.

Hides the widget.

This:
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

inherited initialize(){GoBrain.Widgets.Widget}

GoBrain.Core/src/gobrain.js, line 289

(Re)initializes the widget.

(Re)initializes the widget.

Returns:
Type Description
GoBrain.Widgets.Widget

notification(notification){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 93

Sends a notification event.

Sends a notification event.

This:
Name Type Description
notification Object

Notification to send.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

inherited off(){GoBrain.Widgets.Widget}

GoBrain.Core/src/gobrain.js, line 361

Remove an event listener.

Remove an event listener.

Returns:
Type Description
GoBrain.Widgets.Widget

inherited on(){GoBrain.Widgets.Widget}

GoBrain.Core/src/gobrain.js, line 392

Adds an event listener.

Adds an event listener.

Returns:
Type Description
GoBrain.Widgets.Widget

inherited once(){GoBrain.Widgets.Widget}

GoBrain.Core/src/gobrain.js, line 423

Adds an event listener that will only fire once.

Adds an event listener that will only fire once.

Returns:
Type Description
GoBrain.Widgets.Widget

pause(){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 108

Sends a pause command.

Sends a pause command.

This:
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

play(){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 122

Sends a play command.

Sends a play command.

This:
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

playbackRate(playbackRate){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 136

Changes playback rate.

Changes playback rate.

This:
Name Type Description
playbackRate Number

The new playbackRate.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

position(position){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 153

Changes position.

Changes position.

This:
Name Type Description
position Number

The new position in seconds and parts of second.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

quality(quality){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 170

Changes quality.

Changes quality.

This:
Name Type Description
quality GoBrain.Dtos.Specifications.Video

The new quality.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

show(){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 189

Shows the widget.

Shows the widget.

This:
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

stop(){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 203

Sends a stop command.

Sends a stop command.

This:
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

subtitles(languageCode){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 217

Set active subtitle language or disables subtitles if null is passed as languageCode.

Set active subtitle language or disables subtitles if null is passed as languageCode.

This:
Name Type Description
languageCode String

The new language code or null to disable subtitles.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget

volume(volume){GoBrain.Pdk.Extensions.Widget}

GoBrain.Pdk/src/extensions/widget.js, line 238

Changes volume.

Changes volume.

This:
Name Type Description
volume Number

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

Events

duration

GoBrain.Pdk/src/definitions.jsdoc, line 2

Clip duration has changed.

Clip duration has changed.

Name Type Description
duration Number

The new duration.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.duration

error

GoBrain.Pdk/src/definitions.jsdoc, line 9

Widget error.

Widget error.

Name Type Description
exception GoBrain.Exceptions.Exception

An exception will be passed as argument to the event handler.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.error

inherited initialized

GoBrain.Core/src/definitions.jsdoc, line 2

Widget initialized.

Widget initialized.

See:

inherited loaded

GoBrain.Core/src/definitions.jsdoc, line 8

Widget loaded.

Widget loaded.

See:

notification

GoBrain.Pdk/src/definitions.jsdoc, line 16

Widget notification.

Widget notification. Can be fired if the notification functionality is available.

Name Type Description
notification GoBrain.ModuleAssets.Notifications.Dtos.Notification

A notification will be passed as argument to the event handler.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.notification

pause

GoBrain.Pdk/src/definitions.jsdoc, line 23

Widget paused.

Widget paused.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.pause

play

GoBrain.Pdk/src/definitions.jsdoc, line 29

Widget playing.

Widget playing.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.play

playable

GoBrain.Pdk/src/definitions.jsdoc, line 35

Widget is ready for playback related interaction.

Widget is ready for playback related interaction. This event fires once per clip during a playback session.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.playable

playComplete

GoBrain.Pdk/src/definitions.jsdoc, line 41

Clip has stopped playing.

Clip has stopped playing.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.playComplete

position

GoBrain.Pdk/src/definitions.jsdoc, line 47

Clip position has changed.

Clip position has changed.

Name Type Description
position Number

The new position.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.position

queue

GoBrain.Pdk/src/definitions.jsdoc, line 54

Playback queue has changed.

Playback queue has changed.

Name Type Description
queueChangedInfo GoBrain.Pdk.Extensions.Widget#Queue~QueueInfo

Object describing the new playback queue.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.queue

queueComplete

GoBrain.Pdk/src/definitions.jsdoc, line 61

Playback queue has completed.

Playback queue has completed.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.queueComplete

queueItem

GoBrain.Pdk/src/definitions.jsdoc, line 67

Current playback item has changed.

Current playback item has changed.

Name Type Description
queueItemChangedInfo Object

Object describing which playback item is the new current one.

Name Type Description
currentIndex Number

Index of the current playback item in the current playback queue.
currentItem GoBrain.Dtos.PlaybackItem

The new current playback item.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.queueItem

ready

GoBrain.Pdk/src/definitions.jsdoc, line 76

Widget is ready for interaction.

Widget is ready for interaction.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.ready

seeked

GoBrain.Pdk/src/definitions.jsdoc, line 82

Clip is done seeking.

Clip is done seeking.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.seeked

seeking

GoBrain.Pdk/src/definitions.jsdoc, line 88

Clip is seeking.

Clip is seeking.

See:
  • GoBrain.Pdk.Extensions.Widget#Events.seeking

volume

GoBrain.Pdk/src/definitions.jsdoc, line 94

Widget volume has changed.

Widget volume has changed.

Name Type Description
volume Number

The new volume.
See:
  • GoBrain.Pdk.Extensions.Widget#Events.volume