GCKMediaQueueContainerMetadataBuilder Class

  • GCKMediaQueueContainerMetadataBuilder is a builder object used to construct new or derived instances of GCKMediaQueueContainerMetadata.

  • You can initialize the builder with a specific container type or from an existing GCKMediaQueueContainerMetadata instance.

  • The builder allows you to set various properties for the container metadata, such as type, title, sections, duration, images, authors, narrators, publisher, and release date.

  • The build method is used to create a new GCKMediaQueueContainerMetadata instance based on the attributes set in the builder.
Instance Methods | Properties
GCKMediaQueueContainerMetadataBuilder Class Reference

Overview

A builder object for constructing new or derived GCKMediaQueueContainerMetadata instances.

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

Since
4.4.1

Inherits NSObject.

Instance Method Summary

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

Property Summary

GCKMediaQueueContainerType containerType
 The type of metadata. More...
 
NSString * title
 The container title. More...
 
NSArray< GCKMediaMetadata * > * sections
 The metadata of each sections that a media stream contains. More...
 
NSTimeInterval containerDuration
 The total playback time for the container. More...
 
NSArray< GCKImage * > * containerImages
 Images associated with the queue. More...
 
NSArray< NSString * > * authors
 The author names. More...
 
NSArray< NSString * > * narrators
 The audiobook narrator names. More...
 
NSString * publisher
 The book publisher. More...
 
NSString * releaseDate
 The book release date in ISO-8601 format. More...
 

Method Detail

- (instancetype) initWithContainerType: (GCKMediaQueueContainerType)  containerType

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

- (instancetype) initWithContainerMetadata: (GCKMediaQueueContainerMetadata *)  containerMetadata

Constructs a new GCKMediaQueueContainerMetadata with the given GCKMediaQueueContainerMetadata instance.

- (GCKMediaQueueContainerMetadata *) build

Builds a GCKMediaQueueContainerMetadata using the builder's current attributes.

Returns
The new GCKMediaQueueContainerMetadata instance.

Property Detail

- (GCKMediaQueueContainerType) containerType
readwritenonatomicassign

The type of metadata.

- (NSString*) title
readwritenonatomiccopy

The container title.

It can be audiobook title, Live TV Channel name, album name or playlist name, etc.

- (NSArray<GCKMediaMetadata *>*) sections
readwritenonatomiccopy

The metadata of each sections that a media stream contains.

- (NSTimeInterval) containerDuration
readwritenonatomicassign

The total playback time for the container.

- (NSArray<GCKImage *>*) containerImages
readwritenonatomiccopy

Images associated with the queue.

By default the first image is used when displaying queue information. Used for audio book image, a TV Channel logo, album cover, etc.

- (NSArray<NSString *>*) authors
readwritenonatomiccopy

The author names.

Used for audio book.

- (NSArray<NSString *>*) narrators
readwritenonatomiccopy

The audiobook narrator names.

Used for audio book.

- (NSString*) publisher
readwritenonatomiccopy

The book publisher.

Used for audio book.

- (NSString*) releaseDate
readwritenonatomiccopy

The book release date in ISO-8601 format.

Used for audio book.