Brightcove Video Cloud / Media API Reference

search_videos(token:String, all:List, any:List, none:List, sort_by:List, exact:Boolean, page_size:Integer, page_number:Integer, get_item_count:Boolean, video_fields:List, custom_fields:List, media_delivery:Enum, output:Enum):ItemCollection

Searches videos according to the criteria provided by the user. The criteria are constructed using field/value pairs specified in the command. Consider using the search_videos method for video searches rather than using the other find_video read methods. The search_videos method offers more flexible search and sorting options than the find_video methods, and is especially more flexible than the find_videos_by_text and find_videos_by_tags methods. For specifications of the search_videos method, see: Searching for Videos with the Media API.

http://api.brightcove.com/services/library?command=search_videos&all=display_name:gibbous&video_fields=name,shortDescription&page_size=3&get_item_count=true&sort_by=MODIFIED_DATE:DESC&token=[token]

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, output:Enum):ItemCollection

Find all videos in the Video Cloud media library for this account. This method has the limitation of returning only videos available for play, and does not include videos marked as inactive, currently in the upload process, or outside the scheduled play time. See Searching for Unavailable Videos with the Media API for information about solutions to these limitations.

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 IDs 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, output:Enum):Video

Finds a single video with the specified ID. See Accessing Video Content with the Media API for various examples of the find_video_by_id method.

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 its 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, output: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, short description, long description, tags, and custom fields of all videos in the Video Cloud 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. Consider using the search_videos method, which offers more flexible search and sorting options.

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, output:Enum):ItemCollection

Find multiple videos, given their IDs.

Get the names and tags of the videos with the specified IDs:
    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 IDs:
    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, output:Enum):Video

Find a video based on its publisher-assigned reference ID.

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, output:Enum):ItemCollection

Find multiple videos based on their publisher-assigned reference IDs.

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, output:Enum):ItemCollection

Deprecated. Read about approaches to user-generated content. Retrieves the videos uploaded by the specified user id. This method can be used to find videos submitted using the old consumer-generated media (CGM) module in Brightcove 2.

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, output:Enum):ItemCollection

Deprecated. Read about approaches to user-generated content. Gets all the videos associated with the given campaign ID. Campaigns are a feature of the old consumer-generated media (CGM) module in Brightcove 2.

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, output:Enum):ItemCollection

Gets all the videos that have been modified since the given time.For more examples of the find_modified_videos method, see Finding Videos That Have Changed with the Media API.

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, output:Enum):ItemCollection

Deprecated. Consider using the search_videos method, which offers more flexible search and sorting options. For specifications of the search_videos method, see: Searching for Videos with the Media API.

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. Unlike some other Read methods, this method does not provide parameters for sorting the result set. The result set is sorted by relevance.

The find_videos_by_text method returns substring matches – words from your search string plus a wildcard (*) at the end; thus, if your search string is "war", the result set will include results such as "warrior", "warfare", and "warbler." Substrings that don't match the beginning of a word are not returned; thus, if your search string is "war", the result set would not include results such as "swarthy" or "inward".

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, output:Enum):ItemCollection

Deprecated. Consider using the search_videos method, which offers more flexible search and sorting options. For specifications of the search_videos method, see: Searching for Videos with the Media API.

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. This method does not provide parameters for sorting the result set.

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_video_by_id_unfiltered(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. Unlike find_video_by_id, this unfiltered version also returns videos that are unscheduled, inactive, or deleted. See Searching for Unavailable Videos with the Media API for more information about the find_video_by_id_unfiltered method.

Get the video with the specified ID:

    http://api.brightcove.com/services/library?command=find_video_by_id_unfiltered&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_unfiltered&video_id=123&video_fields=longDescription&token=[token]

find_videos_by_ids_unfiltered(token:String, video_ids:List, fields:Set, video_fields:EnumSet, custom_fields:Set, media_delivery:Enum):ItemCollection

Find multiple videos, given their IDs. Unlike find_videos_by_ids, this unfiltered version also returns videos that are unscheduled, inactive, or deleted. See Searching for Unavailable Videos with the Media API for more information about the find_videos_by_id_unfiltered method.

Get the names & tags of the videos with the specified IDs:

    http://api.brightcove.com/services/library?command=find_videos_by_ids_unfiltered&video_ids=123,456,789&video_fields=name,tags&token=[token]

Get the URLs of videos related to the videos with specified IDs:

    http://api.brightcove.com/services/library?command=find_videos_by_ids_unfiltered&video_ids=123,456&video_fields=linkURL&token=[token]

find_video_by_reference_id_unfiltered(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. Unlike find_video_by_reference_id, this unfiltered version also returns videos that are unscheduled, inactive, or deleted. See Searching for Unavailable Videos with the Media API for more information about the find_video_by_reference_id_unfiltered method.

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_unfiltered&video_fields=playsTotal&reference_id=123&token=[token]

find_videos_by_reference_ids_unfiltered(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. Unlike find_videos_by_reference_ids, this unfiltered version also returns videos that are unscheduled, inactive, or deleted. See Searching for Unavailable Videos with the Media API for more information about the find_videos_by_reference_ids_unfiltered method.

Get the video IDs of the videos with these reference IDs:
			        http://api.brightcove.com/services/library?command=find_videos_by_reference_ids_unfiltered&reference_ids=123,456,789&video_fields=id&token=[token]