beta

nimbb

Development: list of methods

Here is the list of methods exposed by the Nimbb Player. You can call them in your JavaScript code to communicate with the player.

Methods are accessible only if you specify your developer key as a parameter. See our tutorial for help.

getGuid()	If in viewer mode, returns the currently loaded video's GUID. If in record mode, returns last recorded video's GUID. The GUID is a unique identifier of 10 characters.
getLanguage()	Returns the current language of the player ('en' for English or 'fr' for French).
getMode()	Returns current mode of player ('view' or 'record').
getState()	Returns the current state of the player. Possible values: 'init', 'ready', 'busy', 'recording', 'playing', 'error'.
getVolume()	Returns the current volume of the player (from 0 to 100).
isCaptureAllowed()	Returns 'true' if the user has allowed access to camera/microphone in the Adobe Flash Player settings.
isReadOnly()	Returns 'false' if the video can be saved.
playVideo()	Play the video. If in record mode, play the recorded video.
recordVideo()	Start recording a video. Must be in record mode.
saveVideo()	Save the video just recorded. You should test with idReadOnly() before saving.
setGuid(guid)	Set video guid to use in viewer mode. Returns 'false' if trying to set this value in record mode.
setMode(mode)	Set mode of the player ('view' or 'record').
setVolume(volume)	Set volume of the player (values from 0 to 100).
stopVideo()	Stop the playing or recording video.

For an example of using methods in your code, see our tutorial.