Skip to main content

AudioPlayerRequestBuilder

Stentor API Reference


Stentor API Reference / stentor-request/src / AudioPlayerRequestBuilder

Class: AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:505

Build an AudioPlayerRequest

Extends​

  • AbstractBuilder\<AudioPlayerRequest>

Constructors​

Constructor​

new AudioPlayerRequestBuilder(): AudioPlayerRequestBuilder

Returns​

AudioPlayerRequestBuilder

Inherited from​

AbstractBuilder<AudioPlayerRequest>.constructor

Methods​

withEvent()​

withEvent(event): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:513

Parameters​

event​

AudioPlayerEvent

Returns​

AudioPlayerRequestBuilder


withFailure()​

withFailure(type, message): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:523

Sets request type to AudioPlayerPlaybackFailed and adds type & message to the request

Parameters​

type​

string

message​

string

Returns​

AudioPlayerRequestBuilder


playbackStarted()​

playbackStarted(): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:531

Returns​

AudioPlayerRequestBuilder


playbackStopped()​

playbackStopped(): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:536

Returns​

AudioPlayerRequestBuilder


withOffset()​

withOffset(offsetInMilliseconds): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:541

Parameters​

offsetInMilliseconds​

number

Returns​

AudioPlayerRequestBuilder


withToken()​

withToken(token): AudioPlayerRequestBuilder

Defined in: packages/stentor-request/src/Builders.ts:546

Parameters​

token​

string

Returns​

AudioPlayerRequestBuilder


build()​

build(): AudioPlayerRequest

Defined in: packages/stentor-request/src/Builders.ts:551

Returns​

AudioPlayerRequest

Overrides​

AbstractBuilder.build