Video Cloud Media API Changes

Since the Video Cloud Media API was first released in beta in March 2007, we've made a few changes, as we and our customers gain more experience with how the Media API is being used. This document lists the changes we have made to date.

Content type for Media API responses

The content type for responses returned by the Video Cloud Media API is application/json and not text/html. Using the application/json content type should provide superior security. The change in content type should not affect how any JSON returned in a Media API method is parsed.

Error returned by Media API search_videos method for invalid sort_by arguments

Formerly, if you called the search_videos method in the Media API with an invalid sort_by argument, the error returned formerly included the text of the invalid argument. Now, calls that include illegal characters (such as <, >, &, \, %, or +) in the sort_by argument will return an error message with the illegal characters escaped.

Read method fields parameter is split into videoFields and playlistFields (Video Cloud 3.2 – 2009.3.22)

Each of the read methods in the Media API has a fields parameter that lets you limit which fields of the objects should be returned. With this release, the read methods that return Videos have a video_fields parameter, while the read methods that return Playlists have a playlist_fields parameter. This enables you to specify different fields for the playlists and the videos that are returned by methods like find_all_playlists. The fields parameter still functions, but is deprecated.

renditions property added to Video object (Video Cloud 3.1.1 – 2008.12.18)

A new property, renditions, has been added to the Video object used by the Media API. This property is an array of Rendition objects, each of which represents one multi-bitrate streaming rendition of the Video.

accountId property added to Video and Playlist objects (Video Cloud 3.1.1 – 2008.12.18)

A new property, accountId, has been added to the Video and Playlist objects used by the Media API. This property is a number, assigned by Video Cloud , that uniquely identifies the account to which the Video or Playlist belongs.

NonmatchingChecksumError added (Video Cloud 3.1.1 – 2008.12.18)

A new error message, NonmatchingChecksumError, with the code 308, has been added. This error message is generated if the provided file's MD5 digest did not match the checksum provided. Formerly, this error condition generated the code 100: UnknownServerError.

delete_playlist cascade argument (Video Cloud 3.0.2 – 2008.10.15)

The delete_playlist method has a cascade_options argument, an enum equal to one of ALL, REFERENCES, NONE, ASSETS_ONLY. This argument is deprecated; instead, you should use the cascade argument, which is a boolean. If cascade=true, the playlist will be deleted even if it has been assigned to a player. If cascade=false, which is the default option, if the playlist has been assigned to a player, it will not be deleted and the delete_playlist method will return an error (error code 302 DeleteFailedError).