List of parameters

Here is the list of parameters accepted by the Nimbb Player. You can add them in your HTML code to assign values to the player on startup.

audioquality Optional. Set the level of audio quality when recording. Numbers from 1 (low) to 5 (high). The higher the number, the better the audio quality but also requires more bandwidth. The default value is 3. If the microphone does not support the quality level, a lower value might be used.
autoplay Optional. While in view mode, automatically starts video playback when the Nimbb Player is loaded. Assign the value '1' to activate.
bgcolor Optional. Specify the background color in hexadecimal format (example: FFFFFF).
bordercolor Optional. Specify the border color in hexadecimal format (example: 000000).
custom Optional. Add a custom text string of up to 100 characters for your development purpose while in Record mode. The value is stored with the video and can be retrieved using the Video/Get function after the video is saved. For example, set the value as the email address of a user or a client ID used by your system. Make sure to URL encode your string.
disablecamera Optional. Disable camera so that only the audio is recorded. Assign the value '1' to activate.
disablemicro Optional. Disable microphone so that no audio is recorded. Assign the value '1' to activate.
disabletuning Optional. Disable auto-tuning of video while recording. By setting this param to '1', no compression will be done to the video and quality will stay the same. However, doing so can cause video jams if not enough bandwidth.
forcedev Optional. Force the Nimbb Player in developer mode, even if the player is on production site. Assign the value '1' to activate. Use only for debugging purpose.
format Optional. Set the recording resolution of the camera. Accepted values are '320x240' (default, FLV format), '320x240m' (MP4 format), '640x480' (MP4 format) and '640x360' (MP4 format). MP4 formats require using the Nimbb Player 2 and a valid subscription.
fps Optional. Specify the frame rate for video recording. The values of 6 to 30 are accepted. Default 15.
guid The GUID of the video to watch. Mandatory if the view mode is used.
key Optional. The developer's public key. When specified, it allows you to activate the advanced functions of the Nimbb Player so you can program it.
lang Optional. Language of the player's interface ('en' for English, 'fr' for French, 'da' for Danish, 'de' for German, 'es' for Spanish and 'pt' for Portuguese).
logoclickurl Optional. Destination URL for the logo click (must be used with logoimageurl). Need a Gold or higher subscription.
logoimageurl Optional. Specify a custom logo image URL in the upper-left corner of the player (replace the Nimbb logo). Any standard image format is supported. The recommended image size is 100x30 pixels. Need a Gold or higher subscription.
message Optional. Specify a custom string message to be displayed after a video has been recorded when using simplepage=1 (required). Make sure to URL encode your string, for example "message=Thank%20you%20for%20recording%20this%20video!&simplepage=1".
mirror Optional. Mirror the video image so that is it flipped horizontally. Assign the value '1' to activate. Works in View and Record modes. Note that the recorded video file is not mirrored.
mode Optional. Specify the mode of the player ('view' or 'record'). The default is 'view'.
nologo Optional. Hide the Nimbb logo while in playback mode. Assign the value '1' to activate. Need a Silver or higher subscription.
overlayurl Optional. Specify the URL to an overlay image to be displayed over the Nimbb Player. The image must be in 320x240 pixels format and can use transparency. Any standard image format is supported. Need a Gold or higher subscription.
playimageurl Optional. In view mode, set a custom play image by specifying the URL to an image. The image must be in 74x74 pixels format and can use transparency.
playimageurl2 Optional. Second image URL when mouse is over the player to create an animated effect. Requires usage of playimageurl.
playonclick Optional. In view mode, the video playback starts when the video image is clicked. Assign value '1' to activate.
port Optional. Specify on which port should the Nimbb Player connect to our servers. Possible values are 'auto', '1935', '80' and '80t' (uses HTTP tunneling). If param left empty or with "auto", Nimbb tries all possible ports.
quality Optional. Set the level of video quality when recording. Numbers from 1 (low) to 10 (high). The higher the number, the better the video quality but also requires more bandwidth. The default value is 10.
recordlength Optional. The maximum recording time of a video, in seconds.
redirecturl Optional. Specify an URL where to redirect the browser after the video has been saved. The saved guid is also posted as a parameter to the URL and can be ready inside the redirected page.
showcounter Optional. Display ('1') or hide ('0') the counter in Record mode.
showicons Optional. Display ('1') or hide ('0') the icons in the upper-right corner in Record mode (camera and sound icons).
showlabels Optional. If '1', show labels on buttons. If '0', use tooltips. If the player's width is smaller than 320 pixels, this value is automatically set to '0'.
showmenu Optional. Force display ('2'), auto-display on mouse-over ('1', default) or hide ('0') the interface's menu.
showmicrobar Optional. Display ('1') or hide ('0', default) a microphone sound detection bar in Record mode. Player width must be at least 230 pixels. Not displayed if showcounter=0.
simplepage Optional. If '1', display a simple Thank you page after saving the video, instead of the default sharing page.
textcolor Optional. Specify the text color in hexadecimal format (example: 000000).
titlecolor Optional. Specify the title color in hexadecimal format (example: 000000).
volume Optional. Set the video playback volume (values from 0 to 100).

For an example of specifying parameters in your code, see our tutorial or try the Code generator.

SIGN UP NOW 7-day free trial

Check out our Developer guide to get started with Nimbb.