Page Summary
-
GCKMediaLoadRequestDataBuilder is a builder object used to construct new or derived GCKMediaLoadRequestData instances.
-
It provides methods to initialize with default values or from an existing GCKMediaLoadRequestData object.
-
The builder includes properties for media information, queue data, autoplay flag, start time, playback rate, active track IDs, custom data, user credentials, and Android TV credentials.
-
The build method creates a new GCKMediaLoadRequestData instance based on the builder's current attributes.
Overview
A builder object for constructing new or derived GCKMediaLoadRequestData
instances.
The builder may be used to derive GCKMediaLoadRequestData
from an existing one.
- Since
- 4.4.1
Inherits NSObject.
Method Detail
| - (instancetype) init |
Initializes a GCKMediaLoadRequestData
with default values for all properties.
| - (instancetype) initWithMediaLoadRequestData: | ( GCKMediaLoadRequestData *) | requestData |
Initializes a GCKMediaLoadRequestData
with a given GCKMediaLoadRequestData
object.
| - ( GCKMediaLoadRequestData *) build |
Builds a GCKMediaLoadRequestData
using the builder's current attributes.
- Returns
- The new
GCKMediaLoadRequestDatainstance.
Property Detail
The media item to load.
The metadata of media item or queue.
The flag to indicate whether playback should start immediately.
The default value is @(YES)
. If this is nil
, the property of GCKMediaQueueItem
in queueData
will take effect. If queueData is nil
either, playback will not start immediately.
The initial position to start playback.
The default value is kGCKInvalidTimeInterval , which indicates a default playback position. If playing Video-On-Demand streams, it starts from 0; if playing live streams, it starts from live edge.
The playback rate.
The default value is 1
.
An array of integers specifying the active tracks.
The default value is nil
.
Custom application-specific data to pass along with the request.
Must either be an object that can be serialized to JSON using NSJSONSerialization
, or nil
.
The user credentials for the media item being loaded.
The type of user credentials specified in GCKMediaLoadRequestData::credentials .
The alternate Android TV credentials for the media item being loaded.
If set, these credentials will override the value set in GCKMediaLoadRequestData::credentials if the receiver is an Android TV app. On the receiver side, these credentials can be accessed from MediaLoadRequestData#getCredentials .
- Since
- 4.7.0
The type of Android TV credentials specified in GCKMediaLoadRequestData::atvCredentials .
If set, this credentials type will override the value set in GCKMediaLoadRequestData::credentialsType if the receiver is an Android TV app. On the receiver side, these credentials can be accessed from MediaLoadRequestData#getCredentialsType .
- Since
- 4.7.0
