BCOVVideo Class Reference

Inherits from	NSObject
Conforms to	BCOVVideoProtocol NSCopying NSMutableCopying
Declared in	BrightcovePlayerSDK-Swift.h

`PropertyKeyAccountId`

The properties dictionary on a BCOVVideo object can contain any of the following keys. These can be used when manually initializing a BCOVVideo, like initWithSource:cuePoints:properties

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyAccountId

Discussion

The properties dictionary on a BCOVVideo object can contain any of the following keys. These can be used when manually initializing a BCOVVideo, like initWithSource:cuePoints:properties

Declared In

BrightcovePlayerSDK-Swift.h

`+ PropertyKeyAccountId`

+ (NSString *_Nonnull)PropertyKeyAccountId

`PropertyKeyDescription`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyDescription

`+ PropertyKeyDescription`

+ (NSString *_Nonnull)PropertyKeyDescription

`PropertyKeyDuration`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyDuration

`+ PropertyKeyDuration`

+ (NSString *_Nonnull)PropertyKeyDuration

`PropertyKeyEconomics`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyEconomics

`+ PropertyKeyEconomics`

+ (NSString *_Nonnull)PropertyKeyEconomics

`PropertyKeyId`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyId

`PropertyKeyLongDescription`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyLongDescription

`+ PropertyKeyLongDescription`

+ (NSString *_Nonnull)PropertyKeyLongDescription

`PropertyKeyName`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyName

`PropertyKeyPoster`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyPoster

`+ PropertyKeyPoster`

+ (NSString *_Nonnull)PropertyKeyPoster

`PropertyKeyPosterSources`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyPosterSources

`+ PropertyKeyPosterSources`

+ (NSString *_Nonnull)PropertyKeyPosterSources

`PropertyKeyProjection`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyProjection

`+ PropertyKeyProjection`

+ (NSString *_Nonnull)PropertyKeyProjection

`PropertyKeyReferenceId`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyReferenceId

`+ PropertyKeyReferenceId`

+ (NSString *_Nonnull)PropertyKeyReferenceId

`PropertyKeyTags`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyTags

`PropertyKeyTextTracks`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyTextTracks

`+ PropertyKeyTextTracks`

+ (NSString *_Nonnull)PropertyKeyTextTracks

`PropertyKeyThumbnail`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyThumbnail

`+ PropertyKeyThumbnail`

+ (NSString *_Nonnull)PropertyKeyThumbnail

`PropertyKeyThumbnailSources`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyThumbnailSources

`+ PropertyKeyThumbnailSources`

+ (NSString *_Nonnull)PropertyKeyThumbnailSources

`PropertyKeyVariants`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyVariants

`+ PropertyKeyVariants`

+ (NSString *_Nonnull)PropertyKeyVariants

`PropertyKeyManifestURLTTL`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyManifestURLTTL

`+ PropertyKeyManifestURLTTL`

+ (NSString *_Nonnull)PropertyKeyManifestURLTTL

`PropertyKeyPolicyKey`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyPolicyKey

`+ PropertyKeyPolicyKey`

+ (NSString *_Nonnull)PropertyKeyPolicyKey

`PropertyKeyCatalogResponseTime`

@property (nonatomic, class, readonly, copy) NSString *PropertyKeyCatalogResponseTime

`+ PropertyKeyCatalogResponseTime`

+ (NSString *_Nonnull)PropertyKeyCatalogResponseTime

`cuePoints`

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, strong) 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

BrightcovePlayerSDK-Swift.h

`properties`

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 class definition.

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

Discussion

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 class definition.

Declared In

BrightcovePlayerSDK-Swift.h

`sources`

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

@property (nonatomic, readonly, copy) NSArray<BCOVSource*> *sources

Discussion

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

Declared In

BrightcovePlayerSDK-Swift.h

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.

@property (nonatomic, readonly, copy) NSURL *thumbnailVTTURL

Discussion

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

BrightcovePlayerSDK-Swift.h

`economics`

The economics field that comes from Video Cloud. BCOVEconomics.AdSupported is the default, and means that the ads should be displayed. BCOVEconomics.Free means that no ads should be shown during video playback.

@property (nonatomic) enum BCOVEconomics economics

Discussion

The economics field that comes from Video Cloud. BCOVEconomics.AdSupported is the default, and means that the ads should be displayed. BCOVEconomics.Free means that no ads should be shown during video playback.

Declared In

