BCOVPlayerSDKManager Class Reference

Inherits from NSObject
Declared in BCOVPlayerSDKManager.h

Overview

The Player SDK Manager is a singleton instance that acts as a factory, central registry, and diagnostics center in the Brightcove Player SDK for iOS. After obtaining an instance of the Manager, use it to obtain instances of other objects from the Player SDK ecosystem.

@constant kBCOVSSTextTracksKeySourceTypeM3U8URL

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

Adds methods to BCOVPlayerSDKManager to create FairPlay players and session providers.

Other Methods

+ version

Returns the SDK version.

+ (NSString *)version

Return Value

The SDK version

Discussion

Returns the SDK version.

Declared In

BCOVPlayerSDKManager.h

  sessionID

sessionID is a unique identifier associated with this instance of the application. This identifier is sent along with other analytics data to the Brightcove metrics servers.

@property (nonatomic, readonly, strong) NSString *sessionID

Discussion

sessionID is a unique identifier associated with this instance of the application. This identifier is sent along with other analytics data to the Brightcove metrics servers.

The sessionID can be useful when trying to track down problems with particular playback issues. For example, if you detect playback issues, you can send the sessionID and the video ID to your own error tracking server, and then report those two values to Brightcove service engineers to track down the source of the problem in the server logs.

Declared In

BCOVPlayerSDKManager.h

– createPlaybackController

Creates and returns a playback controller configured with a basic session provider and a default view strategy (equivalent to calling [BCOVPlayerSDKManager createPlaybackControllerWithViewStrategy:nil]).

- (id<BCOVPlaybackController>)createPlaybackController

Return Value

A playback controller.

Discussion

Creates and returns a playback controller configured with a basic session provider and a default view strategy (equivalent to calling [BCOVPlayerSDKManager createPlaybackControllerWithViewStrategy:nil]).

Declared In

BCOVPlayerSDKManager.h

– createPlaybackControllerWithViewStrategy:

Creates and returns a playback controller configured with a basic session provider and the specified view strategy. Passing nil as the view strategy will configure the returned playback controller’s view property as a basic unadorned video view.

- (id<BCOVPlaybackController>)createPlaybackControllerWithViewStrategy:(BCOVPlaybackControllerViewStrategy)viewStrategy

Parameters

viewStrategy

A view strategy that determines the view for the returned playback controller.

Return Value

A playback controller configured with the specified strategy.

Discussion

Creates and returns a playback controller configured with a basic session provider and the specified view strategy. Passing nil as the view strategy will configure the returned playback controller’s view property as a basic unadorned video view.

Declared In

BCOVPlayerSDKManager.h

– createPlaybackControllerWithSessionProvider:viewStrategy:

Creates and returns a playback controller configured with the specified session provider and view strategy.

- (id<BCOVPlaybackController>)createPlaybackControllerWithSessionProvider:(id<BCOVPlaybackSessionProvider>)provider viewStrategy:(BCOVPlaybackControllerViewStrategy)viewStrategy

Parameters

provider

A session provider that vends playback sessions to the returned playback controller.

viewStrategy

A view strategy that determines the view for the returned playback controller.

Return Value

A playback controller configured with the specified parameters.

Discussion

Creates and returns a playback controller configured with the specified session provider and view strategy.

Declared In

BCOVPlayerSDKManager.h

– createBasicSessionProviderWithOptions:

Returns a basic playback session provider with the specified options.

- (id<BCOVPlaybackSessionProvider>)createBasicSessionProviderWithOptions:(BCOVBasicSessionProviderOptions *)options

Parameters

options

The options for the session provider to return.

Return Value

A basic playback session provider configured with the specified options.

Discussion

Returns a basic playback session provider with the specified options.

Declared In

BCOVPlayerSDKManager.h

– defaultControlsViewStrategy

Returns a view strategy that wraps the video view it is given with the default playback controls.

- (BCOVPlaybackControllerViewStrategy)defaultControlsViewStrategy

Return Value

A view strategy block that wraps the video view with stock controls.

Discussion

Returns a view strategy that wraps the video view it is given with the default playback controls.

This view strategy is intended to provide a “stock” set of controls to aid development, testing, and Brightcove code samples.

Declared In

BCOVPlayerSDKManager.h

– registerComponent:

Registers the specified component object with the BCOVPlayerSDKManager. The component should implement the methods in the BCOVComponent protocol. Registering a component “activates it” for use, enabling its functionality.

- (void)registerComponent:(id<BCOVComponent>)component

Parameters

component

The object to be registered with the BCOVPlayerSDKManager.

Discussion

Registers the specified component object with the BCOVPlayerSDKManager. The component should implement the methods in the BCOVComponent protocol. Registering a component “activates it” for use, enabling its functionality.

Declared In

BCOVPlayerSDKManager.h

+ sharedManager

Returns the Player SDK Manager singleton.

+ (BCOVPlayerSDKManager *)sharedManager

Return Value

The Player SDK Manager singleton.

Discussion

Returns the Player SDK Manager singleton.

Declared In

BCOVPlayerSDKManager.h

+ sharedManagerWithOptions:

Returns the Player SDK Manager singleton.

+ (BCOVPlayerSDKManager *)sharedManagerWithOptions:(NSDictionary *)options

Parameters

options

Set to nil. Reserved for future use.

Return Value

The Player SDK Manager singleton.

Discussion

Returns the Player SDK Manager singleton.

Declared In

BCOVPlayerSDKManager.h

BCOVSSAdditions Methods

– createSidecarSubtitlesPlaybackControllerWithViewStrategy:

Creates and returns a new playback controller configured for sidecar subtitles with the specified view strategy.

