This project provides a starting point for integrating the Brightcove Media API into your application. It provides simple ways to interact with the API, as well as a long list of helper functions.
Please note that the PHP MAPI Wrapper v2.0 is not compatible with any previous versions (when it was known as "Echove"). The class name has been changed, numerous functions have been re-named, and methods have been updated to take advantage of Brightcove API changes.
If you need assistance in determining what changes have been made, please send an e-mail to opensource@brightcove.com with your request.
PHP version 5.2 or greater, or you must have the JavaScript Object Notation (JSON) PECL package. For more information on the JSON PECL package, please visit the PHP JSON package website.
The PHP MAPI Wrapper includes a caching extension. To use this feature, include the file on your page along with the core PHP MAPI Wrapper file.
require('bc-mapi.php');
require('bc-mapi-cache.php');
Then, after instantiating the core class, you can instantiate the caching extension.
// Using flat files
$bc = new BCMAPI(API_READ_TOKEN, API_WRITE_TOKEN);
$bc_cache = new BCMAPICache('file', 600, '/var/www/myWebSite/cache/', '.cache');
// Using Memcached
$bc = new BCMAPI(API_READ_TOKEN, API_WRITE_TOKEN);
$bc_cache = new BCMAPICache('memcached', 600, 'localhost', NULL, 11211);
The parameters for the constructor are:
- [string] The type of caching method to use, either 'file' or 'memcached'
- [int] How many seconds until cache files are considered cold
- [string] The absolute path of the cache directory (file) or host (memcached)
- [string] The file extension for cache items (file only)
- [int] The port to use (Memcached only)
This example shows how to instantiate, or start, the BCMAPI PHP class. The first token, which is for the Read API, is required. The second token is for the Write API and is optional.
// Include the BCMAPI SDK
require('bc-mapi.php');
// Instantiate the class, passing it our Brightcove API tokens (read, then write)
$bc = new BCMAPI(
'READ_API_TOKEN',
'WRITE_API_TOKEN'
);
// You may optionally include the caching extension provided with BCMAPI...
require('bc-mapi-cache.php');
// Using flat files
$bc_cache = new BCMAPICache('file', 600, '/var/www/myWebSite/cache/', '.cache');
// Using Memcached
$bc_cache = new BCMAPICache('memcached', 600, 'localhost', NULL, 11211);
This example shows how to set and retrieve some of the BCMAPI properties that can be used for debugging and additional settings.
// Turn on HTTPS mode
$bc->__set('secure', TRUE);
// Make our API call
$videos = $bc->find('allVideos');
// Determine how many possible results there are
echo 'Total Videos: ' . $bc->total_count . '<br />';
// Make our API call
$videos = $bc->findAll();
// Determine how many times we called the Brightcove API
echo 'API Calls: ' . $bc->__get('api_calls');
This example shows how to change the API URLs for supporting international regions.
// Change our region to Japan
$bc->__set('url_read', 'api.brightcove.co.jp/services/library?');
$bc->__set('url_write', 'api.brightcove.co.jp/services/post');
This example shows how to utilize the built-in error handling in BCMAPI.
// Create a try/catch
try {
// Make our API call
$video = $bc->find('find_video_by_id', 123456789);
} catch(Exception $error) {
// Handle our error
echo $error;
die();
}
This example shows how to retrieve a video from a Brightcove account.
// Make our API call
$video = $bc->find('find_video_by_id', 123456789);
// Print the video name and ID
echo $video->name . ' (' . $video->id . ')';
This example shows how you can use shorthand method names to make code easier to write and read.
// Make our API call
$video = $bc->find('videoById', 123456789);
This example shows how to define additional API call parameters using a key-value array.
// Define our parameters
$params = array(
'id' => 123456789,
'video_fields' => 'video_id,name,shortDescription'
);
// Make our API call
$video = $bc->find('videoById', $params);
Brightcove limits the "find_all_videos" call to 100 results, requiring pagination and numerous API calls. This example shows how to use the findAll() method to do this automatically. WARNING: Use very carefully * // Define our parameters $params = array( 'video_fields' => 'id,name' );
// Make our API call
$videos = $bc->findAll('video', $params);
This example shows how to search for a video about "gates", but not "Bill Gates".
// Define our parameters
$params = array(
'video_fields' => 'id,name,shortDescription'
);
// Set our search terms
$terms = array(
'all' => 'display_name:gates',
'none' => 'display_name:bill'
);
// Make our API call
$videos = $bc->search('video', $terms, $params);
This example shows how to search for a video with "jobs" in the title AND tags.
// Define our parameters
$params = array(
'video_fields' => 'id,name,shortDescription'
);
// Set our search terms
$terms = array(
'all' => 'display_name:jobs,tag:jobs'
);
// Make our API call
$videos = $bc->search('video', $terms, $params);
This example details how to upload a video to a Brightcove account. This code is handling data that was passed from a form. Note that we re-name the uploaded movie to its original name rather than the random string generated when it's placed in the "tmp" directory; this is because the tmp_name does not include the file extension. The video name is a required field.
// Create an array of meta data from our form fields
$metaData = array(
'name' => $_POST['videoName'],
'shortDescription' => $_POST['videoShortDescription']
);
// Move the file out of 'tmp', or rename
rename($_FILES['videoFile']['tmp_name'], '/tmp/' . $_FILES['videoFile']['name']);
$file = '/tmp/' . $_FILES['videoFile']['name'];
// Upload the video and save the video ID
$id = $bc->createMedia('video', $file, $metaData);
This example details how to upload a image to a Brightcove account. This code is handling data that was passed from a form. Note that we re-name the uploaded image to its original name rather than the random string generated when it's placed in the "tmp" directory; this is because the tmp_name does not include the file extension.
// Create an array of meta data from our form fields
$metaData = array(
'type' => 'VIDEO_STILL',
'displayName' => $_POST['imageName']
);
// Move the file out of 'tmp', or rename
rename($_FILES['bcImage']['tmp_name'], '/tmp/' . $_FILES['bcImage']['name']);
$file = '/tmp/' . $_FILES['bcImage']['name'];
// Upload the image, assign to a video, and save the image asset ID
$id = $bc->createImage('video', $file, $metaData, 123456789);
This example shows how to create a playlist in a Brightcove account. The code is handling data that was passed from a form. The name, video IDs, and playlist type are all required fields.
// Take a comma-separated string of video IDs and explode into an array
$videoIds = explode(',', $_POST['playlistVideoIds']);
// Create an array of meta data from our form fields
$metaData = array(
'name' => $_POST['playlistName'],
'shortDescription' => $_POST['playlistShortDescription'],
'videoIds' => $videoIds,
'playlistType' => 'explicit'
);
// Create the playlist and save the playlist ID
$id = $bc->createPlaylist('video', $metaData);
This example shows how to update a video, but the same method will work for a playlist.
// Create an array of the new meta data
$metaData = array(
'id' => 123456789,
'shortDescription' => 'Our new short description.'
);
// Update a video with the new meta data
$bc->update('video', $metaData);
This example shows how to delete a video, but the same method will work for a playlist. Cascaded deletion means that the video will also be removed from all playlists and players.
// Delete a 'video' by ID, and cascade the deletion
$bc->delete('video', 123456789, NULL, TRUE);
This example shows how to determine the status of a video being uploaded to a Brightcove account.
// Retrieve upload status
$status = $bc->getStatus('video', 123456789);
This example shows how to share a video with another Brightcove account. A list of the new video IDs will be returned. Note that sharing must be enabled between the two accounts.
// List the accounts to share the video with
$ids = array(
123456789
);
// Share the videos, and save the new video IDs
$new_ids = $bc->shareMedia('video', 123456789, $ids);
This example shows how to add an asset to a playlist, as well as how to remove an asset from a playlist. You may pass an array of video IDs, or a single video ID.
// Add two videos to a playlist
$bc->addToPlaylist(555555555, array(123456789, 987654321));
// Remove a video from a playlist
$bc->removeFromPlaylist(555555555, 987654321);
This example shows the BCMAPI convenience methods that convert video titles into a search-engine friendly format and video lengths into formatted strings.
// Make our API call
$video = $bc->find('videoById', 123456789);
// Print the SEF video name and formatted duration
echo 'Name: ' . $bc->sef($video->name) . '<br />';
echo 'Duration:' . $bc->time($video->length) . '<br />';
To more seamlessly bridge the Brightcove API into PHP the 'from_date' parameter for the "find_modified_videos" call should be provided as seconds since Epoch (UNIX timestamp) instead of minutes since, as the Brightcove Media API documentation states. You can still pass minutes if you prefer.
// Set timestamp to 7 days ago (in seconds)
$time = time() - 604800;
// Make our API call
$videos = $bc->find('modifiedVideos', $time);
// Set timestamp to 7 days ago (in minutes)
$time = floor((time() - 604800) / 60);
// Make our API call
$videos = $bc->find('modifiedVideos', $time);
This example demonstrates how a tag with a value of "abc=xyz" can easily be parsed into a key-value array pair.
// Make our API call
$video = $bc->find('videoById', 123456789);
// Parse any key=value tags into array
$video->tags = $bc->tags($video->tags);
// Print out each tag
foreach($video->tags as $key => $value)
{
echo $key . ': ' . $value . '<br />';
}
This example shows how to remove all videos that don't contain any of the listed tags.
// Make our API call
$videos = $bc->find('allVideos');
// Remove all videos without specified tags
$videos = $bc->filter($videos, 'published=true,include=true');
The constructor for the BCMAPI class.
token_readThe read API token for the Brightcove account
Default: NULL Type: String
token_writeThe write API token for the Brightcove account
Default: NULL Type: String
api_callsPrivate - The total number of API calls that have been processed
Type: Integer
media_deliveryPrivate - What type of URL to return for UDS assets
Type: String
page_numberPublic - The value of the last 'page_number' return
Type: Integer
page_sizePublic - The value of the last 'page_size' return
Type: Integer
securePrivate - Whether BCMAPI is operating over HTTPS
Type: Boolean
show_noticesPrivate - Whether BCMAPI will send error notices
Type: Boolean
timeout_attemptsPrivate - The number of times to retry a call in case of API timeout
Type: Integer
timeout_delayPrivate - Number of seconds to delay retry attempts
Type: Integer
timeout_retryPrivate - Whether to automatically retry calls that fail due to API timeout
Type: Boolean
token_readPrivate - The read Brightcove token to use
Type: String
token_writePrivate - The write Brightcove token to use
Type: String
total_countPublic - The value of the last 'total_count' return
Type: Integer
Sets a property of the BCMAPI class.
keyThe property to set
Type: String
valueThe new value for the property
Type: Mixed
The new value of the property
Type: Mixed
Retrieves a property of the BCMAPI class.
keyThe property to retrieve
Type: String
The value of the property
Type: Mixed
Formats the request for any API "Find" methods and retrieves the data. The requested call may be written in a shortened version (e.g. "allVideos" or "all_videos" instead of "find_all_videos"). If the call supports get_item_count, it is defaulted to TRUE.
callThe requested API method
Type: String
paramsA key-value array of API parameters, or a single value that matches the default
Default: NULL Type: Mixed
An object containing all API return data
Type: Object
Finds all media assets in account, ignoring pagination. This method should be used with extreme care as accounts with a large library of assets will require a high number of API calls. This could significantly affect performance and may result in additional charges from Brightcove.
typeThe type of object to retrieve
Default: video Type: String
paramsA key-value array of API parameters
Default: NULL Type: Array
An object containing all API return data
Type: Object
Performs a search of video meta data
typeThe type of objects to retrieve
Default: video Type: String
termsThe terms to use for the search
Default: NULL Type: Array
paramsA key-value array of API parameters
Default: NULL Type: Mixed
An object containing all API return data
Type: Object
Uploads a media asset file to Brightcove. When creating an asset from an upload it is suggested that you first move the file out of the temporary directory where PHP placed it and rename the file to it's original name. An asset name and short description are both required; leaving these values blank will cause them to be populated with the current UNIX timestamp. Certain upload settings are not allowed depending upon what default have already been set, and depending on the type of file being uploaded. Setting the incorrect values for these parameters will trigger a notice.
typeThe type of object to upload
Default: video Type: String
fileThe location of the temporary file
Default: NULL Type: String
metaThe media asset information
Type: Array
optionsOptional upload values
Default: NULL Type: Array
The media asset ID
Type: String
Creates a playlist.
typeThe type of playlist to create
Default: video Type: String
metaThe playlist information
Type: Array
The playlist ID
Type: String
Updates a media asset. Only the meta data that has changed needs to be passed along. Be sure to include the asset ID, though.
typeThe type of object to update
Default: video Type: String
metaThe information for the media asset
Type: Array
The new DTO
Type: DTO
Uploads a media image file to Brightcove. When creating an image it is suggested that you first move the file out of the temporary directory where PHP placed it and rename the file to it's original name.
typeThe type of object to upload image for
Default: video Type: String
fileThe location of the temporary file
Default: NULL Type: String
metaThe image information
Type: Array
idThe ID of the media asset to assign the image to
Default: NULL Type: Integer
ref_idThe reference ID of the media asset to assign the image to
Default: NULL Type: String
resizeWhether or not to resize the image on upload
Default: TRUE Type: Boolean
The image asset
Type: Mixed
Uploads a logo overlay file to Brightcove. When creating a logo overlay it is suggested that you first move the file out of the temporary directory where PHP placed it and rename the file to it's original name.
fileThe location of the temporary file
Default: NULL Type: String
metaThe logo overlay information
Type: Array
idThe ID of the media asset to assign the logo overlay to
Default: NULL Type: Integer
ref_idThe reference ID of the media asset to assign the logo overlay to
Default: NULL Type: String
The logo overlay asset
Type: Mixed
Deletes a logo overlay.
idThe ID of the media asset
Default: NULL Type: Integer
ref_idThe reference ID of the media asset
Default: NULL Type: String
optionsOptional values
Default: NULL Type: Array
Deletes a media asset. Either an ID or Reference ID must be passed.
typeThe type of the item to delete
Default: video Type: String
idThe ID of the media asset
Default: NULL Type: Integer
ref_idThe reference ID of the media asset
Default: NULL Type: String
optionsOptional values
Default: NULL Type: Array
Retrieves the status of a media asset upload.
typeThe type of object to check
Default: video Type: String
idThe ID of the media asset
Default: NULL Type: String
ref_idThe reference ID of the media asset
Default: TRUE Type: String
The upload status
Type: String
Shares a media asset with the selected accounts. Sharing must be enabled between the two accounts.
typeThe type of object to share
Default: video Type: String
idThe ID of the media asset
Type: Integer
account_idsAn array of account IDs
Type: Array
acceptWhether the share should be auto accepted
Default: FALSE Type: Boolean
forceWhether the share should overwrite existing copies of the media
Default: FALSE Type: Boolean
The new media asset IDs
Type: Array
Removes assets from a playlist.
playlist_idThe ID of the playlist to modify
Type: Integer
video_idsAn array of video IDs to delete from the playlist
Type: Array
The new playlist DTO
Type: Array
Adds assets to a playlist.
playlist_idThe ID of the playlist to modify
Type: Integer
video_idsAn array of video IDs to add to the playlist
Type: Array
The new playlist DTO
Type: Array
Converts milliseconds to formatted time or seconds.
msThe length of the media asset in milliseconds
Default: Type: Integer
secondsWhether to return only seconds
Default: FALSE Type: Boolean
The formatted length or total seconds of the media asset
Type: Mixed
Parses media asset tags array into a key-value array.
tagsThe tags array from a media asset DTO
Default: Type: Array
implodeReturn array to Brightcove format
Default: FALSE Type: Boolean
A key-value array of tags, or a comma-separated string
Type: Mixed
Removes assets that don't contain the appropriate tags.
videosAll the assets you wish to filter
Default: Type: Array
tagA comma-separated list of tags to filter on
Default: Type: String
The filtered list of assets
Type: Array
Formats a media asset name to be search-engine friendly.
nameThe asset name
Default: Type: String
The search-engine friendly asset name
Type: String
The constructor for the BCMAPICache class.
typeThe type of caching method to use, either 'file' or 'memcached'
Default: file Type: String
timeHow many seconds until cache files are considered cold
Default: 600 Type: Integer
locationThe absolute path of the cache directory (file) or host (memcached)
Default: Type: String
extensionThe file extension for cache items (file only)
Default: .c Type: String
port
Default: 11211 Type: Integer
extensionPublic - The file extension for cache items (file only)
Type: String
locationPublic - The absolute path of the cache directory (file) or host (memcached)
Type: String
memcachedPublic - The Memcached object, if valid
Type: Object
portPublic - The port to use (Memcached only)
Type: Integer
timePublic - How many seconds until cache files are considered cold
Type: Integer
typePublic - The type of caching method to use, either 'file' or 'memcached'
Type: String
This is the most generic error returned from BCMAPI as it is thrown whenever the API returns unexpected data, or an error. The API return data will be included in the error to help you diagnose the problem.
The requested item is no longer supported by Brightcove and/or BCMAPI. Stop using this method as early as possible, as the item could be removed in any future release.
The specified asset does not exist in the Brightcove system. Ensure you're using the correct ID.
An ID has not been passed to the method (usually a "delete" or "share" function). Include the ID parameter to resolve the error.
The file being passed to the function is not supported. Try another file type to resolve the error.
The "find" method being requested is not supported by BCMAPI, or does not exist in the Brightcove API. Remove the method call and check both the BCMAPI and Brightcove API documentation.
The BCMAPI property you are trying to set or retrieve does not exist. Check the BCMAPI documentation.
The DTO type (video, playlist, image, etc) you specified is not allowed for the method. Check both the BCMAPI and Brightcove API documentation.
Please specify one or more search parameters. Verify you are passing the parameters in an array.
The read or write token you provided is not recognized by Brightcove. Verify you are using the correct token.
The API could not be accessed, or the API did not return any data. Verify the server has cURL installed, enabled, and able to retrieve remote data. Verify the Brightcove API is currently available.