GCKMediaInformation Class

GCKMediaInformation Class Reference

Overview

A class that aggregates information about a media item.

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary

(instancetype) - initWithContentID:streamType:contentType:metadata:adBreaks:adBreakClips:streamDuration:mediaTracks:textTrackStyle:customData:
 Deprecated. More...
 
(instancetype) - initWithContentID:streamType:contentType:metadata:streamDuration:mediaTracks:textTrackStyle:customData:
 Deprecated. More...
 
(nullable GCKMediaTrack *) - mediaTrackWithID:
 Searches for a media track with the given track ID. 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 epoch time in seconds of the stream start time. More...
 
id customData
 The custom data, if any. More...
 

Method Detail

- (instancetype) initWithContentID: (NSString *)  contentID
streamType: (GCKMediaStreamType streamType
contentType: (NSString *)  contentType
metadata: (nullable GCKMediaMetadata *)  metadata
adBreaks: (nullable NSArray< GCKAdBreakInfo * > *)  adBreaks
adBreakClips: (nullable NSArray< GCKAdBreakClipInfo * > *)  adBreakClips
streamDuration: (NSTimeInterval)  streamDuration
mediaTracks: (nullable NSArray< GCKMediaTrack * > *)  mediaTracks
textTrackStyle: (nullable GCKMediaTextTrackStyle *)  textTrackStyle
customData: (nullable id)  customData 

Deprecated.

Use GCKMediaInformationBuilder to initialize GCKMediaInformation objects.

Parameters
contentIDThe content ID.
streamTypeThe stream type.
contentTypeThe content (MIME) type.
metadataThe media item metadata.
adBreaksThe list of ad breaks in this content.
adBreakClipsThe list of ad break clips in this content.
streamDurationThe stream duration.
mediaTracksThe media tracks, if any, otherwise nil.
textTrackStyleThe text track style, if any, otherwise nil.
customDataThe custom application-specific data. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Since
4.3
- (instancetype) initWithContentID: (NSString *)  contentID
streamType: (GCKMediaStreamType streamType
contentType: (NSString *)  contentType
metadata: (nullable GCKMediaMetadata *)  metadata
streamDuration: (NSTimeInterval)  streamDuration
mediaTracks: (nullable NSArray< GCKMediaTrack * > *)  mediaTracks
textTrackStyle: (nullable GCKMediaTextTrackStyle *)  textTrackStyle
customData: (nullable id)  customData 

Deprecated.

Use GCKMediaInformationBuilder to initialize GCKMediaInformation objects.

Parameters
contentIDThe content ID.
streamTypeThe stream type.
contentTypeThe content (MIME) type.
metadataThe media item metadata.
streamDurationThe stream duration.
mediaTracksThe media tracks, if any, otherwise nil.
textTrackStyleThe text track style, if any, otherwise nil.
customDataThe custom application-specific data. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- (nullable GCKMediaTrack *) mediaTrackWithID: (NSInteger)  trackID

Searches for a media track with the given track ID.

Parameters
trackIDThe media track ID.
Returns
The matching GCKMediaTrack object, or nil if there is no media track with the given ID.

Property Detail

- (NSString*) contentID
readnonatomiccopy

The content ID for this stream.

- (NSURL*) contentURL
readnonatomiccopy

The URL of the content to be played.

Since
4.3.4
- (GCKMediaStreamType) streamType
readnonatomicassign

The stream type.

- (NSString*) contentType
readnonatomiccopy

The content (MIME) type.

- (GCKMediaMetadata*) metadata
readnonatomicstrong

The media item metadata.

- (NSArray<GCKAdBreakInfo *>*) adBreaks
readnonatomiccopy

The list of ad breaks in this content.

- (NSArray<GCKAdBreakClipInfo *>*) adBreakClips
readnonatomiccopy

The list of ad break clips in this content.

Since
3.3
- (NSTimeInterval) streamDuration
readnonatomicassign

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

- (NSArray<GCKMediaTrack *>*) mediaTracks
readnonatomiccopy

The media tracks for this stream.

- (GCKMediaTextTrackStyle*) textTrackStyle
readnonatomiccopy

The text track style for this stream.

- (NSString*) entity
readnonatomiccopy

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

Since
4.0
- (GCKVASTAdsRequest*) VMAP
readnonatomicstrong

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
readnonatomicassign

The epoch time in seconds of the stream start time.

Since
4.4.1
- (id) customData
readnonatomicstrong

The custom data, if any.