BrightcovePlayerSDK-Swift.h

`canBeDownloaded`

Returns true if this video object can be downloaded for offline playback

@property (nonatomic, readonly) BOOL canBeDownloaded

Discussion

Returns true if this video object can be downloaded for offline playback

Declared In

BrightcovePlayerSDK-Swift.h

`usesFairPlay`

Returns YES if this video object has a source using FairPlay encryption This applies to videos retrieved from Dynamic Delivery accounts only.

@property (nonatomic, readonly) BOOL usesFairPlay

Discussion

Returns YES if this video object has a source using FairPlay encryption This applies to videos retrieved from Dynamic Delivery accounts only.

Declared In

BrightcovePlayerSDK-Swift.h

`offline`

Returns YES if this instance refers to an offline video. Use the playableOffline property to determine if the video is playable offline.

@property (nonatomic, readonly) BOOL offline

Discussion

Returns YES if this instance refers to an offline video. Use the playableOffline property to determine if the video is playable offline.

Declared In

BrightcovePlayerSDK-Swift.h

`playableOffline`

Returns false if the video has not completed downloading, or if the video has been purged and needs to be re-downloaded. This happens automatically if iOS needs to reclaim storage space for proper functioning of the device. On some versions of iOS playableOffline may return false if the offline video is already loaded up in an instance of AVPlayer. Calling removeAllItems on the current instance of AVQueuePlayer prior to checking should result in the expected value of true being returned.

@property (nonatomic, readonly) BOOL playableOffline

Discussion

Returns false if the video has not completed downloading, or if the video has been purged and needs to be re-downloaded. This happens automatically if iOS needs to reclaim storage space for proper functioning of the device. On some versions of iOS playableOffline may return false if the offline video is already loaded up in an instance of AVPlayer. Calling removeAllItems on the current instance of AVQueuePlayer prior to checking should result in the expected value of true being returned.

Declared In

BrightcovePlayerSDK-Swift.h

`errorCode`

A string representation of an error code for an unplayable video

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

Discussion

A string representation of an error code for an unplayable video

Declared In

BrightcovePlayerSDK-Swift.h

`errorSubCode`

A string representation of an error sub code for an unplayable video

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

Discussion

A string representation of an error sub code for an unplayable video

Declared In

BrightcovePlayerSDK-Swift.h

`errorMessage`

A error emssage string for an unplayable video

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

Discussion

A error emssage string for an unplayable video

Declared In

BrightcovePlayerSDK-Swift.h

`hasError`

Returns false if errorCode, errorSubCode and errorMessage are all nil otherwise if any of those properties have a vaile will return true

@property (nonatomic, readonly) BOOL hasError

Discussion

Returns false if errorCode, errorSubCode and errorMessage are all nil otherwise if any of those properties have a vaile will return true

Declared In

BrightcovePlayerSDK-Swift.h

`– initWithSources:cuePoints:properties:`

returns: A new video with the specified sources, cue points, and properties.

- (nonnull instancetype)initWithSources:(NSArray<BCOVSource*> *_Nullable)sources cuePoints:(BCOVCuePointCollection *_Nullable)cuePoints properties:(NSDictionary *_Nullable)properties

Discussion

returns: A new video with the specified sources, cue points, and properties.

Declared In

BrightcovePlayerSDK-Swift.h

`– initWithSource:cuePoints:properties:`

returns: A new video with a single source, as well as the specified cue points and properties.

- (nonnull instancetype)initWithSource:(BCOVSource *_Nullable)source cuePoints:(BCOVCuePointCollection *_Nullable)cuePoints properties:(NSDictionary *_Nullable)properties

Discussion

returns: A new video with a single source, as well as the specified cue points and properties.

Declared In

BrightcovePlayerSDK-Swift.h

`– initWithErrorCode:errorSubCode:errorMessage:properties:`

returns: A new video with error information attributes

- (nonnull instancetype)initWithErrorCode:(NSString *_Nullable)errorCode errorSubCode:(NSString *_Nullable)errorSubCode errorMessage:(NSString *_Nullable)errorMessage properties:(NSDictionary *_Nullable)properties

Discussion

returns: A new video with error information attributes

Declared In

BrightcovePlayerSDK-Swift.h

`– isEqualToVideo:`

returns: Whether video is equivalent to this instance.

- (BOOL)isEqualToVideo:(BCOVVideo *_Nullable)video

Discussion

returns: Whether video is equivalent to this instance.