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 *cuePointsDiscussion
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. You can find constants for the keys that this SDK uses with this dictionary near the top of this header file.
@property (nonatomic, readonly, copy) NSDictionary *propertiesDiscussion
Metadata or properties related to this video or its sources in the aggregate. You can find constants for the keys that this SDK uses with this dictionary near the top of this header file.
Declared In
BCOVVideo.h
economics
required method
The economics field that comes from Video Cloud. kBCOVEconomicsAdSupported is the default, and means that the ads should be displayed. kBCOVEconomicsFree means that no ads should be shown during video playback.
@property (nonatomic) BCOVEconomics economicsDiscussion
The economics field that comes from Video Cloud. kBCOVEconomicsAdSupported is the default, and means that the ads should be displayed. kBCOVEconomicsFree means that no ads should be shown during video playback.
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<BCOVSource*> *sourcesDiscussion
The sources which comprise the actual destinations at which this video’s content can be accessed.
Declared In
BCOVVideo.h
thumbnailVTTURL
required method
The URL at which this video’s VTT thumbnails source is available. This value overrides any thumbnails VTT track that the SDK uses from a PAPI response.
@property (nonatomic, readonly, copy, nullable) NSURL *thumbnailVTTURLDiscussion
The URL at which this video’s VTT thumbnails source is available. This value overrides any thumbnails VTT track that the SDK uses from a PAPI response.
The value will be nil if you have not set a value.
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 ))updateBlockParameters
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