- (id<BCOVPlaybackController>)createSidecarSubtitlesPlaybackControllerWithViewStrategy:(BCOVPlaybackControllerViewStrategy)viewStrategy

Parameters

viewStrategy

A view strategy that determines the view for the returned playback controller.

Return Value

A new playback controller configured for sidecar subtitles playback sessions.

Discussion

Creates and returns a new playback controller configured for sidecar subtitles with the specified view strategy.

Declared In

BCOVSSComponent.h

– createSidecarSubtitlesSessionProviderWithUpstreamSessionProvider:

Creates and returns a new sidecar subtitle session provider with the specified parameters.

- (id<BCOVPlaybackSessionProvider>)createSidecarSubtitlesSessionProviderWithUpstreamSessionProvider:(id<BCOVPlaybackSessionProvider>)provider

Parameters

provider

Optional upstream session provider.

Return Value

A new session provider with the specified parameters.

Discussion

Creates and returns a new sidecar subtitle session provider with the specified parameters.

Declared In

BCOVSSComponent.h

BCOVSSAdditionsDepricated Methods

– createSidecarSubtitlesSessionProviderWithOptions:

- (id<BCOVPlaybackSessionProvider>)createSidecarSubtitlesSessionProviderWithOptions:(BCOVSSSessionProviderOption *)options

BCOVFPSAdditions Methods

– createFairPlayPlaybackControllerWithAuthorizationProxy:

Creates and returns a FairPlay enabled playback controller. If you are using Video Cloud Dynamic Delivery, a Fairplay application certificate will automatically be retrieved from the BCOVVideo when you play a playlist. You can still supply an application certificate separately by calling BCOVBasicPlaybackController addApplicationCertificate:identifier:.

- (nonnull id<BCOVPlaybackController>)createFairPlayPlaybackControllerWithAuthorizationProxy:(nonnull id<BCOVFPSAuthorizationProxy>)proxy

Parameters

proxy

The BCOVFPSAuthorizationProxy to use for this session provider. Must not be nil.

Return Value

A playback controller.

Discussion

Creates and returns a FairPlay enabled playback controller. If you are using Video Cloud Dynamic Delivery, a Fairplay application certificate will automatically be retrieved from the BCOVVideo when you play a playlist. You can still supply an application certificate separately by calling BCOVBasicPlaybackController addApplicationCertificate:identifier:.

Declared In

BCOVFPSComponent.h

– createFairPlaySessionProviderWithAuthorizationProxy:upstreamSessionProvider:

Creates and returns a FairPlay session provider with the specified parameters. If you are using Video Cloud Dynamic Delivery, a Fairplay application certificate will automatically be retrieved from the BCOVVideo when you play a playlist. You can still supply an application certificate separately by calling BCOVBasicPlaybackController addApplicationCertificate:identifier:.

- (nonnull id<BCOVPlaybackSessionProvider>)createFairPlaySessionProviderWithAuthorizationProxy:(nonnull id<BCOVFPSAuthorizationProxy>)proxy upstreamSessionProvider:(nullable id<BCOVPlaybackSessionProvider>)provider

Parameters

proxy

The BCOVFPSAuthorizationProxy to use for this session provider. Must not be nil.

provider

And upstream session provider to link to. If nil, a BCOVBasicSessionProvider will be used.

Return Value

A session provider.

Discussion

Creates and returns a FairPlay session provider with the specified parameters. If you are using Video Cloud Dynamic Delivery, a Fairplay application certificate will automatically be retrieved from the BCOVVideo when you play a playlist. You can still supply an application certificate separately by calling BCOVBasicPlaybackController addApplicationCertificate:identifier:.

Declared In

BCOVFPSComponent.h

– createFairPlayPlaybackControllerWithApplicationCertificate:authorizationProxy:viewStrategy:

Creates and returns a FairPlay enabled playback controller.

- (nonnull id<BCOVPlaybackController>)createFairPlayPlaybackControllerWithApplicationCertificate:(nullable NSData *)appCert authorizationProxy:(nonnull id<BCOVFPSAuthorizationProxy>)proxy viewStrategy:(nullable BCOVPlaybackControllerViewStrategy)viewStrategy

Parameters

appCert

The Fairplay Application Certificate for this session provider. If using Brightcove FPS Server, this can retrieved by BCOVFPSBrightcoveAuthProxy. Can be nil.

proxy

The BCOVFPSAuthorizationProxy to use for this session provider. Must not be nil.

viewStrategy

The view strategy to use.

Return Value

A playback controller.

Discussion

Creates and returns a FairPlay enabled playback controller.

Declared In

BCOVFPSComponent.h

– createFairPlaySessionProviderWithApplicationCertificate:authorizationProxy:upstreamSessionProvider:

Creates and returns a FairPlay session provider with the specified parameters.

- (nonnull id<BCOVPlaybackSessionProvider>)createFairPlaySessionProviderWithApplicationCertificate:(nullable NSData *)appCert authorizationProxy:(nonnull id<BCOVFPSAuthorizationProxy>)proxy upstreamSessionProvider:(nullable id<BCOVPlaybackSessionProvider>)provider

Parameters

appCert

The FairPlay Application Certificate for this session provider. If using Brightcove FPS Server, this can retrieved by BCOVFPSBrightcoveAuthProxy. Can be nil.

proxy

The BCOVFPSAuthorizationProxy to use for this session provider. Must not be nil.

provider

And upstream session provider to link to. If nil, a BCOVBasicSessionProvider will be used.

Return Value

A session provider.

Discussion

Creates and returns a FairPlay session provider with the specified parameters.

Declared In

BCOVFPSComponent.h