GoBrain 1.0.36

Class: Queue

GoBrain.Pdk.Extensions.Widget~ Queue

new Queue()

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

Methods

add(args){GoBrain.Pdk.Extensions.Widget~Queue}

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

Adds one or more items to the playback queue.

Adds one or more items to the playback queue.

Name Type Description
args GoBrain.Dtos.PlaybackItem | Array.<GoBrain.Dtos.PlaybackItem>

Any number of playback items or an array of playback items to add to the playback queue.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

empty(){GoBrain.Pdk.Extensions.Widget~Queue}

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

Empties the playback queue.

Empties the playback queue.

Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

get(){GoBrain.Pdk.Extensions.Widget~Queue~QueueInfo}

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

Gets the current playback queue.

Gets the current playback queue.

Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue~QueueInfo

next(){GoBrain.Pdk.Extensions.Widget~Queue}

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

Switches to the next item in the playback queue.

Switches to the next item in the playback queue.

Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

previous(){GoBrain.Pdk.Extensions.Widget~Queue}

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

Switches to the previous item in the playback queue.

Switches to the previous item in the playback queue.

Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

remove(arg){GoBrain.Pdk.Extensions.Widget~Queue}

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

Removes a playback item from the playback queue.

Removes a playback item from the playback queue.

Name Type Description
arg Number | String

Index or id of playback item to remove.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

replace(items){GoBrain.Pdk.Extensions.Widget~Queue}

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

Replaces the current playback queue with one or more items.

Replaces the current playback queue with one or more items.

Name Type Description
items GoBrain.Dtos.PlaybackItem | Array.<GoBrain.Dtos.PlaybackItem>

Any number of playback items or an array of playback items to replace the current playback queue with.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

reverse(){GoBrain.Pdk.Extensions.Widget~Queue}

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

Reverses the playback queue.

Reverses the playback queue.

Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

select(arg){GoBrain.Pdk.Extensions.Widget~Queue}

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

Switches to a playback item in the playback queue.

Switches to a playback item in the playback queue.

Name Type Description
arg Number | String

Index or id of playback item to switch to.
Returns:
Type Description
GoBrain.Pdk.Extensions.Widget~Queue

Type Definitions

QueueInfoObject

Properties:
Name Type Description
currentIndex Number

The index of the current item in the current playback queue.
queue Array.<GoBrain.Dtos.PlaybackItem>

The current playback queue.