PlaybackReferenceBuilder
Builder that creates an instance of the PlaybackReferenceBuilder object.
Extends
Builder
Constructors
new PlaybackReferenceBuilder()
new PlaybackReferenceBuilder(): PlaybackReferenceBuilder
Returns
Methods
build()
build(): IPlaybackReference
Builds the PlaybackReference object based on the parameters provided.
This function should be called after the desired fields of the playback reference builder have been set using the other builder functions. The build() function should only be called once per builder object.
Throws
- InvalidArgumentError If one or more of the required fields are missing.
- IllegalStateError If the function is called after this builder instance has already built an object once.
Returns
IPlaybackReference The built PlaybackReference object.
mediaId()
mediaId(mediaId:
MediaId): PlaybackReferenceBuilder
Sets the media ID of the playback reference in the builder and returns an instance of the builder.
Parameters
mediaId
MediaId
The Media ID which uniquely identifies the content to selected when initiating playback for the live event.
This field is required if playbackType is set to CONTENT.
Throws
- IllegalStateError If the function is called after this builder instance has already built an object once.
Returns
IPlaybackReferenceBuilder The PlaybackReferenceBuilder object with mediaId set.
playbackType()
playbackType(playbackType: PlaybackType): PlaybackReferenceBuilder
Sets the playback type of the playback reference in the builder and returns an instance of the builder.
Parameters
playbackType
Represents the playback type. This field is required.
Throws
- IllegalStateError If the function is called after this builder instance has already built an object once.
Returns
IPlaybackReferenceBuilder The PlaybackReferenceBuilder object with playbackType set.
Last updated: Jul 31, 2026
