BCOVCuePoint Protocol Reference

Conforms to NSObject
Declared in BCOVCuePoint.h

Overview

Value class representing a cue point in the Brightcove Player SDK ecosystem. A cue point is used to specify a position on the timeline of a piece of content that can be used for any purpose (often for programmatic control over when advertisements should be shown). When playback reaches a cue point, the playback session sends an event on its cuePoints signal that includes the BCOVCuePoint value.

  position required method

The time at which the cue point occurs on the timeline of the BCOVVideo which owns it.

@property (nonatomic, readonly, assign) CMTime position

Discussion

The time at which the cue point occurs on the timeline of the BCOVVideo which owns it.

Declared In

BCOVCuePoint.h

  type required method

An identifier for the kind of this cue point. There is no predetermined enumeration of values for this property. The value to use may be required by certain Brightcove Player SDK for iOS plugins, or it can be used for some other client-specific purpose. The core SDK does not use this value.

@property (nonatomic, readonly, copy) NSString *type

Discussion

An identifier for the kind of this cue point. There is no predetermined enumeration of values for this property. The value to use may be required by certain Brightcove Player SDK for iOS plugins, or it can be used for some other client-specific purpose. The core SDK does not use this value.

Declared In

BCOVCuePoint.h

  properties required method

Additional properties of the cue point. The keys and values are unspecified, specific keys or values may be required by certain Brightcove Player SDK for iOS plugins, or it can be used for some other client-specific purpose. The core SDK does not use this value.

@property (nonatomic, readonly, copy) NSDictionary *properties

Discussion

Additional properties of the cue point. The keys and values are unspecified, specific keys or values may be required by certain Brightcove Player SDK for iOS plugins, or it can be used for some other client-specific purpose. The core SDK does not use this value.

Declared In

BCOVCuePoint.h

– update: required method

Returns a modified version of this cue point. Because BCOVCuePoint objects are immutable, an entirely new BCOVCuePoint must be created even if only a single change is needed. Therefore, this method provides a convenient way to obtain a temporary mutable copy of this instance and modify it (within updateBlock).

- (instancetype)update:(void ( ^ ) ( id<BCOVMutableCuePoint> mutableCuePoint ))updateBlock

Parameters

updateBlock

A block which is passed a mutable copy of this cue point.

Return Value

The copy of this cue point modified by updateBlock.

Discussion

Returns a modified version of this cue point. Because BCOVCuePoint objects are immutable, an entirely new BCOVCuePoint must be created even if only a single change is needed. Therefore, this method provides a convenient way to obtain a temporary mutable copy of this instance and modify it (within updateBlock).

Do not attempt to save a reference to the mutable cue point passed to updateBlock, as the behavior of doing this is undefined. Instead, make whatever modifications are necessary in the block and then capture the cue point object returned from this method.

Declared In

BCOVCuePoint.h