Documentation

You can embed Ziggeo via both HTML and JavaScript, and all parameters can be used both ways.

The timelimit parameter, for instance, allows you to limit the recording time folks have.

Via HTML, you need to prefix all parameters with *ziggeo-:

   <ziggeorecorder ziggeo-timelimit="10">
   </ziggeorecorder>

Via JavaScript, you use the parameters without any prefix:

  new ZiggeoApi.V2.Player({
    ...,
    attrs: {
      timelimit: 10
    }
  });

For more information on the different methods of embedding Ziggeo, read more here.

  • Presentational parameters
  • width [ int ]
    Default value: 640 Width of embedding This is the width of the embedding itself. It will not impact the recording resolution.
  • height [ int ]
    Default value: 480 Height of embedding This is the height of the embedding itself. It will not impact the recording resolution.
  • responsive [ bool ]
    Embedding maximizes to the size of the bounding box Embedding will do its best to take the maximum available size and stay responsive as the size changes. It is however recommended for pages where the embedding size changes during load times and not as much during recording.
  • popup_width [ int ]
    Default value: 640 Width of popup
  • popup_height [ int ]
    Default value: 480 Height of popup
  • popup [ bool ]
    Player pops up after clicking play
  • face_outline [ bool ]
    Shows outline of face in recorder Indicate placement of face in recorder by adding face outline; it appears during recording only and not in final video.
  • faceoutline [ bool ]
    Shows outline of face in recorder Indicate placement of face in recorder by adding face outline; it appears during recording only and not in final video.
  • audio-transcription-as-subtitles [ boolean ]
    Show audio transcription as subtitles (if available)
  • disable_first_screen [ bool ]
    Disable initial screen of recorder Want to enable camera preview immediately so video recording can begin? Note: permission for camera access may still be required.
  • skipinitial [ bool ]
    Disable initial screen of recorder Want to enable camera preview immediately so video recording can begin? Note: permission for camera access may still be required.
  • skipinitialonrerecord [ bool ]
    Disable initial screen of recorder when re-recording Want to enable camera preview immediately so video recording can begin? Note: permission for camera access may still be required.
  • disable_timer [ bool ]
    Disable showing recording time to user Remove any distractions by hiding the recording time. And get insight into recording time without limits.
  • disable_snapshots [ bool ]
    Disable selection of snapshots System automatically selects cover shot. Default (without this selection) individuals can choose own cover shots.
  • picksnapshots [ bool ]
    Default value: true Allow selection of snapshots Let user pick covershots. Disabling this option will make the system automatically selects cover shot.
  • hide_rerecord_on_snapshots [ bool ]
    Hide re-record button on snapshot page Note: video may still be re-recorded once cover shot is selected (assuming re-recording is enabled).
  • countdown [ int ]
    Default value: 3 Countdown before recording starts (default is 3 seconds, 0 to disable) Set countdown before actual recording starts. As such, once 'record' is hit, countdown will start -- and then actual recording begins once countdown reaches zero. Allows time for individuals to get ready for actual recording.
  • stream_width [ int ]
    Specify optimal stream video width for player (optional)
  • stream-width [ int ]
    Specify optimal stream video width for player (optional)
  • stream_height [ int ]
    Specify optimal stream video height for player (optional)
  • stream-height [ int ]
    Specify optimal stream video height for player (optional)
  • default_image_selector [ float ]
    Default cover shot selector (optional) Specify in percentages at which point cover shot should be taken from video. 0 indicates the very start; 0.5 indicates the middle of the video; 1 indicates the end of the video.
  • performance_warning [ bool ]
    Show a performance warning when framerate is low Display so warning is known.
  • nofullscreen [ bool ]
    Disable fullscreen capabilities in video player
  • snapshotmax [ int ]
    Default value: 15 Maximum number of snapshots of the recorded video to be collected
  • gallerysnapshots [ int ]
    Default value: 3 Maximum number of snapshots shown This is the maximum number of snapshots to be shown after recording on the single page. This determines if there will be multiple pages of snapshots shown, or only a single one.
  • localplayback [ bool ]
    Show the preview of the video after recording the same Allows you to show the preview while the video is being uploaded in the background (WebRTC only)
  • stretch [ bool ]
    Allow the player to stretch and fill out the full width of the area that it has been given. Great option for mobile responsiveness as it will resize itself to match the size of the element that it is embedded into. It may cause your video to seem cut off if the size of the embedding does not match the resolution of the video
  • theme [ string ]
    Default value: default Sets the theme of player and recorder V2 embeddings can be styled manually and with a theme. Themes allow you to quickly switch between various styles with a single parameter value. Follow next link to see all video player and recorder themes
  • themecolor [ string ]
    Sets the theme color of player and recorder Currently includes red, green and blue.
  • autorecord [ bool ]
    (try to) start the recording as soon as the embedding is shown Start recording automatically as the embedding shows or as soon as camera access is granted
  • primaryrecord [ bool ]
    Default value: true Make recording primary option
  • flip_camera [ bool ]
    Flip camera vertically This enables a mirrored screen which allows for natural orientation during recording. Note: videos are saved in original orientation for easy review.
  • flip-camera [ bool ]
    Flip camera vertically This enables a mirrored screen which allows for natural orientation during recording. Note: videos are saved in original orientation for easy review.
  • early_rerecord [ bool ]
    Early re-recording Let individuals cancel any uploading or processing of recordings so re-recording can begin immediately.
  • early-rerecord [ bool ]
    Early re-recording Let individuals cancel any uploading or processing of recordings so re-recording can begin immediately.
  • sharevideo [ array ]
    Default value: Show share buttons for social networks Supported values: 'facebook', 'twitter', 'gplus'
  • Security parameters
  • server_auth [ string ]
    Server-Side Authorization Token In the event your setup requires tokens to function, place the token generated by one of the Server Side SDKs -- or one created manually -- here
  • server-auth [ string ]
    Server-Side Authorization Token In the event your setup requires tokens to function, place the token generated by one of the Server Side SDKs -- or one created manually -- here
  • client_auth [ string ]
    Client-Side Authorization Token In the event your setup requires tokens to function, place the token locally generated by one of the Server Side SDKs.
  • client-auth [ string ]
    Client-Side Authorization Token In the event your setup requires tokens to function, place the token locally generated by one of the Server Side SDKs.
  • expiration_days [ int ]
    After how many days should video automatically be deleted? (disabled by default) Setting 0 indicates videos may only be deleted manually; setting it to x number of days means Ziggeo’s system will automatically delete videos after the specified number of days.
  • expiration-days [ int ]
    After how many days should video automatically be deleted? (disabled by default) Setting 0 indicates videos may only be deleted manually; setting it to x number of days means Ziggeo’s system will automatically delete videos after the specified number of days.
  • Video management parameters
  • recording_width [ int ]
    Default value: 640 Resolution width of the recording This is the resolution of the recording itself. Lower resolutions mean faster uploads. Recommended: set to maximum recording resolution indicated in your Video Profiles set up (e.g. HD Video Profiles set to HD).
  • recordingwidth [ int ]
    Default value: 640 Resolution width of the recording This is the resolution of the recording itself. Lower resolutions mean faster uploads. Recommended: set to maximum recording resolution indicated in your Video Profiles set up (e.g. HD Video Profiles set to HD).
  • recording_height [ int ]
    Default value: 480 Resolution height of the recording This is the resolution of the recording itself. Lower resolutions mean faster uploads. Recommended: set to maximum recording resolution indicated in your Video Profiles set up (e.g. HD Video Profiles set to HD).
  • recordingheight [ int ]
    Default value: 480 Resolution height of the recording This is the resolution of the recording itself. Lower resolutions mean faster uploads. Recommended: set to maximum recording resolution indicated in your Video Profiles set up (e.g. HD Video Profiles set to HD).
  • video [ string ]
    Video token or key When adding a token, add it as is. When adding a key, add an underscore ( _ ) in front of it first (even if your key starts with one), e.g. if your key is 'my_key' -- add it as '_my_key' when adding it to video attribute.
  • stream [ string ]
    Stream token or key Useful for video player only. Lets you specify the exact stream to run in your player -- or a particular video effect.
  • effect_profile [ array ]
    If applied to recorder, specifies all effect profiles that should be applied; if applied to player, specifies the prefered effect profile Different effects may be applied — streams are created with each effect profile indicated in recorder embedding. When particular effects are specified in the video player, such effects are played. (assuming effect was set during recording — if no such effect was originally set, it would not be available afterwards).
  • effect-profile [ array ]
    If applied to recorder, specifies all effect profiles that should be applied; if applied to player, specifies the prefered effect profile Different effects may be applied — streams are created with each effect profile indicated in recorder embedding. When particular effects are specified in the video player, such effects are played. (assuming effect was set during recording — if no such effect was originally set, it would not be available afterwards).
  • preview-effect-profile [ string ]
    If applied to recorder, it specifies the effect profile that should be played back in preview after recording
  • auto_crop [ bool ]
    Automatically crop videos When set on recorder, videos will be automatically cropped as needed. As such, top and bottom could be cut off if too large; same with width. Depends on video resolution.
  • auto-crop [ bool ]
    Automatically crop videos When set on recorder, videos will be automatically cropped as needed. As such, top and bottom could be cut off if too large; same with width. Depends on video resolution.
  • auto_pad [ bool ]
    Automatically pad videos When set on recorder, videos wiill be automatically padded on the top and bottom and/or left and right. This will make your recorder auto pad the videos on top and bottom or left and right. As such, instead of cutting video, padding will be added to fill out required parts.
  • auto-pad [ bool ]
    Automatically pad videos When set on recorder, videos wiill be automatically padded on the top and bottom and/or left and right. This will make your recorder auto pad the videos on top and bottom or left and right. As such, instead of cutting video, padding will be added to fill out required parts.
  • key [ string ]
    Associate key with newly created video It is added to recorder to set which key should the video be saved under.
  • limit [ int ]
    Maximum video length Limits duration of video to ensure videos are recorded within specific timeframe (and not over). Limit is specified in seconds.
  • timelimit [ int ]
    Maximum video length Limits duration of video to ensure videos are recorded within specific timeframe (and not over). Limit is specified in seconds.
  • minlimit [ int ]
    Minimum video length If video length should be at least some minimum amount of time, use this parameter. The value presented refers to number of seconds the video should last.
  • timeminlimit [ int ]
    Minimum video length If video length should be at least some minimum amount of time, use this parameter. The value presented refers to number of seconds the video should last.
  • video_profile [ string ]
    Specify key or token for video profile (optional) Video profiles specify your own SD or HD resolution -- and ensure transcodings are prepared with the indicated resolution. If you are specifying a key, add an underscore before its name in this parameter, otherwise if it is token, add it as it is. Purpose: in recorder it tells our servers which profile to apply to recorded video -- and in player it indicates which profile to use for playback.
  • video-profile [ string ]
    Specify key or token for video profile (optional) Video profiles specify your own SD or HD resolution -- and ensure transcodings are prepared with the indicated resolution. If you are specifying a key, add an underscore before its name in this parameter, otherwise if it is token, add it as it is. Purpose: in recorder it tells our servers which profile to apply to recorded video -- and in player it indicates which profile to use for playback.
  • meta_profile [ string ]
    Specify key or token for meta profile (optional) Meta profile lets you specify which meta actions (like audio transcription / visual analysis) should be taken once video is recorded
  • meta-profile [ string ]
    Specify key or token for meta profile (optional) Meta profile lets you specify which meta actions (like audio transcription / visual analysis) should be taken once video is recorded
  • enforce_duration [ bool ]
    Reject videos that are too long instead of auto-cropping them Rather than cropping video to fit desired time frame (the default state), videos will be rejected.
  • enforce-duration [ bool ]
    Reject videos that are too long instead of auto-cropping them Rather than cropping video to fit desired time frame (the default state), videos will be rejected.
  • nosound [ bool ]
    Disable recording any sound By setting this parameter, only video data will be recorded -- all audio will be removed.
  • noaudio [ bool ]
    Disable recording any sound By setting this parameter, only video data will be recorded -- all audio will be removed.
  • allowscreen [ bool ]
    Allow screen recording instead of via camera (experimental, Firefox, Chrome and Opera only)
  • source [ string ]
    URL to your own video that you want to play This option allows you to specify your own location of the videos and then have them played back from the same location. For best experience we still recommend using videos from your Ziggeo storage, however with this option it is completely up to you.
  • framerate [ int ]
    Default value: 25 Set the framerate that you want to be used during recording
  • videobitrate [ int ]
    Default value: auto Overwrite the automatic video bitrate in kbs
  • audiobitrate [ int ]
    Default value: auto Overwrite the audio bitrate in kbs
  • microphone_volume [ float ]
    Default value: 1 Microphone volume gain
  • microphone-volume [ float ]
    Default value: 1 Microphone volume gain
  • custom-covershots [ bool ]
    Custom cover shots For the best look of your custom snapshots it is best that the image chosen is either the same resolution as your recording or higher.
  • Data parameters
  • tags [ array ]
    Tags associated with newly created video Since you can use tags to do searches through index() function this is an ideal way to help you find the video in both the administration panel and through code.
  • data [ json ]
    Custom data associated with newly created video This accepts any amount of desired data next to the video as long as the data is saved in proper JSON format.
  • custom-data [ json ]
    Custom data associated with newly created video This accepts any amount of desired data next to the video as long as the data is saved in proper JSON format.
  • title [ string ]
    Video title (optional) This is saved next to video as its title, letting you easily obtain the value at a later time.
  • description [ string ]
    Video description (optional) Saves any notes or description related to a video.
  • Operational parameters
  • manual_upload [ bool ]
    Trigger the uploading of a selected video file manually This will cause your embedding to allow file to be selected, however it will not start the upload itself. To start the upload, call the `embedding.upload();` method (see Callable Methods for more).
  • orientation [ string ]
    Force particular device orientation on mobile ('portrait' or 'landscape')
  • modes [ array ]
    Permitted embedding modes
    • recorder Allows embedding to be used as recorder
    • player Allows embedding to be used as player
    • rerecorder Allows embedding to be used as re-recorder
    This lets you fine tune presentation and features associated with your video embedding.If it is a re-recorder, it means that original video can be replaced with a new one (which would be great for profile video, not as much for public gallery). By default it will act as recorder, unless the video token is given, when by default it would be a player.
  • rerecordable [ bool ]
    Allows embedding to be used as re-recorder Instead of setting 'modes' parameter to specify that your embedding should allow re-recording to be made, in v2 you can simply specify this parameter to allow it to make re-recordings. It will work on recorder embedding only.
  • perms [ array ]
    Video permissions
    • allowupload Enable uploading of custom videos
    • forbidrecord Disable webcam recording
    • forbidswitch Disable switching between uploading and recording
    • forbidrerecord Disable re-recording
    • forceoverwrite Overwrite videos with existing keys
    Permissions parameter allows you to fine tune what the embedding can do. This allows you to set it up that it can not overwrite existing video, or that video must be recorded through a camera, rather than upload. Alternatively it can be used to also make the embedding as uploader rather than recorder.
  • allowupload [ bool ]
    Default value: true Allow uploading of custom user videos through your embedding If by some chance your customers do not have web cam, you can always let them slide by giving them the option to upload some existing video instead.
  • allowrecord [ bool ]
    Default value: true Allow recording to be made with your customer's web cam through the embedding
  • force-overwrite [ bool ]
    Default value: true Overwrite videos with existing keys If the video with same key already exist, you can still overwrite it by specifying this parameter. It allows you to avoid accidental overwrites and have a better control of what happens with your videos.
  • disable_device_test [ bool ]
    Disable testing microphone and camera before recording
  • id [ string ]
    ID of embedding to look up via JS (via ZiggeoApi.Embed.get('id')) This allows you to look up the embedding via this id using JavaScript.
  • immediate_playback [ bool ]
    Immediately and automatically play back video after recording This option allows you to specify that your recorder should play back the recorded video automatically after recording.
  • autoplay [ bool ]
    Automatically start video playback Starts video playback as soon as player loads -- it’s the ideal option for making videos play once page loads or after the embedding has been created
  • loop [ bool ]
    Loop video playback indefinitely Setting this parameter will cause your player to loop the video (video starts once it finishes) for infinite loop.
  • recordings [ int ]
    Default value: null Limit number of recordings Specifies number of times someone is able to (re-)record before the video is considered as finalized.
  • rerecordings [ int ]
    Limit number of re-recordings Specifies number of times someone is able to re-record before the video is considered as finalized.
  • allowed_extensions [ array ]
    Permitted video file extensions that users can upload (optional)
  • allowedextensions [ array ]
    Permitted video file extensions that users can upload (optional)
  • apitoken [ string ]
    Overwrite default application token Lets you use one general application token on your page as well as another token for this specific embedding.
  • application [ string ]
    Overwrite default application token Lets you use one general application token on your page as well as another token for this specific embedding.
  • limit_upload_size [ int ]
    Limit size of uploaded videos (in bytes -- no limit by default) 0 sets it to no limit, while any number will represent bytes at which time you want to forbid the size. 1 MB = 1024 * 1024 bytes, so a limit of 20MB would be 20*1024*1024 = 20,971,520, which would be written as 20971520.
  • filesizelimit [ int ]
    Limit size of uploaded videos (in bytes -- no limit by default) 0 sets it to no limit, while any number will represent bytes at which time you want to forbid the size. 1 MB = 1024 * 1024 bytes, so a limit of 20MB would be 20*1024*1024 = 20,971,520, which would be written as 20971520.
  • incognito [ bool ]
    Allow access to camera in incognito / private sessions Useful when embedding is opened within Incognito or Private windows - when otherwise the camera would not be able to record.
  • flashincognitosupport [ bool ]
    Allow access to camera in incognito / private sessions Useful when embedding is opened within Incognito or Private windows - when otherwise the camera would not be able to record.
  • simulate [ bool ]
    Simulate recording experience without actually recording it Lets your community record a test video that's not saved -- or use it for custom testing while developing video recording events locally.
  • allowcustomupload [ bool ]
    Default value: true Allow uploading of any files This allows you to use your embedding to upload any type of file, even if it is not recognized as video.
  • recordermode [ bool ]
    Default value: true Turns the ziggeorecorder embedding into recorder Recorder can be used as re-recorder or recorder. With this parameter we set it to be recorder only.
  • forceflash [ bool ]
    Forces flash to be used for recording and playback Even if your headers are set to use WebRTC the embedding with this parameter will ignore it and use flash instead.
  • noflash [ bool ]
    Force embedding not to use flash Makes the embedding show error if it can not use anything other than flash and it is set to use WebRTC.
  • manualsubmit [ bool ]
    User manual submission Provide the user an option to confirm the submission of their video by clicking a button.
  • initialseek [ float ]
    Initially seek to a position in the video
  • playfullscreenonmobile [ bool ]
    Automatically play fullscreen on mobile devices
  • playwhenvisible [ bool ]
    Automatically play video once it becomes visible
  • playonclick [ bool ]
    Default value: true Play video when clicking anywhere on the player
  • disableseeking [ bool ]
    Disables seeking in the player
  • disablepause [ bool ]
    Disables pausing in the player
  • pauseonplay [ bool ]
    Pause playback when another video is being played back
  • onlyaudio [ bool ]
    Only record audio, no video.
  • airplay [ bool ]
    Allow Airplay
  • chromecast [ bool ]
    Allow Chromecast
  • preload [ bool ]
    Preload videos on the v2 player
  • delete_old_streams [ bool ]
    Delete old streams after re-recording
  • delete-old-streams [ bool ]
    Delete old streams after re-recording
  • lazy-application [ bool ]
    Allow an application to be defined after the embeddings are initialized
  • allowcancel [ bool ]
    Allows user to cancel the upload of a video
  • playlist [ array ]
    Allows you to create a video playlist Allows you to add multiple video tokens which are turned into playlist where one video plays after another automatically
  • Form and HTML parameters
  • input_bind [ string ]
    Bind video token to form input field by given name Once the video is recorded, the SDK will search for a form field with this name and copy the token into the field.
  • form_accept [ string ]
    Only allow form submission (css selector) if video has been recorded Ziggeo will prevent the submission of the specifed form as long as no video has been recorded / uploaded.
  • input-bind [ string ]
    Bind video token to form input field by given name Once the video is recorded, the SDK will search for a form field with this name and copy the token into the field.
  • form-accept [ string ]
    Only allow form submission (css selector) if video has been recorded Ziggeo will prevent the submission of the specifed form as long as no video has been recorded / uploaded.