This document provides a reference to objects in the Brightcove Player API, as it existed in the Brightcove 3.1 release. For a summary of API changes and deprecations in the Brightcove 3.2 release, see Brightcove Player API Changes. For reference information about the current Brightcove Player API, including methods, events, and objects, see the current Player API Reference.
The player receives its data from the server in the form of Data Transfer Objects (DTOs). Each of these objects contains a collection of properties that hold the metadata for the particular video, playlist, or other object. All values can be retrieved, but not set. The type listed for each property is the ActionScript 3 type.
Note that these DTOs are similar to, but not identical with, the objects returned by the Media API.
The Player API includes these DTOs:
Describes a single video.
| name | type | description |
| FLVFullCodec | Number | 0 = Sorenson (Flash 7 compatible) 1 = ON2 (Flash 8 compatible) 3 = H264 (MPEG-4 Part 10) |
| FLVFullLengthStreamed | Boolean | True if full length video is streamed |
| FLVFullLengthURL | String | URL of full length video |
| FLVFullSize | Number | The size, in bytes, of the full length video |
| displayName | String | Name of video displayed in Player (maximum 60 characters) |
| endDate | BrightcoveDateDTO | Date Video is to expire (no longer available via any Player) |
| id | Number | Unique Brightcove ID |
| length | Number | Length of video in milliseconds |
| lineupId | Number | Id of playlist to which this Video is targeted, in the scope of this request (note: this field is not always populated) |
| linkText | String | Publisher-defined link text |
| linkURL | String | Publisher-defined URL that points to an information or containing page for this Video. |
| longDescription | String | Description of Video with no character limit. This description is not currently exposed to the viewer. |
| publisherId | Number | Unique Brightcove ID of publisher that created this playlist |
| referenceId | String | Publisher defined identification (maximum 150 characters) |
| shortDescription | String | Brief description of Video |
| startDate | BrightcoveDateDTO | Date Video is to go live on any Player |
| tags | Array | Publisher-defined list of tags for this Video, returned as an array of strings |
| thumbnailURL | String | URL of a thumbnail image |
| videoStillURL | String | URL of an image that displays in playback area before video begins |
A list of Videos that can be assigned to a player.
| name | type | description |
| displayName | String | Name of Playlist displayed in Player |
| id | Number | Unique Brightcove ID |
| referenceId | String | Publisher defined ID (maximum 150 characters) |
| shortDescription | String | Descriptive text (maximum 255 characters) |
| videoIds | Array | Array of videoId values, representing each Video in the Playlist |
Describes a list of Playlists, used in Players supporting multiple Playlists.
| name | type | description |
| lineupDTOs | Array | Array of PlaylistDTOs |
Describes a single rendition of a Video, used in dynamic delivery.
| name | type | description |
| defaultURL | String | The path to the asset. |
| encodingRate | Number | The encoding rate of the asset, in average kilobits per second. |
| frameHeight | Number | The height of the media, in pixels. |
| frameWidth | Number | The width of the media, in pixels. |
| size | Number | The size of the asset file, in bytes. |
Contains the metadata associated with a single video cue point.
| name | type | description |
| forceStop | Boolean | Whether the cue point, when reached, will stop video playback automatically. |
| id | Number | Unique Brightcove ID |
| metadata | String | Additional data that was assigned to the cue point. |
| name | String | The name given to the cue point. |
| time | Number | The point in the video, in milliseconds, that the cue point is tied to. |
| type | Number | The numeric type for the cue point. 0 signifies an ad cue 1 signifies a code cue 2 signifies a chapter cue 4 signifies an ad impression cue. |
| videoIds | Array | The id of the Video the cue point is associated with. |
Describes the pertinent information about a specified date.
| name | type | example |
| day | Number | 10 |
| hour | Number | 12 |
| meridian | String | AM |
| milliseconds | Number | 0 |
| minutes | Number | 0 |
| month | Number | 7 |
| seconds | Number | 0 |
| timezone | String | EST |
| year | Number | 2006 |