GCKMediaInformationBuilder Class

GCKMediaInformationBuilder Class Reference

Overview

A builder object for constructing new or derived GCKMediaInformation instances.

The builder may be used to derive a GCKMediaInformation from an existing one:

[[GCKMediaInformationBuilder alloc] initWithMediaInformation:originalMediaInfo];
builder.contentID = ...; // Change the content ID.
builder.streamDuration = 100; // Change the stream duration.
GCKMediaInformation *derivedMediaInfo = [builder build];

It can also be used to construct a new GCKMediaInformation from scratch:

[[GCKMediaInformationBuilder alloc] initWithContentID:...];
builder.contentType = ...;
builder.streamType = ...;
builder.metadata = ...;
// Set all other desired propreties...
GCKMediaInformation *newMediaInfo = [builder build];
Since
4.0

Inherits NSObject.

Instance Method Summary

(instancetype) - initWithContentID:
 Constructs a new GCKMediaInformationBuilder with the given required attributes, and all other attributes initialized to default values. More...
 
(instancetype) - initWithContentID:entity:
 Constructs a new GCKMediaInformationBuilder with the given required attributes, and all other attributes initialized to default values. More...
 
(instancetype) - initWithEntity:
 Constructs a new GCKMediaInformationBuilder with the given required attributes, and all other attributes initialized to default values. More...
 
(instancetype) - initWithMediaInformation:
 Constructs a new GCKMediaInformationBuilder with attributes copied from the given GCKMediaInformation instance. More...
 
(GCKMediaInformation *) - build
 Builds a GCKMediaInformation using the builder's current attributes. More...
 

Property Summary

NSString * contentID
 The content ID for this stream. More...
 
GCKMediaStreamType streamType
 The stream type. More...
 
NSString * contentType
 The content (MIME) type. More...
 
GCKMediaMetadatametadata
 The media item metadata. More...
 
NSArray< GCKAdBreakInfo * > * adBreaks
 The list of ad breaks in this content. More...
 
NSArray< GCKAdBreakClipInfo * > * adBreakClips
 The list of ad break clips in this content. More...
 
NSTimeInterval streamDuration
 The length of the stream, in seconds, or INFINITY if it is a live stream. More...
 
NSArray< GCKMediaTrack * > * mediaTracks
 The media tracks for this stream. More...
 
GCKMediaTextTrackStyletextTrackStyle
 The text track style for this stream. More...
 
NSString * entity
 The deep link for the media as used by Google Assistant, if any. More...
 
id customData
 The custom data, if any. More...
 

Method Detail

- (instancetype) initWithContentID: (NSString *)  contentID

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

- (instancetype) initWithContentID: (NSString *)  contentID
entity: (NSString *)  entity 

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

- (instancetype) initWithEntity: (NSString *)  entity

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

- (instancetype) initWithMediaInformation: (GCKMediaInformation *)  mediaInfo

Constructs a new GCKMediaInformationBuilder with attributes copied from the given GCKMediaInformation instance.

Parameters
mediaInfoThe instance to copy.
- (GCKMediaInformation *) build

Builds a GCKMediaInformation using the builder's current attributes.

Returns
The new GCKMediaInformation instance.

Property Detail

- (NSString*) contentID
readwritenonatomiccopy

The content ID for this stream.

- (GCKMediaStreamType) streamType
readwritenonatomicassign

The stream type.

Defaults to GCKMediaStreamTypeBuffered.

- (NSString*) contentType
readwritenonatomiccopy

The content (MIME) type.

- (GCKMediaMetadata*) metadata
readwritenonatomicstrong

The media item metadata.

- (NSArray<GCKAdBreakInfo *>*) adBreaks
readwritenonatomiccopy

The list of ad breaks in this content.

- (NSArray<GCKAdBreakClipInfo *>*) adBreakClips
readwritenonatomiccopy

The list of ad break clips in this content.

- (NSTimeInterval) streamDuration
readwritenonatomicassign

The length of the stream, in seconds, or INFINITY if it is a live stream.

Defaults to 0.

- (NSArray<GCKMediaTrack *>*) mediaTracks
readwritenonatomiccopy

The media tracks for this stream.

- (GCKMediaTextTrackStyle*) textTrackStyle
readwritenonatomiccopy

The text track style for this stream.

- (NSString*) entity
readwritenonatomiccopy

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

- (id) customData
readwritenonatomicstrong

The custom data, if any.