BCOVPlaybackServiceRequestFactory Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | BCOVPlaybackServiceRequestFactory.h |
Overview
The BCOVPlaybackServiceRequestFactory class provides methods for creating requests for videos from Brightcove’s Playback API.
accountId
Videocloud Account Id.
@property (nonatomic, copy, readonly) NSString *accountIdDiscussion
Videocloud Account Id.
Declared In
BCOVPlaybackServiceRequestFactory.h
policyKey
Videocloud Policy Key
@property (nonatomic, copy, readonly) NSString *policyKeyDiscussion
Videocloud Policy Key
Declared In
BCOVPlaybackServiceRequestFactory.h
additionalHTTPRequestHeaders
NSDictionary of additional HTTP request headers set on each NSURLRequest. The dictionary key defines the header field name. Header field names are case-insensitive. Both keys and values should be NSStrings. Defaults to nil.
@property (nonatomic, copy, readwrite) NSDictionary *additionalHTTPRequestHeadersDiscussion
NSDictionary of additional HTTP request headers set on each NSURLRequest. The dictionary key defines the header field name. Header field names are case-insensitive. Both keys and values should be NSStrings. Defaults to nil.
Declared In
BCOVPlaybackServiceRequestFactory.h
– initWithAccountId:policyKey:
Returns an initialized instance with the specified policy. The base URL string used by the returned instance is https://edge.api.brightcove.com/playback/v1 .
- (instancetype)initWithAccountId:(NSString *)accountId policyKey:(NSString *)policyKeyParameters
accountId |
A Video Cloud account. Must not be nil. |
|---|---|
policyKey |
A Video Cloud CMS policy. Must not be nil. |
Return Value
The initialized BCOVPlaybackServiceRequestFactory.
Discussion
Returns an initialized instance with the specified policy. The base URL string used by the returned instance is https://edge.api.brightcove.com/playback/v1 .
If using the Edge Playback Service, the policyKey value should be nil
Declared In
BCOVPlaybackServiceRequestFactory.h
– initWithAccountId:policyKey:baseURLStr:
Returns an initialized instance with the specified token, account, and base URL string.
- (instancetype)initWithAccountId:(NSString *)accountId policyKey:(NSString *)policyKey baseURLStr:(NSString *)baseURLStrParameters
accountId |
A Video Cloud account. |
|---|---|
policyKey |
A Video Cloud CMS policy. |
baseURLStr |
A string URL to the API. |
Return Value
The initialized BCOVPlaybackServiceRequestFactory.
Discussion
Returns an initialized instance with the specified token, account, and base URL string.
If using the Edge Playback Service, the policyKey value should be nil
Declared In
BCOVPlaybackServiceRequestFactory.h
– initWithAccountId:policyKey:baseURLStr:authBaseURLStr:
Returns an initialized instance with the specified token, account, and base URL string.
- (instancetype)initWithAccountId:(NSString *)accountId policyKey:(NSString *)policyKey baseURLStr:(NSString *)baseURLStr authBaseURLStr:(NSString *)authBaseURLStrParameters
accountId |
A Video Cloud account. |
|---|---|
policyKey |
A Video Cloud CMS policy. |
baseURLStr |
A string URL to the API. |
authBaseURLStr |
A string URL to the API that will be used for EPA/PAS requests. |
Return Value
The initialized BCOVPlaybackServiceRequestFactory.
Discussion
Returns an initialized instance with the specified token, account, and base URL string.
If using the Edge Playback Service, the policyKey value should be nil
Declared In
BCOVPlaybackServiceRequestFactory.h
– initWithAccountId:policyKey:baseURLStr:authBaseURLStr:gscBaseURLStr:
Returns an initialized instance with the specified token, account, and base URL string.
- (instancetype)initWithAccountId:(NSString *)accountId policyKey:(NSString *)policyKey baseURLStr:(NSString *)baseURLStr authBaseURLStr:(NSString *)authBaseURLStr gscBaseURLStr:(NSString *)gscBaseURLStrParameters
accountId |
A Video Cloud account. |
|---|---|
policyKey |
A Video Cloud CMS policy. |
baseURLStr |
A string URL to the API. |
authBaseURLStr |
A string URL to the API that will be used for EPA/PAS requests. |
gscBaseURLStr |
A String URL to the API that will be used for Generic Stream Concurrency requests. |
Return Value
The initialized BCOVPlaybackServiceRequestFactory.
Discussion
Returns an initialized instance with the specified token, account, and base URL string.
If using the Edge Playback Service, the policyKey value should be nil
Declared In
BCOVPlaybackServiceRequestFactory.h
– requestForPlaylistWithConfiguration:parameters:
Constructs a request for a playlist.
- (NSURLRequest *)requestForPlaylistWithConfiguration:(NSDictionary *)configuration parameters:(NSDictionary *)parametersParameters
configuration |
NSDictionary of configuration options used in this catalog request. Valid parameters are: kBCOVPlaybackServiceConfigurationKeyPlaylistID kBCOVPlaybackServiceConfigurationKeyPlaylistReferenceID kBCOVPlaybackServiceConfigurationKeyAuthToken kBCOVPlaybackServiceConfigurationKeyBumperID |
|---|---|
parameters |
parameters that will be added as URL parameters to the request. These parameters will override any default parameters that had been set. |
Return Value
Built NSURLRequest that can be used to fetch the playlist.
Discussion
Constructs a request for a playlist.
Declared In
BCOVPlaybackServiceRequestFactory.h
– requestForVideoWithConfiguration:parameters:
Constructs a request for a video.
- (NSURLRequest *)requestForVideoWithConfiguration:(NSDictionary *)configuration parameters:(NSDictionary *)parametersParameters
configuration |
NSDictionary of configuration options used in this catalog request. Valid parameters are: kBCOVPlaybackServiceConfigurationKeyVideoID kBCOVPlaybackServiceConfigurationKeyVideoReferenceID kBCOVPlaybackServiceConfigurationKeyAuthToken kBCOVPlaybackServiceConfigurationKeyBumperID |
|---|---|
parameters |
parameters that will be added as URL parameters to the request. These parameters will override any default parameters that had been set. |
Return Value
Built NSURLRequest that can be used to fetch the playlist.
Discussion
Constructs a request for a video.
Declared In
BCOVPlaybackServiceRequestFactory.h