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 *accountId

Discussion

Videocloud Account Id.

Declared In

BCOVPlaybackServiceRequestFactory.h

  policyKey

Videocloud Policy Key

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

Discussion

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 *additionalHTTPRequestHeaders

Discussion

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 *)policyKey

Parameters

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 *)baseURLStr

Parameters

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 *)authBaseURLStr

Parameters

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

– requestForPlaylistWithPlaylistID:parameters:

Constructs a request for a playlist by the playlist id.

- (NSURLRequest *)requestForPlaylistWithPlaylistID:(NSString *)playlistId parameters:(NSDictionary *)parameters

Parameters

playlistId

Id of the playlist to request.
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 by the playlist id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForPlaylistWithPlaylistID:authToken:parameters:

Constructs a request for a playlist by the playlist id.

- (NSURLRequest *)requestForPlaylistWithPlaylistID:(NSString *)playlistId authToken:(NSString *)authToken parameters:(NSDictionary *)parameters

Parameters

playlistId

Id of the playlist to request.
authToken

The authorization token with which to validate the video’s license
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 by the playlist id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForPlaylistWithReferenceID:parameters:

Constructs a request for a playlist by the reference id.

- (NSURLRequest *)requestForPlaylistWithReferenceID:(NSString *)referenceId parameters:(NSDictionary *)parameters

Parameters

referenceId

Reference id of the playlist to request.
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 by the reference id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForPlaylistWithReferenceID:authToken:parameters:

Constructs a request for a playlist by the reference id.

- (NSURLRequest *)requestForPlaylistWithReferenceID:(NSString *)referenceId authToken:(NSString *)authToken parameters:(NSDictionary *)parameters

Parameters

referenceId

Reference id of the playlist to request.
authToken

The authorization token with which to validate the video’s license
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 by the reference id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForVideoWithVideoID:parameters:

Constructs a request for a video by the video id.

- (NSURLRequest *)requestForVideoWithVideoID:(NSString *)videoId parameters:(NSDictionary *)parameters

Parameters

videoId

Id of the video to request.
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 video.

Discussion

Constructs a request for a video by the video id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForVideoWithVideoID:authToken:parameters:

Constructs a request for a video by the video id.

- (NSURLRequest *)requestForVideoWithVideoID:(NSString *)videoId authToken:(NSString *)authToken parameters:(NSDictionary *)parameters

Parameters

videoId

Id of the video to request.
authToken

The authorization token with which to validate the video’s license
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 video.

Discussion

Constructs a request for a video by the video id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForVideoWithReferenceID:parameters:

Constructs a request for a video by the reference id.

- (NSURLRequest *)requestForVideoWithReferenceID:(NSString *)referenceId parameters:(NSDictionary *)parameters

Parameters

referenceId

Reference id of the video to request.
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 video.

Discussion

Constructs a request for a video by the reference id.

Declared In

BCOVPlaybackServiceRequestFactory.h

– requestForVideoWithReferenceID:authToken:parameters:

Constructs a request for a video by the reference id.

- (NSURLRequest *)requestForVideoWithReferenceID:(NSString *)referenceId authToken:(NSString *)authToken parameters:(NSDictionary *)parameters

Parameters

referenceId

Reference id of the video to request.
authToken

The authorization token with which to validate the video’s license
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 video.

Discussion

Constructs a request for a video by the reference id.

Declared In

BCOVPlaybackServiceRequestFactory.h