PlaybackReferenceBuilder object.
Extends
Constructors
new PlaybackReferenceBuilder()
new PlaybackReferenceBuilder():PlaybackReferenceBuilder
Returns
PlaybackReferenceBuilder
Inherited from
Builder.constructor
Methods
build()
build():IPlaybackReference
Builds the PlaybackReference object based on the parameters provided.
Returns
IPlaybackReference
The built PlaybackReference object.
Details
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
If one or more of the required fields are missing.Throws
If the function is called after this builder instance has already built an object once.Overrides
Builder.build
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.
Returns
PlaybackReferenceBuilder
The PlaybackReferenceBuilder object with mediaId set.
Throws
If the function is called after this builder instance has already built an object once.playbackType()
playbackType(playbackType): PlaybackReferenceBuilder
Sets the playback type of the playback reference in the builder and returns an instance of the builder.
Parameters
playbackType
CONTENT
Represents the playback type. This field is required.
Returns
PlaybackReferenceBuilder
The PlaybackReferenceBuilder object with playbackType set.
