GCKMediaQueueLoadOptions Class

  • GCKMediaQueueLoadOptions provides options for loading media queue items using GCKRemoteMediaClient.

  • It allows you to specify the starting index, initial playback position, and repeat mode for the media queue.

  • You can also include custom application-specific data with the request.

  • The class inherits from NSObject, NSCopying, and NSSecureCoding.

  • An initialized GCKMediaQueueLoadOptions object contains default values for all its properties.
Instance Methods | Properties
GCKMediaQueueLoadOptions Class Reference

Overview

Options for loading media queue items with GCKRemoteMediaClient.

Since
4.3

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary

(instancetype) - init
 Designated initializer. More...
 

Property Summary

NSUInteger startIndex
 The index of the item in the queue items array that should be played first. More...
 
NSTimeInterval playPosition
 The initial playback position for the first item in the queue items array when it is first played, relative to the beginning of the stream. More...
 
GCKMediaRepeatMode repeatMode
 The repeat mode for playing the queue. More...
 
id customData
 Custom application-specific data to pass along with the request. More...
 

Method Detail

- (instancetype) init

Designated initializer.

Initializes a GCKMediaLoadOptions with default values for all properties.

Property Detail

- (NSUInteger) startIndex
readwritenonatomicassign

The index of the item in the queue items array that should be played first.

- (NSTimeInterval) playPosition
readwritenonatomicassign

The initial playback position for the first item in the queue items array when it is first played, relative to the beginning of the stream.

This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used.

- (GCKMediaRepeatMode) repeatMode
readwritenonatomicassign

The repeat mode for playing the queue.

- (id) customData
readwritenonatomicstrong

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.