Video Cloud
App Cloud
- Overview and general topics
- Product Updates
- Glossary
- The App Cloud SDK
- Creating an app template
- Tutorials
- Content optimization
- Development tips and best practices
- Packaging a template
- Creating apps from a template
- Publishing an app
- Delivering ads
- Push Notifications
- Analytics
- Managing users and accounts
Player Debugger
Resources
Methods and Events of the Flash-Only Player API and the Smart Player API Equivalents
Brightcove offers two player APIs for creating dynamic solutions for Video Cloud players:
- The Flash-Only Player API—The legacy Player API for creating JavaScript solutions and ActionScript plug-ins for Flash players only, with no support for HTML players
- The Smart Player API—The JavaScript API for creating solutions for Video Cloud players that work in both Flash and HTML mode, that does not yet support all the features available in the Flash-Only Player API
Smart Player API Limitations
The Smart Player API does not support methods and events required for coding the following areas:
- No support for creating solutions for playlists
- No support for designing the layout or look of the player interface
- No support for integrating advertising
- No support for customizing any menus of the player
- No support for searching for content using the Smart Player API; use the Media API instead
JavaScript Methods for the Plug-In Player API and the Smart Player API Method Equivalent
This table lists the method names and attributes for both player APIs when they differ. Method names and attributes not listed here are identical for both APIs.
| Flash-Only Player API Method |
Smart Player API Method |
| videoPlayerModule.getCurrentVideo() | videoPlayerModule.getCurrentVideo (callbackHandler) |
| videoPlayerModule.getCurrentRendition() | videoPlayerModule.getCurrentRendition (callbackHandler) |
| videoPlayerModule.getIsPlaying() | videoPlayerModule.getIsPlaying (callbackHandler) |
| videoPlayerModule.getVideoDuration() | videoPlayerModule.getVideoDuration (callbackHandler) |
| videoPlayerModule.getVideoPosition() | videoPlayerModule.getVideoPosition (callbackHandler) |
| videoPlayerModule.loadVideo (videoID:Object,"id") |
videoPlayerModule.loadVideoByID (videoID:Object) |
| videoPlayerModule.loadVideo (refID:Object,"referenceId") |
videoPlayerModule.loadVideoByReferenceID (refID:Object) |
| contentModule.getMedia (videoID:Object,"id") |
contentModule.getMediaByID (videoID:Object,callbackHandler) |
| contentModule.getMedia (refID:Object,"referenceId") |
contentModule.getMediaByReferenceID (refID:Object,callbackHandler) |
| contentModule.getMediaAsynch (videoID:Object,"id",mode:String = "full") |
contentModule.getMediaByID (videoID:Object,callbackHandler) |
| contentModule.getMediaAsynch (refID:Object,"referenceId") |
contentModule.getMediaByReferenceID (refID:Object,callbackHandler) |
| getCuePoints(videoID:Number | getCuePoints(id, callback) |
JavaScript Events for the Flash-Only Player API and the Smart Player API Event Equivalent
This table lists the event paths for both player APIs when they differ. Event paths not listed here are identical for both APIs.
| Flash-Only Player API Event | Smart Player API Event |
|---|---|
| BCExperienceEvent.TEMPLATE_READY | brightcove.api.events.ExperienceEvent.TEMPLATE_READY |
| BCMediaEvent.BEGIN | brightcove.api.events.MediaEvent.BEGIN |
| BCMediaEvent.CHANGE | brightcove.api.events.MediaEvent.CHANGE |
| BCMediaEvent.COMPLETE | brightcove.api.events.MediaEvent.COMPLETE |
| BCMediaEvent.ERROR | brightcove.api.events.MediaEvent.ERROR |
| BCMediaEvent.PLAY | brightcove.api.events.MediaEvent.PLAY |
| BCMediaEvent.PROGRESS | brightcove.api.events.MediaEvent.PROGRESS |
| BCMediaEvent.STOP | brightcove.api.events.MediaEvent.STOP |
| BCCuePointEvent.CUE | brightcove.api.events.CuePointEvent.CUE |
Resources by project approach
- To implement a hybrid solution using supported elements of the Smart Player API along with elements from the Flash-only player API, see Coding a Hybrid Solution Using Both JavaScript Player APIs.
- To update your existing code to the Smart Player API code, see Refactoring your Flash-Only Player Code to Smart Player Code.
- To create solutions that work for players both in HTML and Flash mode using the Smart Player API, get started with the resources below:
- Using the Smart Player API provides an overview of this API for smart players and details the currently supported features.
- The Smart Player API Reference lists the methods and events available for coding solutions supported for players in both Flash and HTML mode.
- Preparing the Player for the Smart Player API for how to access player components in your solution.
- Dynamically Loading Videos using the Smart Player API for a sample of a typical Smart Player API solution.
