GCKMediaQueueDataBuilder Class

  • GCKMediaQueueDataBuilder constructs and modifies GCKMediaQueueData instances, which represent media queues or containers on Google Cast.

  • You can initialize it with a queue type or an existing GCKMediaQueueData object for derivation.

  • It provides properties to customize various aspects of the queue, including queue type, ID, name, repeat mode, start index, start time, and items.

  • The build method creates a GCKMediaQueueData instance based on the builder's current configuration.
Instance Methods | Properties
GCKMediaQueueDataBuilder Class Reference

Overview

A builder object for constructing new or derived GCKMediaQueueData instances.

The builder may be used to derive GCKMediaQueueData from an existing one.

Since
4.4.1

Inherits NSObject.

Instance Method Summary

(instancetype) - initWithQueueType:
 Constructs a new GCKMediaQueueData with the given required attributes, and all other attributes initialized to default values. More...
 
(instancetype) - initWithQueueData:
 Constructs a new GCKMediaQueueData with the given GCKMediaQueueData instance. More...
 
(instancetype) - init
 
(GCKMediaQueueData *) - build
 Builds a GCKMediaQueueData using the builder's current attributes. More...
 

Property Summary

GCKMediaQueueType queueType
 The queue type. More...
 
NSString * queueID
 The queue id. More...
 
NSString * name
 The display name for queue. More...
 
NSString * entity
 The deep link for the media as used by Google Assistant, if any. More...
 
GCKMediaRepeatMode repeatMode
 The repeat mode of queue. More...
 
GCKMediaQueueContainerMetadata * containerMetadata
 The container metadata. More...
 
NSUInteger startIndex
 The index of the item to start playing with. More...
 
NSTimeInterval startTime
 The playback start time, in seconds. More...
 
NSArray< GCKMediaQueueItem * > * items
 The queueItems. More...
 

Method Detail

- (instancetype) initWithQueueType: (GCKMediaQueueType)  queueType

Constructs a new GCKMediaQueueData with the given required attributes, and all other attributes initialized to default values.

- (instancetype) initWithQueueData: (GCKMediaQueueData *)  queueData

Constructs a new GCKMediaQueueData with the given GCKMediaQueueData instance.

- (GCKMediaQueueData *) build

Builds a GCKMediaQueueData using the builder's current attributes.

Returns
The new GCKMediaQueueData instance.

Property Detail

- (GCKMediaQueueType) queueType
readwritenonatomicassign

The queue type.

- (NSString*) queueID
readwritenonatomiccopy

The queue id.

- (NSString*) name
readwritenonatomiccopy

The display name for queue.

- (NSString*) entity
readwritenonatomiccopy

The deep link for the media as used by Google Assistant, if any.

- (GCKMediaRepeatMode) repeatMode
readwritenonatomicassign

The repeat mode of queue.

- (GCKMediaQueueContainerMetadata*) containerMetadata
readwritenonatomiccopy

The container metadata.

- (NSUInteger) startIndex
readwritenonatomicassign

The index of the item to start playing with.

Only for load request.

- (NSTimeInterval) startTime
readwritenonatomicassign

The playback start time, in seconds.

Only for load request. If not set, the receiver will set the start time depending on the stream type. For non-live streams: loaded from 0. For live streams: loaded from the most recent position.

- (NSArray<GCKMediaQueueItem *>*) items
readwritenonatomiccopy

The queueItems.

Only for load requests.