GCKAdBreakClipInfoBuilder Class

Instance Methods | Properties
GCKAdBreakClipInfoBuilder Class Reference

Overview

A builder object for constructing new or derived GCKAdBreakClipInfo instances.

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

GCKAdBreakClipInfoBuilder *builder =
[[GCKAdBreakClipInfoBuilder alloc] initWithAdBreakClipInfo:originalAdBreakClipInfo];
builder.adBreakClipID = ...; // Change the ad break clip ID.
builder.duration = 100; // Change the ad break's duration.
GCKAdBreakClipInfo *derivedAdBreakClipInfo = [builder build];

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

GCKAdBreakClipInfoBuilder *builder =
[[GCKAdBreakClipInfoBuilder alloc] initWithAdBreakClipID:...];
builder.title = ...;
builder.contentURL = ...;
builder.contentID = ...;
// Set all other desired propreties...
GCKAdBreakClipInfo *newAdBreakClipInfo = [builder build];
Since
4.3.4

Inherits NSObject.

Instance Method Summary

(instancetype) - initWithAdBreakClipInfo:
 Constructs a new GCKAdBreakClipInfoBuilder with all of the fields of the adBreakClipInfo object. More...
 
(instancetype) - initWithAdBreakClipID:
 Constructs a new GCKAdBreakClipInfoBuilder with the ad break clip ID and all other attributes initialized to default values. More...
 
(instancetype) - init
 
(GCKAdBreakClipInfo *) - build
 Builds a GCKAdBreakClipInfo using the builder's current attributes. More...
 

Property Summary

NSString * adBreakClipID
 A string that uniquely identifies this ad break clip. More...
 
NSTimeInterval duration
 The clip's duration. More...
 
NSString * title
 The clip's title. More...
 
NSURL * clickThroughURL
 The click-through URL for this clip. More...
 
NSURL * contentURL
 URL for the content that represents this clip (typically an image). More...
 
NSString * mimeType
 MIME type of the content referenced by contentURL. More...
 
NSString * contentID
 The content's ID. More...
 
NSURL * posterURL
 The poster URL for this clip. More...
 
NSTimeInterval whenSkippable
 The length of time into the clip when it can be skipped in seconds. More...
 
GCKHLSSegmentFormat hlsSegmentFormat
 The HLS segment format for this clip. More...
 
GCKVASTAdsRequest * vastAdsRequest
 The VAST ad request configuration if any. More...
 
id customData
 Custom application-specific data associated with the clip. More...
 

Method Detail

- (instancetype) initWithAdBreakClipInfo: (GCKAdBreakClipInfo *)  adBreakClipInfo

Constructs a new GCKAdBreakClipInfoBuilder with all of the fields of the adBreakClipInfo object.

Parameters
adBreakClipInfoThe ad break clip info to get the fields from.
- (instancetype) initWithAdBreakClipID: (NSString *)  adBreakClipID

Constructs a new GCKAdBreakClipInfoBuilder with the ad break clip ID and all other attributes initialized to default values.

Parameters
adBreakClipIDThe clip ID of the ad break clip info.
- (GCKAdBreakClipInfo *) build

Builds a GCKAdBreakClipInfo using the builder's current attributes.

Returns
The new GCKAdBreakClipInfo instance.

Property Detail

- (NSString*) adBreakClipID
readwritenonatomiccopy

A string that uniquely identifies this ad break clip.

- (NSTimeInterval) duration
readwritenonatomicassign

The clip's duration.

- (NSString*) title
readwritenonatomiccopy

The clip's title.

- (NSURL*) clickThroughURL
readwritenonatomiccopy

The click-through URL for this clip.

- (NSURL*) contentURL
readwritenonatomiccopy

URL for the content that represents this clip (typically an image).

- (NSString*) mimeType
readwritenonatomiccopy

MIME type of the content referenced by contentURL.

- (NSString*) contentID
readwritenonatomiccopy

The content's ID.

- (NSURL*) posterURL
readwritenonatomiccopy

The poster URL for this clip.

- (NSTimeInterval) whenSkippable
readwritenonatomicassign

The length of time into the clip when it can be skipped in seconds.

- (GCKHLSSegmentFormat) hlsSegmentFormat
readwritenonatomicassign

The HLS segment format for this clip.

- (GCKVASTAdsRequest*) vastAdsRequest
readwritenonatomicassign

The VAST ad request configuration if any.

See more here: Digital Video Ad Serving Template 4.0.

- (id) customData
readwritenonatomicassign

Custom application-specific data associated with the clip.