GCKAdBreakInfoBuilder Class

  • The GCKAdBreakInfoBuilder class is used to construct or modify instances of GCKAdBreakInfo, which represent ad breaks in media content.

  • Developers can use the builder to create new ad break information from scratch or derive it from an existing one by setting properties like ad break ID, playback position, and ad clip IDs.

  • The builder provides properties such as adBreakID, playbackPosition, adBreakClipIDs, watched, embedded, and expanded to define the characteristics of the ad break.

  • By calling the build method on the builder, a GCKAdBreakInfo instance is created with the specified attributes.
Instance Methods | Properties
GCKAdBreakInfoBuilder Class Reference

Overview

A builder object for constructing new or derived GCKAdBreakInfo instances.

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

GCKAdBreakInfoBuilder *builder =
[[GCKAdBreakInfoBuilder alloc] initWithAdBreakInfo:originalAdBreakInfo];
builder.adBreakID = ...; // Change the ad break clip ID.
builder.playbackPosition = 100; // Change the ad break's duration.
GCKAdBreakInfo *derivedAdBreakInfo = [builder build];

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

GCKAdBreakInfoBuilder *builder =
[[GCKAdBreakInfoBuilder alloc] initWithAdBreakID:...];
builder.title = ...;
builder.contentURL = ...;
builder.contentID = ...;
// Set all other desired propreties...
GCKAdBreakInfo *newAdBreakInfo = [builder build];
Since
4.3.4

Inherits NSObject.

Instance Method Summary

(instancetype) - initWithAdBreakInfo:
 
(instancetype) - initWithAdBreakID:adBreakClipIds:
 
(instancetype) - init
 
(GCKAdBreakInfo *) - build
 

Property Summary

NSString * adBreakID
 A string that uniquely identifies this ad break. More...
 
NSTimeInterval playbackPosition
 The playback position, in seconds, at which this ad will start playing. More...
 
NSArray< NSString * > * adBreakClipIDs
 A list of identifier strings for the ad break clips contained by this ad break. More...
 
BOOL watched
 Whether the ad break has already been watched or not. More...
 
BOOL embedded
 Whether the ad break is embedded. More...
 
BOOL expanded
 Whether the ad break is expanded. More...
 

Property Detail

- (NSString*) adBreakID
readwritenonatomiccopy

A string that uniquely identifies this ad break.

- (NSTimeInterval) playbackPosition
readwritenonatomicassign

The playback position, in seconds, at which this ad will start playing.

- (NSArray<NSString *>*) adBreakClipIDs
readwritenonatomiccopy

A list of identifier strings for the ad break clips contained by this ad break.

- (BOOL) watched
readwritenonatomicassign

Whether the ad break has already been watched or not.

- (BOOL) embedded
readwritenonatomicassign

Whether the ad break is embedded.

- (BOOL) expanded
readwritenonatomicassign

Whether the ad break is expanded.