AudioPlayerRequestBuilder
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