Echove

Class: Echove
__construct ( $token_read = NULL, $token_write = NULL )
The constructor for the Echove class
__set ( $key, $value )
Sets a property of the Echove class.
__get ( $key )
Retrieves a property of the Echove class.
find ( $call, $params = NULL )
Formats the request for any API 'Find' methods and retrieves the data.
findAll ( $type = 'video', $params = NULL )
Finds all media assets in account, ignoring pagination.
createMedia ( $type = 'video', $file = NULL, $meta, $options = NULL )
Uploads a media asset file to Brightcove.
createImage ( $type = 'video', $file = NULL, $meta, $id = NULL, $ref_id = NULL, $resize = TRUE )
Uploads a media image file to Brightcove.
createPlaylist ( $meta )
Creates a playlist.
update ( $type = 'video', $meta )
Updates a media asset.
delete ( $type = 'video', $id = NULL, $ref_id = NULL, $options = NULL )
Deletes a media asset.
getStatus ( $type = 'video', $id = NULL, $ref_id = TRUE )
Retrieves the status of a media asset upload.
shareMedia ( $type = 'video', $id, $account_ids, $accept = FALSE )
Shares a media asset with the selected accounts.
removeFromPlaylist ( $playlist_id, $video_ids )
Removes assets from a playlist
addToPlaylist ( $playlist_id, $video_ids )
Adds assetd to a playlist
time ( $ms, $seconds = FALSE )
Converts milliseconds to formatted time or seconds.
tags ( $tags, $implode = FALSE )
Parses media asset tags array into a key-value array.
filter ( $videos, $tags )
Removes assets that don't contain the appropriate tags.
sef ( $name )
Formats a media asset name to be search-engine friendly.
embed ( $type = 'video', $playerId, $assetIds = NULL, $params = NULL, $additional = NULL )
Returns the JavaScript version of the player embed code.
Class: EchoveException
__construct ( Echove $obj, $err_code, $raw_error_string = NULL )
The constructor method of the EchoveException API class.

Shorthand

Echove supports the use of shorthand for API methods. For instance "find_video_by_id" can be written "video_by_id" or even "videoById". This can help make code more readable and quicker to write, as well as eliminating the awkward find / find combination.

Archived Documentation

The documentation on this page is for the 1.X.X series of Echove releases; for the 0.X.X series please use the documentation located in our Archived Documentation section.

Supported 'Find' Calls

Listed below are all of the currently supported Brightcove API 'Find' methods. Some API calls only require one parameter, and that assumed parameter is listed. This allows you to quickly pass a single argument to the find() method rather than a key-value array.

find_all_videos
Default: N / A
find_modified_videos
Default: from_date
find_related_videos
Default: video_id
find_videos_by_campaign_id
Default: campaign_id
find_video_by_id
Default: video_id
find_videos_by_ids
Default: video_ids
find_video_by_reference_id
Default: reference_id
find_videos_by_reference_ids
Default: reference_ids
find_videos_by_tags
Default: or_tags
find_videos_by_text
Default: text
find_videos_by_user_id
Default: user_id
find_all_playlists
Default: N / A
find_playlist_by_id
Default: playlist_id
find_playlists_by_ids
Default: playlist_ids
find_playlist_by_reference_id
Default: reference_id
find_playlists_by_reference_ids
Default: reference_ids
find_playlists_for_player_id
Default: player_id
find_all_audiotracks
Default: N / A
find_modified_audiotracks
Default: from_date
find_audiotrack_by_id
Default: audiotrack_id
find_audiotracks_by_ids
Default: audiotrack_ids
find_audiotrack_by_reference_id
Default: reference_id
find_audiotracks_by_reference_ids
Default: reference_ids
find_audiotracks_by_text
Default: text
find_audiotracks_by_tags
Default: or_tags
find_all_audiotrack_playlists
Default: N / A
find_audiotrack_playlist_by_id
Default: playlist_id
find_audiotrack_playlists_by_id
Default: playlist_ids
find_audiotrack_playlist_by_reference_id
Default: reference_id
find_audiotrack_playlists_by_reference_ids
Default: reference_ids


Copyright 2009 Matthew Congrove, Brian Franklin. Echove is not officially supported by Brightcove.

Echove License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. YOU AGREE TO RETAIN IN THE SOFTWARE AND ANY MODIFICATIONS TO THE SOFTWARE THE REFERENCE URL INFORMATION, AUTHOR ATTRIBUTION AND CONTRIBUTOR ATTRIBUTION PROVIDED HEREIN.