AI-generated Key Takeaways
-
GCKMediaLoadRequestData is used with GCKRemoteMediaClient to specify how a receiver application should load media.
-
To load a single item, use
mediaInformation; for a non-cloud queue, usequeueData, optionally includingmediaInformationfor the first item. -
For cloud queues,
queueDatacan haveitemsas nil or empty, butentitymust be specified for the receiver to fetch the queue from the cloud. -
Load requests will fail if neither
mediaInformationnorqueueDatais specified.
Overview
Media load request data.
This class is used by load media commands in GCKRemoteMediaClient
for specifying how a receiver application should load media.
To load a single item, the item to load should be specified in mediaInformation
. To load a non-cloud queue, the queue information should be specified in queueData
. Optionally, the information for the first item to play can be specified in mediaInformation
. If the queue is a cloud queue, items
in can be nil
or empty, but entity
needs to be specified, so that the receiver app can fetch the queue from the cloud using entity
. If neither mediaInformation
nor queueData
is specified, load requests will fail without sending to receiver applications.
- Since
- 4.4.1
Inherits NSObject, <NSCopying>, and <NSSecureCoding>.
Property Detail
The media item to load.
The metadata of media item or queue.
The flag that indicates whether playback starts immediately after loaded.
The default value is @(YES)
.
When loading a queue by specifying the queue items in queueData
, this value overrides the autoplay
of the first GCKMediaQueueItem
to be loaded in queueData
. Only when this field is nil
, the autoplay
property of individual GCKMediaQueueItem
in queueData
will take effect.
When loading a single item by specifying the mediaInformation
, this field specifies whether the playback should start upon load. If nil
, playback will not start immediately.
The initial playback position.
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
