BCOVSSConstants Class Reference

Inherits from NSObject
Declared in BrightcovePlayerSDK-Swift.h

  VideoPropertiesKeyTextTracks

\endcode

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

Discussion

\endcode

Declared In

BrightcovePlayerSDK-Swift.h

+ VideoPropertiesKeyTextTracks

+ (NSString *_Nonnull)VideoPropertiesKeyTextTracks

  TextTracksKeySource

The key for the NSString URL to the text track. This key is required. Text track source can be either an M3U8 subtitle playlist or a WebVTT file. WebVTT URLs should have a “.vtt” extension, and M3U8 playlist files should have an “m3u8” extension. If your URL cannot follow this convention, you need to specify the format of the file referenced by your URL with the TextTracksKeySourceType key.

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

Discussion

The key for the NSString URL to the text track. This key is required. Text track source can be either an M3U8 subtitle playlist or a WebVTT file. WebVTT URLs should have a “.vtt” extension, and M3U8 playlist files should have an “m3u8” extension. If your URL cannot follow this convention, you need to specify the format of the file referenced by your URL with the TextTracksKeySourceType key.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeySource

+ (NSString *_Nonnull)TextTracksKeySource

  TextTracksKeySourceLanguage

The key for the NSString language of the text track. This key is required.

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

Discussion

The key for the NSString language of the text track. This key is required.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeySourceLanguage

+ (NSString *_Nonnull)TextTracksKeySourceLanguage

  TextTracksKeyLabel

The key for the NSString name of the text track. This key is required.

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

Discussion

The key for the NSString name of the text track. This key is required.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeyLabel

+ (NSString *_Nonnull)TextTracksKeyLabel

  TextTracksKeyDuration

The key for the NSNumber of Integer value for duration of the text_track. If the text track source is a .vtt file, the duration of the .vtt file is required in order for subtitles to be displayed. If the video and .vtt file were retrieved through BCOVPlaybackService, the plugin will the attempt to use the video properties value keyed by “duration” to satisfy this requirement. If building videos manually, this key is required. If text track is .m3u8, this key will be ignored.

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

Discussion

The key for the NSNumber of Integer value for duration of the text_track. If the text track source is a .vtt file, the duration of the .vtt file is required in order for subtitles to be displayed. If the video and .vtt file were retrieved through BCOVPlaybackService, the plugin will the attempt to use the video properties value keyed by “duration” to satisfy this requirement. If building videos manually, this key is required. If text track is .m3u8, this key will be ignored.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeyDuration

+ (NSString *_Nonnull)TextTracksKeyDuration

  TextTracksKeyDefault

The key for the NSNumber of BOOL that indicates if the text track is the default. This key is optional.

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

Discussion

The key for the NSNumber of BOOL that indicates if the text track is the default. This key is optional.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeyDefault

+ (NSString *_Nonnull)TextTracksKeyDefault

  TextTracksKeyMIMEType

The key for the NSString mime type of the text track. This key is optional.

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

Discussion

The key for the NSString mime type of the text track. This key is optional.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeyMIMEType

+ (NSString *_Nonnull)TextTracksKeyMIMEType

  TextTracksKeyKind

The key for the NSString kind of the text track. This key is required. The value of this key should be either TextTracksKindSubtitles or TextTrackKindCaptions.

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

Discussion

The key for the NSString kind of the text track. This key is required. The value of this key should be either TextTracksKindSubtitles or TextTrackKindCaptions.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeyKind

+ (NSString *_Nonnull)TextTracksKeyKind

  TextTracksKindSubtitles

A text track kind value that indicates that a text track kind is subtitles. Also see TextTracksKeyKind and TextTracksKindCaptions.

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

Discussion

A text track kind value that indicates that a text track kind is subtitles. Also see TextTracksKeyKind and TextTracksKindCaptions.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKindSubtitles

+ (NSString *_Nonnull)TextTracksKindSubtitles

  TextTracksKindCaptions

A text track kind value that indicates that a text track kind is closed captions. Also see TextTracksKeyKind and TextTracksKindSubtitles.

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

Discussion

A text track kind value that indicates that a text track kind is closed captions. Also see TextTracksKeyKind and TextTracksKindSubtitles.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKindCaptions

+ (NSString *_Nonnull)TextTracksKindCaptions

  TextTracksKeySourceType

An NSDictionary key used to specify the type of file referred to by the TextTracksKeySource URL. This NSDictionary key can take one of two values: TracksKeySourceTypeWebVTTURL to indicate that the TracksKeySourceType URL refers to a WebVTT file, or TracksKeySourceTypeM3U8URL to indicate that the TracksKeySourceType URL refers to an M3U8 file. This key/value pair is only necessary if the source URL does not use a “.vtt” or “.m3u8” extension.

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

Discussion

An NSDictionary key used to specify the type of file referred to by the TextTracksKeySource URL. This NSDictionary key can take one of two values: TracksKeySourceTypeWebVTTURL to indicate that the TracksKeySourceType URL refers to a WebVTT file, or TracksKeySourceTypeM3U8URL to indicate that the TracksKeySourceType URL refers to an M3U8 file. This key/value pair is only necessary if the source URL does not use a “.vtt” or “.m3u8” extension.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeySourceType

+ (NSString *_Nonnull)TextTracksKeySourceType

  TextTracksKeySourceTypeWebVTTURL

An NSDictionary value used to indicate that the source URL refers to a WebVTT file. This key/value pair is only necessary if the source URL refers to a WebVTT file, but does not use a “.vtt” extension.

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

Discussion

An NSDictionary value used to indicate that the source URL refers to a WebVTT file. This key/value pair is only necessary if the source URL refers to a WebVTT file, but does not use a “.vtt” extension.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeySourceTypeWebVTTURL

+ (NSString *_Nonnull)TextTracksKeySourceTypeWebVTTURL

  TextTracksKeySourceTypeM3U8URL

An NSDictionary value used to indicate that the source URL refers to an M3U8 file. This key/value pair is only necessary if the source URL refers to an M3U8 file, but does not use an “.m3u8” extension.

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

Discussion

An NSDictionary value used to indicate that the source URL refers to an M3U8 file. This key/value pair is only necessary if the source URL refers to an M3U8 file, but does not use an “.m3u8” extension.

Declared In

BrightcovePlayerSDK-Swift.h

+ TextTracksKeySourceTypeM3U8URL

+ (NSString *_Nonnull)TextTracksKeySourceTypeM3U8URL

– init

- (nonnull instancetype)init