GCKMediaInformationBuilder Class Reference

A builder object for constructing new or derived GCKMediaInformation instances. More...

#import <GCKMediaInformation.h>

Inheritance diagram for GCKMediaInformationBuilder:

Instance Methods
(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...

Properties
NSString *	contentID
	The content ID for this stream. More...
GCKMediaStreamType	streamType
	The stream type. More...
NSString *	contentType
	The content (MIME) type. More...
GCKMediaMetadata *	metadata
	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...
GCKMediaTextTrackStyle *	textTrackStyle
	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...

Detailed Description

A builder object for constructing new or derived GCKMediaInformation instances.

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

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

Since

4.0

Method Documentation

- (GCKMediaInformation *) build

Builds a GCKMediaInformation using the builder's current attributes.

Returns

The new GCKMediaInformation instance.

- (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

mediaInfo

The instance to copy.

Property Documentation

- (NSArray<GCKAdBreakClipInfo *>*) adBreakClips

readwritenonatomiccopy

The list of ad break clips in this content.

- (NSArray<GCKAdBreakInfo *>*) adBreaks

readwritenonatomiccopy

The list of ad breaks in this content.

- (NSString*) contentID

readwritenonatomiccopy

The content ID for this stream.

- (NSString*) contentType

readwritenonatomiccopy

The content (MIME) type.

- (id) customData

readwritenonatomicstrong

The custom data, if any.

- (NSString*) entity

readwritenonatomiccopy

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

- (NSArray<GCKMediaTrack *>*) mediaTracks

readwritenonatomiccopy

The media tracks for this stream.

- (GCKMediaMetadata*) metadata

readwritenonatomicstrong

The media item metadata.

- (NSTimeInterval) streamDuration

readwritenonatomicassign

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

Defaults to 0.

- (GCKMediaStreamType) streamType

readwritenonatomicassign

The stream type.

Defaults to GCKMediaStreamTypeBuffered.

- (GCKMediaTextTrackStyle*) textTrackStyle

readwritenonatomiccopy

The text track style for this stream.

---

The documentation for this class was generated from the following file:

• GCKMediaInformation.h