BCOVVideo Protocol Reference

Conforms to NSObject
Declared in BCOVVideo.h

Overview

A video in the Brightcove Player SDK ecosystem. Brightcove organizes content into entities called videos, which may have zero or more sources containing information specific to accessing the content. The video provides a container for referencing these sources in the aggregate, and a place for metadata about the video or the collection of sources in the form of properties. Also, a video may have a cue point collection, which is a set of cue points that describe specific locations in the video’s content timeline.

  cuePoints required method

The cue points associated to this video. These cue points apply equally to the content at each of this video’s sources.

@property (nonatomic, readonly, copy) BCOVCuePointCollection *cuePoints

Discussion

The cue points associated to this video. These cue points apply equally to the content at each of this video’s sources.

Declared In

BCOVVideo.h

  properties required method

Metadata or properties related to this video or its sources in the aggregate.

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

Discussion

Metadata or properties related to this video or its sources in the aggregate.

Declared In

BCOVVideo.h

  sources required method

The sources which comprise the actual destinations at which this video’s content can be accessed.

@property (nonatomic, readonly, copy) NSArray *sources

Discussion

The sources which comprise the actual destinations at which this video’s content can be accessed.

Declared In

BCOVVideo.h

– update: required method

Returns a modified version of this source. Because BCOVVideo objects are immutable, an entirely new BCOVVideo 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<BCOVMutableVideo> mutableVideo ))updateBlock

Parameters

updateBlock

A block which is passed a mutable copy of this video.

Return Value

The copy of this video modified by updateBlock.

Discussion

Returns a modified version of this source. Because BCOVVideo objects are immutable, an entirely new BCOVVideo 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 video passed to updateBlock, as the behavior of doing this is undefined. Instead, make whatever modifications are necessary in the block and then capture the video object returned from this method.

Declared In

BCOVVideo.h