The Media API includes these modules:
In addition, this reference describes the following related objects:
For reference information about the objects returned by or passed into the Media API, see the Media Object Reference.
Brightcove Media APIs, providing read access to the videos in a publisher's media library using HTTP calls.
find_all_videos(token:String, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Find all videos in the Brightcove media library for this account.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The field by which to sort the results. A SortByType: One of PUBLISH_DATE, CREATION_DATE, MODIFIED_DATE, PLAYS_TOTAL, PLAYS_TRAILING_WEEK. |
| sort_order (optional) | SortOrderType | How to order the results: ascending (ASC) or descending (DESC). |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | A collection of videos matching the specified search criteria. |
Get all videos sorted by most popular: http://api.brightcove.com/services/library?command=find_all_videos&sort_by=plays_total&sort_order=DESC&token=[token] Get the names and id's of recently published videos: http://api.brightcove.com/services/library?command=find_all_videos&sort_by=publish_date&video_fields=name,id&token=[token] Get the 5 most popular videos from the last 7 days (starting yesterday): http://api.brightcove.com/services/library?command=find_all_videos&sort_by=plays_trailing_week&page_size=5&sort_order=DESC&token=[token]
find_video_by_id(token:String, video_id:long, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):Video
Finds a single video with the specified id.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| video_id | long | The id of the video you would like to retrieve. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| Video | The Video you requested, with the specified fields populated, or null, if there is no video with that id. |
Get the video with the specified id: http://api.brightcove.com/services/library?command=find_video_by_id&video_id=123&token=[token] Get the long description of the video with a given id: http://api.brightcove.com/services/library?command=find_video_by_id&video_id=123&video_fields=longDescription&token=[token]
find_related_videos(token:String, video_id:Long, reference_id:String, page_size:Integer, page_number:Integer, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Finds videos related to the given video. Combines the name and short description of the given video and searches for any partial matches in the name, description, and tags of all videos in the Brightcove media library for this account. More precise ways of finding related videos include tagging your videos by subject and using the find_videos_by_tags method to find videos that share the same tags: or creating a playlist that includes videos that you know are related.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| video_id (optional) | Long | The id of the video we'd like related videos for. |
| reference_id (optional) | String | The publisher-assigned reference id of the video we'd like related videos for. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | A collection of videos, ordered by relevance to the provided video. |
Show total number of related videos to video of given id and display first 3 http://api.brightcove.com/services/library?command=find_related_videos&video_id=123&page_size=3&get_item_count=true&token=[token] Get the names of related videos 6-10 (page 2) http://api.brightcove.com/services/library?command=find_related_videos&video_id=123&page_size=5&page_number=1&video_fields=name&token=[token]
find_videos_by_ids(token:String, video_ids:List, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Find multiple videos, given their ids.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| video_ids | List | The list of video ids for the videos we'd like to retrieve. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | an ItemCollection that contains the video objects corresponding to the video ids given. Note that if you pass in ids that belong to videos that are either not active or not playable because of schedule constraints, then the ItemCollection will contain null elements for the ids that are filtered out. |
Get the names & tags of the videos with the specified id's: http://api.brightcove.com/services/library?command=find_videos_by_ids&video_ids=123,456,789&video_fields=name,tags&token=[token] Get the urls of videos related to the videos with specified id's: http://api.brightcove.com/services/library?command=find_videos_by_ids&video_ids=123,456&video_fields=linkURL&token=[token]
find_video_by_reference_id(token:String, reference_id:String, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):Video
Find a video based on its publisher-assigned reference id.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| reference_id | String | The publisher-assigned reference id for the video we're searching for. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| Video | The video whose reference id matches the one given. |
Get the total number of plays for the video with this reference id: http://api.brightcove.com/services/library?command=find_video_by_reference_id&video_fields=playsTotal&reference_id=123&token=[token]
find_videos_by_reference_ids(token:String, reference_ids:List, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Find multiple videos based on their publisher-assigned reference ids.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| reference_ids | List | The list of reference ids for the videos we'd like to retrieve |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | the collection of videos specified by the reference ids provided. Note that if you pass in ids that belong to videos that are either not active or not playable because of schedule constraints, then the ItemCollection will contain null elements for the ids that are filtered out. |
Get the video IDs of the videos with these reference IDs: http://api.brightcove.com/services/library?command=find_videos_by_reference_ids&reference_ids=123,456,789&video_fields=id&token=[token]
find_videos_by_user_id(token:String, user_id:String, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Retrieves the videos uploaded by the specified user id. This method can be used to find videos submitted using the consumer- generated media (CGM) module.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| user_id | String | The id of the user whose videos we'd like to retrieve. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The field by which to sort the results. A SortByType: One of PUBLISH_DATE, CREATION_DATE, MODIFIED_DATE, PLAYS_TOTAL, PLAYS_TRAILING_WEEK. |
| sort_order (optional) | SortOrderType | How to order the results: ascending (ASC) or descending (DESC). |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | an ItemCollection representing the requested page of Videos uploaded by the specified user, in the order specified. |
Get the top 3 most popular videos and total # of videos by a user: http://api.brightcove.com/services/library?command=find_videos_by_user_id&user_id=123&page_size=3&sort_by=plays_total&sort_order=DESC&get_item_count=true&token=[token] Get the names of the first 5 videos by a user: http://api.brightcove.com/services/library?command=find_videos_by_user_id&user_id=123&page_size=3&sort_by=publish_date&sort_order=ASC&token=[token] Get the video names of the most popular videos by this user this week: http://api.brightcove.com/services/library?command=find_videos_by_user_id&user_id=123&sort_by=plays_trailing_week&sort_order=DESC&video_fields=name&token=[token]
find_videos_by_campaign_id(token:String, campaign_id:long, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Gets all the videos associated with the given campaign id. Campaigns are a feature of the consumer-generated media (CGM) module
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| campaign_id | long | The id of the campaign you'd like to fetch videos for. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The field by which to sort the results. A SortByType: One of PUBLISH_DATE, CREATION_DATE, MODIFIED_DATE, PLAYS_TOTAL, PLAYS_TRAILING_WEEK. |
| sort_order (optional) | SortOrderType | How to order the results: ascending (ASC) or descending (DESC). |
| get_item_count (optional) | Boolean | If true, also return how many total results there are in this campaign. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | the requested subset of all videos for the given campaign. |
Get the names of all videos of a campaign: http://api.brightcove.com/services/library?command=find_videos_by_campaign_id&campaign_id=123&video_fields=name&token=[token] Get the most popular videos this week by a campaign: http://api.brightcove.com/services/library?command=find_videos_by_campaign_id&campaign_id=123&sort_by=plays_trailing_week&sort_order=DESC&token=[token]
find_modified_videos(token:String, from_date:Date, filter:List, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Gets all the videos that have been modified since the given time.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| from_date | Date | The date, specified in minutes since January 1st, 1970 00:00:00 GMT, of the oldest Video which you would like returned. |
| filter (optional) | List | A comma-separated list of filters, specifying which categories of videos you would like returned. Valid filter values are PLAYABLE, UNSCHEDULED, INACTIVE, and DELETED. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 25; if you do not set this argument, or if you set it to an integer > 25, your results will come back as if you had set page_size=25. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The field by which to sort the results. A SortByType: One of PUBLISH_DATE, CREATION_DATE, MODIFIED_DATE, PLAYS_TOTAL, PLAYS_TRAILING_WEEK. |
| sort_order (optional) | SortOrderType | How to order the results: ascending (ASC) or descending (DESC). |
| get_item_count (optional) | Boolean | If true, also return how many total results there are in this campaign. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | all videos that have been modified since the given time. |
Get the id of all videos that have been modified or deleted since March 3rd, 2003. http://api.brightcove.com/services/library?command=find_modified_videos&from_date=17444520&filter=PLAYABLE,DELETED&video_fields=id&token=[token]
find_videos_by_text(token:String, text:String, page_size:Integer, page_number:Integer, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Searches through all the videos in this account, and returns a collection of videos whose name, short description, or long description contain a match for the specified text.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| text | String | The text we're searching for. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | A collection of videos whose name, short description, or long description contain a match for the text specified. |
Get the third page (matches 11-15) of matching videos with the text 'Ocelot': http://api.brightcove.com/services/library?command=find_videos_by_text&text=Ocelot&page_size=5&page_number=2&token=[token] Get the publish date, id, and name of matching videos with the text 'Ocelots Bobcats and Lions': http://api.brightcove.com/services/library?command=find_videos_by_text&text=Ocelots%20Bobcats%20and%20Lions&video_fields=id,name,publishedDate&token=[token]
find_videos_by_tags(token:String, and_tags:List, or_tags:List, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection
Performs a search on all the tags of the videos in this account, and returns a collection of videos that contain the specified tags. Note that tags are not case-sensitive.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| and_tags | List | Limit the results to those that contain all of these tags. |
| or_tags | List | Limit the results to those that contain at least one of these tags. |
| page_size (optional) | Integer | Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The field by which to sort the results. In this method, results can be sorted only by MODIFIED_DATE and PLAYS_TRAILING_WEEK. |
| sort_order (optional) | SortOrderType | How to order the results: ascending (ASC) or descending (DESC). |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this parameter is deprecated in favor of the video_fields parameter. A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| media_delivery (optional) | Enum | If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default. |
| type | description |
| ItemCollection | A collection of videos whose tags match the tags specified. |
Get videos that have either of the tags Apes or Monkeys: http://api.brightcove.com/services/library?command=find_videos_by_tags&or_tags=Apes,Monkeys&token=[token] Get the names of videos that have all of the tags Mountain, Lion, and Attack: http://api.brightcove.com/services/library?command=find_videos_by_tags&and_tags=Mountain,Lion,Attack&video_fields=name&token=[token] Get videos that have both of the tags Killer and Shark along and also have one of the tags Attack or Hugs, sorted by popularity: http://api.brightcove.com/services/library?command=find_videos_by_tags&and_tags=Killer,Shark&or_tags=Attack,Hug&sort_by=plays_total&sort_order=DESC&token=[token]
find_all_playlists(token:String, page_size:Integer, page_number:Integer, sort_by:SortByType, sort_order:SortOrderType, get_item_count:Boolean, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):ItemCollection
Find all playlists in this account.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| page_size (optional) | Integer | Number of playlists returned per page. A page is a subset of all of the playlists that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| sort_by (optional) | SortByType | The property that you'd like to sort the results by. |
| sort_order (optional) | SortOrderType | The order that you'd like the results sorted - ascending or descending. |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| ItemCollection | a collection of Lineups that is the specified subset of all the playlists in this account. |
Get the name and id of all playlists, oldest first. The total number of playlists is also returned. http://api.brightcove.com/services/library?command=find_all_playlists&playlist_fields=name,id&sort_by=publish_date&sort_order=ASC&get_item_count=true&token=[token] Get the names, id's, and short descriptions of the 5 newest playlists http://api.brightcove.com/services/library?command=find_all_playlists&sort_by=publish_date&sort_order=DESC&playlist_fields=id,name,shortDescription&page_size=5&token=[token]
find_playlist_by_id(token:String, playlist_id:long, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):Playlist
Finds a particular playlist based on its id.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| playlist_id | long | The id of the playlist requested. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publishedDate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| Playlist | the playlist requested, or null, if there is no video with that id. |
Get the name and short description of a playlist: http://api.brightcove.com/services/library?command=find_playlist_by_id&playlist_id=123&playlist_fields=name,shortDescription&token=[token] Get the Videos and VideoId's of the videos in the specified playlist: http://api.brightcove.com/services/library?command=find_playlist_by_id&playlist_id=123&playlist_fields=videos,videoIds&token=[token]
find_playlists_by_ids(token:String, playlist_ids:List, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):ItemCollection
Retrieve a set of playlists based on their ids.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| playlist_ids | List | The ids of the playlists you would like retrieved. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publishedDate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| ItemCollection | the specified playlists, in the order of the ids you passed in. If no playlist exists for an id, null is returned in its place. |
Get the names of the specified playlists: http://api.brightcove.com/services/library?command=find_playlists_by_ids&playlist_ids=123,456,789&playlist_fields=name&token=[token]
find_playlist_by_reference_id(token:String, reference_id:String, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):Playlist
Retrieve a playlist based on its publisher-assigned reference id.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| reference_id | String | The reference id of the playlist we'd like to retrieve. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publishedDate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| Playlist | the playlist that has the given reference id. |
Get the id of a playlist based on the reference id: http://api.brightcove.com/services/library?command=find_playlist_by_reference_id&reference_id=131&field=id&token=[token] Get the videoIds, id, and name from the reference id: http://api.brightcove.com/services/library?command=find_playlist_by_reference_id&reference_id=1414&playlist_fields=id,name,videoIds&token=[token]
find_playlists_by_reference_ids(token:String, reference_ids:List, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):ItemCollection
Retrieve multiple playlists based on their publisher-assigned reference ids.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| reference_ids | List | The reference ids of the playlists we'd like to retrieve. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publishedDate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| ItemCollection | A collection of the Playlists |
Get the names, short descriptions, and thumbnailURLs of the specified playlists http://api.brightcove.com/services/library?command=find_playlists_by_reference_ids&reference_ids=1414,1412,400&playlist_fields=name,shortDescription,thumbnailURL&token=[token]
find_playlists_for_player_id(token:String, player_id:long, page_size:Integer, page_number:Integer, get_item_count:Boolean, fields:Set, video_fields:EnumSet, playlist_fields:EnumSet, custom_fields:Set):ItemCollection
Given the id of a player, returns all the playlists assigned to that player.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| player_id | long | The player id whose playlists we want to return. |
| page_size (optional) | Integer | Number of playlists returned per page. A page is a subset of all of the playlists that satisfy the request. The maximum page size is 100; if you do not set this argument, or if you set it to an integer > 100, your results will come back as if you had set page_size=100. |
| page_number (optional) | Integer | The zero-indexed number of the page to return. |
| get_item_count (optional) | Boolean | If true, also return how many total results there are. |
| fields (optional) (deprecated) |
Set | Note that this is deprecated in favor of video_fields and playlist_fields. A comma-separated list of the fields you wish to have populated in the playlists or videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| video_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the videos contained in the playlists. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength. |
| playlist_fields (optional) | EnumSet | A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. If you omit this parameter, all playlist fields are returned. |
| custom_fields (optional) | Set | A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter. |
| type | description |
| ItemCollection | the collection of playlists requested. |
Get the names, thumbnail URLs, and short descriptions of the first 3 playlists for the player ID: http://api.brightcove.com/services/library?command=find_playlists_for_player_id&player_id=349&page_size=3&playlist_fields=name,shortDescription,thumbnailURL&token=[token] Get the first 5 playlists assigned to the player with this player ID, plus the total number of assigned playlists: http://api.brightcove.com/services/library?command=find_playlists_for_player_id&player_id=52&page_size=5&get_item_count=true&token=[token]
A set of APIs you can use to create, modify, or delete videos in your Media Library. Once a video is created using the Write API, it is fully accessible using the Read API and the Brightcove Studio Media module.
create_video(token:String, video:Video, filename:String, maxsize:Long, file:InputStream, checksum:String, encode_to:String, create_multiple_renditions:Boolean, H264NoProcessing:Boolean, preserve_source_rendition:Boolean):Long
Use this method to create a single video in your Brightcove Media Library. You can either upload a new video file, or use the remote assets approach, in which you pass a reference to a video file on your own CDN. For information about remote assets, see Creating Videos with Remote Assets Using the Media API.
| name | type | description |
| token | String | The Write API authentication token required to use this method. A string, generally ending in . (dot). |
| video | Video | The metadata for the video you'd like to create. This takes the form of a JSON object of name/value pairs, each of which corresponds to a settable property of the Video object. |
| filename (optional) | String | The name of the file that's being uploaded. You don't need to specify this in the JSON if it is specified in the file part of the POST. |
| maxsize (optional) | Long | The maximum size that the file will be. This is used as a limiter to know when something has gone wrong with the upload. The maxSize is same as the file you uploaded. You don't need to specify this in the JSON if it is specified in the file part of the POST. |
| file (optional) | InputStream | An input stream associated with the video file you're uploading. This takes the form of a file part, in a multipart/form-data HTTP request. This input stream and the filename and maxSide parameters are automatically inferred from that file part. |
| file_checksum (optional) | String | An optional MD5 hash of the file. The checksum can be used to verify that the file checked into your Brightcove Media Library is the same as the file you uploaded. | encode_to (optional) | FLV or MP4 | If the file requires transcoding, use this parameter to specify the target encoding. Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV. |
| create_multiple_renditions (optional) | Boolean | If the file is a supported transcodeable type, this optional flag can be used to control the number of transcoded renditions. If true (default), multiple renditions at varying encoding rates and dimensions are created. Setting this to false will cause a single transcoded VP6 rendition to be created at the standard encoding rate and dimensions. |
| preserve_source_rendition (optional) | Boolean | If the video file is H.264 encoded and if create_multiple_ renditions=true, then multiple VP6 renditions are created and in addition the H.264 source is retained as an additional rendition. |
| H264NoProcessing (optional) | Boolean | Use this option to prevent H.264 source files from being transcoded. This parameter cannot be used in combination with create_multiple_renditions. It is optional and defaults to false. |
| type | description |
| Long | The id of the video that's been created. |
update_video(token:String, video:Video):Video
Use this method to modify the metadata for a single video in your Brightcove Media Library.
| name | type | description |
| token | String | The Write API authentication token required to use this method. A string, generally ending in . (dot). |
| video | Video | The metadata for the video you'd like to update. This takes the form of a JSON object of name/value pairs, each of which corresponds to a settable property of the Video object. |
| type | description |
| Video |
delete_video(token:String, video_id:Long, reference_id:String, cascade:Boolean, delete_shares:Boolean):void
Deletes a video.
| name | type | description |
| token | String | The Write API authentication token required to use this method. A string, generally ending in . (dot). |
| video_id (optional) | Long | The id of the video you'd like to delete |
| reference_id (optional) | String | The publisher-assigned reference id of the video you'd like to delete. |
| cascade (optional) | Boolean | Set this to true if you want to delete this video even if it is part of a manual playlist or assigned to a player. The video will be removed from all playlists and players in which it appears, then deleted. |
| delete_shares (optional) | Boolean | Set this to true if you want also to delete shared copies of this video. Note that this will delete all shared copies from sharee accounts, regardless of whether or not those accounts are currently using the video in playlists or players. |
| type | description |
| void |
get_upload_status(token:String, video_id:Long, reference_id:String):UploadStatusEnum
Call this function in an HTTP POST request to determine the status of an upload.
| name | type | description |
| token | String | The Write API authentication token required to use this method. |
| video_id (optional) | Long | The id of the video whose status you'd like to get. |
| reference_id (optional) | String | The publisher-assigned reference id of the video whose status you'd like to get. |
| type | description |
| UploadStatusEnum | an UploadStatusEnum that specifies the current state of the upload. |
share_video(token:String, video_id:Long, auto_accept:Boolean, sharee_account_ids:Long):Long
Shares the specified video with a list of sharee accounts
| name | type | description |
| token | String | The Write API authentication token required to use this method. |
| video_id | Long | The id for video that will be shared. |
| auto_accept (optional) | Boolean | If the target account has the option enabled, setting this flag to true will bypass the approval process, causing the shared video to automatically appear in the target account's library. If the target account does not have the option enabled, or this flag is unspecified or false, then the shared video will be queued up to be approved by the target account before appearing in their library. |
| sharee_account_ids | Long | List of Account IDs to share video with. |
| type | description |
| Long | Array of new video IDs (one for each account id). |
add_image(token:String, image:Image, filename:String, maxsize:Long, file:InputStream, file_checksum:String, video_id:Long, video_reference_id:String, resize:Boolean):Image
Add a new thumbnail or video still image to a video, or assign an existing image to another video.
| name | type | description |
| token | String | The Write API authentication token required to use this method. A string, generally ending in . (dot). |
| image | Image | The metadata for the image you'd like to create (or update). This takes the form of a JSON object of name/value pairs, each of which corresponds to a property of the Image object. |
| filename (optional) | String | The name of the file that's being uploaded. You don't need to specify this in the JSON if it is specified in the file part of the POST. |
| maxsize (optional) | Long | The maximum size that the file will be. This is used as a limiter to know when something has gone wrong with the upload. The maxSize is same as the file you uploaded. You don't need to specify this in the JSON if it is specified in the file part of the POST. |
| file (optional) | InputStream | An input stream associated with the image file you're uploading. This takes the form of a file part, in a multipart/form-data HTTP request. This input stream and the filename and maxSide parameters are automatically inferred from that file part. |
| file_checksum (optional) | String | An optional MD5 hash of the file. The checksum can be used to verify that the file checked into your Brightcove Media Library is the same as the file you uploaded. |
| video_id (optional) | Long | The ID of the video you'd like to assign an image to. |
| video_reference_id (optional) | String | The publisher-assigned reference ID of the video you'd like to assign an image to. |
| resize (optional) | Boolean | Set this to false if you don't want your image to be automatically resized to the default size for its type. By default images will be resized. |
| type | description |
| Image |
create_playlist(token:String, playlist:Playlist):Long
Creates a playlist. This method must be called using an HTTP POST request and JSON parameters.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| playlist | Playlist | The metadata for the playlist you'd like to create. This takes the form of a JSON object of name/value pairs, each of which corresponds to a settable property of the Playlist object. Populate the videoIds property of the playlist, not the videos property. |
| type | description |
| Long | The ID of the Playlist you created. |
update_playlist(token:String, playlist:Playlist):Playlist
Updates a playlist, specified by playlist id. This method must be called using an HTTP POST request and JSON parameters.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| playlist | Playlist | The metadata for the playlist you'd like to create. This takes the form of a JSON object of name/value pairs, each of which corresponds to a settable property of the Playlist object. Populate the videoIds property of the playlist, not the videos property. |
| type | description |
| Playlist |
delete_playlist(token:String, playlist_id:Long, reference_id:String, cascade_options:CascadeOptionsEnum, cascade:Boolean):void
Deletes a playlist, specified by playlist id.
| name | type | description |
| token | String | The authentication token provided to authorize using the Media APIs. A string, generally ending in . (dot). |
| playlist_id (optional) | Long | the id for the playlist to delete |
| reference_id (optional) | String | The publisher-assigned reference id of the playlist you'd like to delete. |
| cascade_options (optional) (deprecated) |
CascadeOptionsEnum | This parameter is deprecated. |
| cascade (optional) | Boolean | Set this to true if you'd like to delete this playlist even if it is referenced by players. The playlist will be removed from all players in which it appears, then deleted. |
| type | description |
| void |
See also the Media Objects Reference and the Error Message Reference.
Ways that entities within the returned set can be ordered.
| Name | Type | Access | Description |
|---|---|---|---|
| PUBLISH_DATE | Enum | read-only | Date title was published. |
| CREATION_DATE | Enum | read-only | Date title was created. |
| MODIFIED_DATE | Enum | read-only | Date title was last modified. |
| PLAYS_TOTAL | Enum | read-only | Number of times this title has been viewed. |
| PLAYS_TRAILING_WEEK | Enum | read-only | Number of times this title has been viewed in the past 7 days (excluding today) |
Directions that entities within the return set can be ordered.
| Name | Type | Access | Description |
|---|---|---|---|
| ASC | Enum | read-only | Ascending |
| DESC | Enum | read-only | Descending |
| Name | Type | Access | Description |
|---|---|---|---|
| UPLOADING | Enum | read-only | File is still uploading. |
| PROCESSING | Enum | read-only | Upload complete; being processed. |
| COMPLETE | Enum | read-only | Upload and processing complete. |
| ERROR | Enum | read-only | Error in upload or processing. |
| Name | Type | Access | Description |
|---|---|---|---|
| FREE | Enum | read-only | Ads are not enabled for this object. |
| AD_SUPPORTED | Enum | read-only | Ads are enabled for this object. |
| Name | Type | Access |
|---|---|---|
| ACTIVE | Enum | read-only |
| INACTIVE | Enum | read-only |
| DELETED | Enum | read-only |
The type of playlist.
| Name | Type | Access | Description |
|---|---|---|---|
| EXPLICIT | Enum | read-only | A manual playlist, the videos of which were added individually. |
| OLDEST_TO_NEWEST | Enum | read-only | A smart playlist, ordered from oldest to newest, by last-modified date. |
| NEWEST_TO_OLDEST | Enum | read-only | A smart playlist, ordered from newest to oldest, by last-modified date. |
| ALPHABETICAL | Enum | read-only | A smart playlist, ordered alphabetically. |
| PLAYS_TOTAL | Enum | read-only | A smart playlist, ordered by total plays. |
| PLAYS_TRAILING_WEEK | Enum | read-only | A smart playlist, ordered by most plays in the past week. |
An enum iterating all the fields of this Playlist object, for efficient specification of what fields you want populated.
| Name | Type | Access |
|---|---|---|
| ID | Enum | read-only |
| REFERENCEID | Enum | read-only |
| NAME | Enum | read-only |
| SHORTDESCRIPTION | Enum | read-only |
| VIDEOIDS | Enum | read-only |
| VIDEOS | Enum | read-only |
| THUMBNAILURL | Enum | read-only |
| FILTERTAGS | Enum | read-only |
| PLAYLISTTYPE | Enum | read-only |
| ACCOUNTID | Enum | read-only |
An enum iterating all the fields of this object, for efficient specification of what fields you want populated.
| Name | Type | Access |
|---|---|---|
| ID | Enum | read-only |
| NAME | Enum | read-only |
| SHORTDESCRIPTION | Enum | read-only |
| LONGDESCRIPTION | Enum | read-only |
| CREATIONDATE | Enum | read-only |
| PUBLISHEDDATE | Enum | read-only |
| LASTMODIFIEDDATE | Enum | read-only |
| STARTDATE | Enum | read-only |
| ENDDATE | Enum | read-only |
| LINKURL | Enum | read-only |
| LINKTEXT | Enum | read-only |
| TAGS | Enum | read-only |
| VIDEOSTILLURL | Enum | read-only |
| THUMBNAILURL | Enum | read-only |
| REFERENCEID | Enum | read-only |
| LENGTH | Enum | read-only |
| ECONOMICS | Enum | read-only |
| ITEMSTATE | Enum | read-only |
| PLAYSTOTAL | Enum | read-only |
| PLAYSTRAILINGWEEK | Enum | read-only |
| VERSION | Enum | read-only |
| CUEPOINTS | Enum | read-only |
| SUBMISSIONINFO | Enum | read-only |
| CUSTOMFIELDS | Enum | read-only |
| RELEASEDATE | Enum | read-only |
| FLVURL | Enum | read-only |
| RENDITIONS | Enum | read-only |
| GEOFILTERED | Enum | read-only |
| GEORESTRICTED | Enum | read-only |
| GEOFILTEREXCLUDE | Enum | read-only |
| EXCLUDELISTEDCOUNTRIES | Enum | read-only |
| GEOFILTEREDCOUNTRIES | Enum | read-only |
| ALLOWEDCOUNTRIES | Enum | read-only |
| ACCOUNTID | Enum | read-only |
| FLVFULLLENGTH | Enum | read-only |
| VIDEOFULLLENGTH | Enum | read-only |
| Name | Type | Access |
|---|---|---|
| UNDEFINED | Enum | read-only |
| NONE | Enum | read-only |
| SORENSON | Enum | read-only |
| ON2 | Enum | read-only |
| H264 | Enum | read-only |
| Name | Type | Access | Description |
|---|---|---|---|
| VIDEO_STILL | Enum | read-only | a video still |
| SYNDICATION_STILL | Enum | read-only | |
| THUMBNAIL | Enum | read-only | a thumbnail image |
| BACKGROUND | Enum | read-only | a background image |
| LOGO | Enum | read-only | |
| LOGO_OVERLAY | Enum | read-only | a logo overlay |
| Name | Type | Access | Description |
|---|---|---|---|
| FLV_PREVIEW | Enum | read-only | A brief preview video. |
| FLV_FULL | Enum | read-only | A full-length video. |
| FLV_BUMPER | Enum | read-only | A video bumper. |
| DIGITAL_MASTER | Enum | read-only | A master rendition. |
A collection of paged items. This class encapsulates a list of an item of a certain type, and also stores paging information.
| Name | Type | Access | Description |
|---|---|---|---|
| total_count | long | read-only | The total number of videos in the collection. |
| items | List | read-only | The actual items that this collection contains. |
| page_number | int | read-only | Which page of the results this ItemCollection represents. |
| page_size | int | read-only | How many items a page consists of. |