GCKMediaInformationBuilder Class

    • GCKMediaInformationBuilder is used to construct new or derived GCKMediaInformation instances.

    • Builders can be initialized with a content URL, entity, or by copying an existing GCKMediaInformation instance.

    • Key properties like contentID, contentURL, streamType, contentType, and metadata can be set using the builder.

    • Additional properties such as adBreaks, adBreakClips, streamDuration, mediaTracks, textTrackStyle, entity, VMAP, startAbsoluteTime, hlsSegmentFormat, hlsVideoSegmentFormat, and customData can also be configured.

    • The build method is used to create the final GCKMediaInformation instance from the builder's current attributes.
    Instance Methods | Properties
    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 *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] 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...
    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...
    GCKVASTAdsRequest * 
    VMAP
    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...
    GCKHLSSegmentFormat
    hlsSegmentFormat
    The format of the HLS audio segment. More...
    GCKHLSVideoSegmentFormat
    hlsVideoSegmentFormat
    The format of the HLS video segment. 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
    contentURL
    The 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
    mediaInfo
    The 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
    read write nonatomic copy

    The content ID for this stream.

    Deprecated:
    Use contentURL and entity instead.
    - (NSURL*) contentURL
    read write nonatomic copy

    The URL of the content to be played.

    Since
    4.3.4
    - ( GCKMediaStreamType ) streamType
    read write nonatomic assign

    The stream type.

    Defaults to GCKMediaStreamTypeBuffered.

    - (NSString*) contentType
    read write nonatomic copy

    The content (MIME) type.

    - ( GCKMediaMetadata *) metadata
    read write nonatomic assign

    The media item metadata.

    - (NSArray< GCKAdBreakInfo *>*) adBreaks
    read write nonatomic copy

    The list of ad breaks in this content.

    - (NSArray< GCKAdBreakClipInfo *>*) adBreakClips
    read write nonatomic copy

    The list of ad break clips in this content.

    - (NSTimeInterval) streamDuration
    read write nonatomic assign

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

    Defaults to 0.

    - (NSArray< GCKMediaTrack *>*) mediaTracks
    read write nonatomic copy

    The media tracks for this stream.

    - ( GCKMediaTextTrackStyle *) textTrackStyle
    read write nonatomic copy

    The text track style for this stream.

    - (NSString*) entity
    read write nonatomic copy

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

    - ( GCKVASTAdsRequest *) VMAP
    read write nonatomic assign

    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
    read write nonatomic assign

    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
    - ( GCKHLSSegmentFormat ) hlsSegmentFormat
    read write nonatomic assign

    The format of the HLS audio segment.

    Since
    4.6.0
    - ( GCKHLSVideoSegmentFormat ) hlsVideoSegmentFormat
    read write nonatomic assign

    The format of the HLS video segment.

    Since
    4.6.0
    - (id) customData
    read write nonatomic assign

    The custom data, if any.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: