BCOVPlaybackService Class Reference

Inherits from NSObject
Declared in BrightcovePlayerSDK-Swift.h

Overview

The BCOVPlaybackService class provides asynchronous methods for retrieving information about videos from Brightcove’s Playback API.

  ErrorDomain

Error domain for BCOVPlaybackService.

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

Discussion

Error domain for BCOVPlaybackService.

Declared In

BrightcovePlayerSDK-Swift.h

+ ErrorDomain

+ (NSString *_Nonnull)ErrorDomain

  ErrorKeyRawResponseData

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceErrorCode.JSONDeserializationError. This is the raw response data. This may not exist in error.userInfo.

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

Discussion

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceErrorCode.JSONDeserializationError. This is the raw response data. This may not exist in error.userInfo.

Declared In

BrightcovePlayerSDK-Swift.h

+ ErrorKeyRawResponseData

+ (NSString *_Nonnull)ErrorKeyRawResponseData

  ErrorKeyAPIErrors

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceError.CodeAPIError. This is an NSArray of errors returned by the Playback API.

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

Discussion

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceError.CodeAPIError. This is an NSArray of errors returned by the Playback API.

Declared In

BrightcovePlayerSDK-Swift.h

+ ErrorKeyAPIErrors

+ (NSString *_Nonnull)ErrorKeyAPIErrors

  ErrorKeyAPIHTTPStatusCode

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceErrorCode.APIError. This is the HTTP status code returned by the API request.

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

Discussion

Key for NSError.userInfo for errors with domain BCOVPlaybackService.ErrorDomain and errorCode BCOVPlaybackServiceErrorCode.APIError. This is the HTTP status code returned by the API request.

Declared In

BrightcovePlayerSDK-Swift.h

+ ErrorKeyAPIHTTPStatusCode

+ (NSString *_Nonnull)ErrorKeyAPIHTTPStatusCode

  ParameterKeyLimit

\endcode

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

Discussion

\endcode

Declared In

BrightcovePlayerSDK-Swift.h

+ ParameterKeyLimit

+ (NSString *_Nonnull)ParameterKeyLimit

  ParameterKeyOffset

\endcode

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

Discussion

\endcode

Declared In

BrightcovePlayerSDK-Swift.h

+ ParameterKeyOffset

+ (NSString *_Nonnull)ParameterKeyOffset

  ParamaterKeyAdConfigId

Parameter dictionary key for BCOVPlaybackService methods that return a playlist or video. This key sets the SSAI ad config ID. This constant can be used in place of the string value “ad_config_id”.

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

Discussion

Parameter dictionary key for BCOVPlaybackService methods that return a playlist or video. This key sets the SSAI ad config ID. This constant can be used in place of the string value “ad_config_id”.

Declared In

BrightcovePlayerSDK-Swift.h

+ ParamaterKeyAdConfigId

+ (NSString *_Nonnull)ParamaterKeyAdConfigId

  ParameterKeyDeliveryConfigId

Parameter dictionary key for BCOVPlaybackService methods that return a playlist or video. This key enables Dynamic Delivery Rules for just-in-time manifest generation. This constant can be used in place of the string value “config_id”.

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

Discussion

Parameter dictionary key for BCOVPlaybackService methods that return a playlist or video. This key enables Dynamic Delivery Rules for just-in-time manifest generation. This constant can be used in place of the string value “config_id”.

Declared In

BrightcovePlayerSDK-Swift.h

+ ParameterKeyDeliveryConfigId

+ (NSString *_Nonnull)ParameterKeyDeliveryConfigId

  ConfigurationKeyAssetID

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a playlist using a playlist ID or a video using a video ID. Takes presedence over ConfigurationKeyAssetReferenceID if these keys are used together.

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

Discussion

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a playlist using a playlist ID or a video using a video ID. Takes presedence over ConfigurationKeyAssetReferenceID if these keys are used together.

Declared In

BrightcovePlayerSDK-Swift.h

+ ConfigurationKeyAssetID

+ (NSString *_Nonnull)ConfigurationKeyAssetID

  ConfigurationKeyAssetReferenceID

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a playlist using a playlist reference ID or a video using a video reference ID. Is ignored in favor of ConfigurationKeyAssetID if these keys are used together.

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

Discussion

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a playlist using a playlist reference ID or a video using a video reference ID. Is ignored in favor of ConfigurationKeyAssetID if these keys are used together.

Declared In

BrightcovePlayerSDK-Swift.h

+ ConfigurationKeyAssetReferenceID

+ (NSString *_Nonnull)ConfigurationKeyAssetReferenceID

  ConfigurationKeyAuthToken

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a video or playlist using an auth token.

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

Discussion

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a video or playlist using an auth token.

Declared In

BrightcovePlayerSDK-Swift.h

+ ConfigurationKeyAuthToken

+ (NSString *_Nonnull)ConfigurationKeyAuthToken

  ConfigurationKeyBumperID

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a bumper video for video or playlist using a video ID. Takes presedence over ConfigurationKeyBumperReferenceID if these keys are used together.

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

Discussion

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a bumper video for video or playlist using a video ID. Takes presedence over ConfigurationKeyBumperReferenceID if these keys are used together.

Declared In

BrightcovePlayerSDK-Swift.h

+ ConfigurationKeyBumperID

+ (NSString *_Nonnull)ConfigurationKeyBumperID

  ConfigurationKeyBumperReferenceID

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a bumper video for video or playlist using a video reference ID. Is ignored in favor of ConfigurationKeyBumperID if these keys are used together.

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

Discussion

Configuration dictionary key for BCOVPlaybackService’s findVideoWithConfiguration:parameters:completion: and findPlaylistWithConfiguration:parameters:completion: methods. The value for this key will be used to fetch a bumper video for video or playlist using a video reference ID. Is ignored in favor of ConfigurationKeyBumperID if these keys are used together.

Declared In

BrightcovePlayerSDK-Swift.h

+ ConfigurationKeyBumperReferenceID

+ (NSString *_Nonnull)ConfigurationKeyBumperReferenceID

  sharedURLSession

NSURLSession shared across all network calls to the BCOVPlaybackService. This object is created when the Playback Service is initialized. If you wish to use your own NSURLSession you can set it here. If set to nil, the default NSURLSession will be re-created.

@property (nonatomic, strong) NSURLSession *sharedURLSession

Discussion

NSURLSession shared across all network calls to the BCOVPlaybackService. This object is created when the Playback Service is initialized. If you wish to use your own NSURLSession you can set it here. If set to nil, the default NSURLSession will be re-created.

Declared In

BrightcovePlayerSDK-Swift.h

  watermarkingToken

The watermarking token for use with Forensic Watermarking

@property (nonatomic, copy) NSString *watermarkingToken

Discussion

The watermarking token for use with Forensic Watermarking

Declared In

BrightcovePlayerSDK-Swift.h

– initWithAccountId:policyKey:

returns: An initialized instance.

- (nonnull instancetype)initWithAccountId:(NSString *_Nonnull)accountId policyKey:(NSString *_Nullable)policyKey

Discussion

returns: An initialized instance.

Declared In

BrightcovePlayerSDK-Swift.h

– initWithRequestFactory:

returns: An initialized instance.

- (nonnull instancetype)initWithRequestFactory:(BCOVPlaybackServiceRequestFactory *_Nonnull)requestFactory

Discussion

returns: An initialized instance.

Declared In

BrightcovePlayerSDK-Swift.h

– findPlaylistWithConfiguration:queryParameters:completion:

- (void)findPlaylistWithConfiguration:(NSDictionary<NSString*,id> *_Nonnull)configuration queryParameters:(NSDictionary<NSString*,id> *_Nullable)queryParameters completion:(void ( ^ _Nonnull ) ( BCOVPlaylist *_Nullable , id _Nullable , NSError *_Nullable ))completion

– findVideoWithConfiguration:queryParameters:completion:

- (void)findVideoWithConfiguration:(NSDictionary<NSString*,id> *_Nonnull)configuration queryParameters:(NSDictionary<NSString*,id> *_Nullable)queryParameters completion:(void ( ^ _Nonnull ) ( BCOVVideo *_Nullable , id _Nullable , NSError *_Nullable ))completion

+ sourceFromJSONDictionary:

returns: The initialized source.

+ (BCOVSource *_Nullable)sourceFromJSONDictionary:(id _Nullable)json

Discussion

returns: The initialized source.

Declared In

BrightcovePlayerSDK-Swift.h

+ cuePointFromJSONDictionary:

returns: The initialized cue point.

+ (BCOVCuePoint *_Nullable)cuePointFromJSONDictionary:(NSDictionary<NSString*,id> *_Nonnull)json

Discussion

returns: The initialized cue point.

Declared In

BrightcovePlayerSDK-Swift.h

+ playlistFromJSONDictionary:

returns: The initialized playlist.

+ (BCOVPlaylist *_Nullable)playlistFromJSONDictionary:(id _Nonnull)json

Discussion

returns: The initialized playlist.

Declared In

BrightcovePlayerSDK-Swift.h

+ videoFromJSONDictionary:

returns: The initialized video.

+ (BCOVVideo *_Nullable)videoFromJSONDictionary:(id _Nonnull)json

Discussion

returns: The initialized video.

Declared In

BrightcovePlayerSDK-Swift.h

– init

- (nonnull instancetype)init

+ new

+ (nonnull instancetype)new