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] initWithContentURL:...];
builder.contentType = ...;
builder.streamType = ...;
builder.metadata = ...;
// Set all other desired propreties...
GCKMediaInformation *newMediaInfo = [builder build];
Since
4.0

Inherits NSObject.

Instance Method Summary

(instancetype) - initWithContentURL:
 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...
 
(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...
 
(GCKMediaInformation *) - build
 Builds a GCKMediaInformation using the builder's current attributes. More...
 

Property Summary

NSString * contentID
 The content ID for this stream. More...
 
NSURL * contentURL
 The URL of the content to be played. 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...
 
GCKVASTAdsRequestVMAP
 The VMAP request configuration if any. More...
 
NSTimeInterval startAbsoluteTime
 The start time of the stream, in seconds in epoch time, or kGCKInvalidTimeInterval if it is not available. More...
 
id customData
 The custom data, if any. More...
 

Method Detail

- (instancetype) initWithContentURL: (NSURL *)  contentURL

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

Parameters
contentURLThe URL of the content to be played.
Since
4.3.4
- (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.
- (instancetype) initWithContentID: (NSString *)  contentID

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

Deprecated:
Use initWithContentURL: or initWithEntity: instead.
- (instancetype) initWithContentID: (NSString *)  contentID
entity: (NSString *)  entity 

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

Deprecated:
Use initWithContentURL: or initWithEntity: instead.
- (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.

Deprecated:
Use contentURL and entity instead.
- (NSURL*) contentURL
readwritenonatomiccopy

The URL of the content to be played.

Since
4.3.4
- (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.

- (GCKVASTAdsRequest*) VMAP
readwritenonatomicstrong

The VMAP request configuration if any.

See more here: Digital Video Ad Serving Template 4.0. If this is non-nil, all other ads related fields will be ignored.

Since
4.3.4
- (NSTimeInterval) startAbsoluteTime
readwritenonatomicassign

The start time of the stream, in seconds in epoch time, or kGCKInvalidTimeInterval if it is not available.

Defaults to kGCKInvalidTimeInterval.

Since
4.4.1
- (id) customData
readwritenonatomicstrong

The custom data, if any.