GoBrain 1.0.36

Class: ITracker

GoBrain.Pdk.Interfaces. ITracker

abstractnew GoBrain.Pdk.Interfaces.ITracker()

GoBrain.Pdk/src/interfaces/itracker.js, line 1

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

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

Properties:
Name Type Description
config Object

Tracker configuration.
Logger GoBrain.Logger

Instance specific logger to use for all logging.
Settings Object

Runtime settings for the tracker.

Namespaces

advertisement

Methods

abstractbufferComplete(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 113

Called when enough data to play is in the buffer.

Called when enough data to play is in the buffer.

Name Type Description
data Object optional

Any additional data given with the event.

abstractbufferStart(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 122

Called when not enough data to play is in the buffer.

Called when not enough data to play is in the buffer.

Name Type Description
data Object optional

Any additional data given with the event.

abstractcomplete(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 131

Called when clip has stopped playing.

Called when clip has stopped playing.

Name Type Description
data Object optional

Any additional data given with the event.

abstractdestroy()

GoBrain.Pdk/src/interfaces/itracker.js, line 44

Destroys the tracker.

Destroys the tracker.

abstractduration(duration)

GoBrain.Pdk/src/interfaces/itracker.js, line 140

Called when clip duration has changed.

Called when clip duration has changed.

Name Type Description
duration Number

The new duration.

abstractinitialize()

GoBrain.Pdk/src/interfaces/itracker.js, line 36

Initializes the tracker.

Initializes the tracker.

abstractinitialized(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 149

Called when clip has been initialized.

Called when clip has been initialized.

Name Type Description
data Object optional

Any additional data given with the event.

abstractmetadata(metadata)

GoBrain.Pdk/src/interfaces/itracker.js, line 158

Called when clip metadata has changed.

Called when clip metadata has changed.

Name Type Description
metadata Object

The new metadata.

abstractpause(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 167

Called when clip has been paused.

Called when clip has been paused.

Name Type Description
data Object optional

Any additional data given with the event.

abstractplay(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 176

Called when clip has started playing.

Called when clip has started playing.

Name Type Description
data Object optional

Any additional data given with the event.

abstractposition(position)

GoBrain.Pdk/src/interfaces/itracker.js, line 185

Called when clip position has changed.

Called when clip position has changed.

Name Type Description
position Number

The new position.

abstractqueueItemLoaded()

GoBrain.Pdk/src/interfaces/itracker.js, line 194

Called when a new playback item has been loaded.

Called when a new playback item has been loaded.

abstractqueueItemUnLoaded(event)

GoBrain.Pdk/src/interfaces/itracker.js, line 202

Called when playback item has been unloaded.

Called when playback item has been unloaded.

Name Type Description
event Object

The event data.

Name Type Description
currentItem GoBrain.Dtos.PlaybackItem

The new playback item.

abstractseeked(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 212

Called when clip is done seeking.

Called when clip is done seeking.

Name Type Description
data Object optional

Any additional data given with the event.

abstractseeking(data)

GoBrain.Pdk/src/interfaces/itracker.js, line 221

Called when clip is seeking.

Called when clip is seeking.

Name Type Description
data Object optional

Any additional data given with the event.

validate(){Boolean}

GoBrain.Pdk/src/interfaces/itracker.js, line 247

Validates a tracker.

Validates a tracker.

Returns:
Type Description
Boolean