Interface IPlaybackReferenceBuilder
interface IPlaybackReferenceBuilder
Extends com.amazon.apmf.IStandard
Methods
playbackType()
Sets the playback type of the playback reference in the builder and returns an instance of the builder.IPlaybackReferenceBuilder*playbackType(PlaybackTypeplaybackType)
Parameters
playbackType
PlaybackType — Required
Represents the playback type. This field is required.
This must be one of the types defined in the PlaybackType struct.
Returns
IPlaybackReferenceBuilder*
The PlaybackReferenceBuilder object with playbackType set.
Throws
IllegalStateError— If the function is called after this builder instance has already built an object once.
mediaId()
Sets the media ID of the playback reference in the builder and returns an instance of the builder.IPlaybackReferenceBuilder*mediaId(com.amazon.kepler.media.types.MediaId*mediaId)
Parameters
mediaId
com.amazon.kepler.media.types.MediaId* — Required
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
IPlaybackReferenceBuilder*
The PlaybackReferenceBuilder object with mediaId set.
Throws
IllegalStateError— If the function is called after this builder instance has already built an object once.
build()
Builds and returns a pointer to an instance of theIPlaybackReference*build()
IPlaybackReference object.
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.
Returns
IPlaybackReference*
An instance of a PlaybackReference object with all of the data that was set.
Throws
InvalidArgumentError— If one or more of the required fields are not provided to the builder.IllegalStateError— If the function is called after this builder instance has already built an object once.
