Documentation

  • JavaScript Version
  • JavaScript Revision

Regardless of what embedding you are using, the parameter are always the same.

When using HTML embed methods, all parameters should be prefixed with ziggeo-

This tells our SDK that these are not HTML tags that it should ignore, rather the instructions on how to create the video player, or video recorder on your website.

In JavaScript however, this is not needed, so you just add the parameters as they are.

  • Presentational parameters
  • width [ int ]
    Default value: 640 Width of the embedding This is the width of the embedding itself. It will not impact the width of the video that is recorded in any way regardless of its size.
  • height [ int ]
    Default value: 480 Height of the embedding This is the height of the embedding itself. It will not impact the height of the video that is recorded in any way regardless of its size.
  • 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 the popup Like the popup parameter, this will only work on video player. It will not work on recorder or rerecorder.
  • popup_height [ int ]
    Default value: 480 Height of the popup Like the popup parameter, this will only work on video player. It will not work on recorder or rerecorder.
  • popup [ bool ]
    Popup the player after clicking on play The popup parameter will only work on video player. It will not work on recorder or rerecorder.
  • face_outline [ bool ]
    Show the outline of a face in the recorder Recorder gets added the outline which shows everyone recording a video what would be the best placement of them in the video. It will work during recording, however it will not be part of the video itself afterwards.
  • disable_first_screen [ bool ]
    Disable the initial screen of the recorder If you want your video recorder to start with the view of the camera, instead of asking if your customers want to record or upload a video, this is the option to use. It removes all buttons and goes straight away to camera preview (it requires that the access to the same is given first - so it pops the questions).
  • skipinitial [ bool ]
    Disable the initial screen of the recorder If you want your video recorder to start with the view of the camera, instead of asking if your customers want to record or upload a video, this is the option to use. It removes all buttons and goes straight away to camera preview (it requires that the access to the same is given first - so it pops the questions).
  • disable_timer [ bool ]
    Disable showing the recording time to the user Sometimes it is more relaxing to leave someone say what they want without showing them how long they were recording for. It also gives you an insight into how long someone takes without any supervision to reply to the given set of questions.
  • disable_snapshots [ bool ]
    Disable selection of snapshots By default, after the video recording is done, you can select which part of the video you would like to have as your video snapshot. By disabling this, this option would not be given to the person recording a video, and instead the system would pick one up for them.
  • picksnapshots [ bool ]
    Default value: true Allow selection of snapshots By default, after the video recording is done, you can select which part of the video you would like to have as your video snapshot. By disabling this, this option would not be given to the person recording a video, and instead the system would pick one up for them.
  • hide_rerecord_on_snapshots [ bool ]
    Hide rerecord button on snapshot page If you want to have your customer check out the video first, then you can disable the re-record button on snpashot page. After picking the snapshot the video would be uploaded and after watching it, they could still re-record (if your setup allows re-recordings to be made).
  • countdown [ int ]
    Default value: 3 Countdown before recording starts (default is 3 seconds, 0 to disable) Sets the number of seconds that the recorder should wait before the actual recording starts after clicking on the record button, giving time to people to get ready.
  • stream_width [ int ]
    Specify the optimal stream video width for the player (optional)
  • stream-width [ int ]
    Specify the optimal stream video width for the player (optional)
  • stream_height [ int ]
    Specify the optimal stream video height for the player (optional)
  • stream-height [ int ]
    Specify the optimal stream video height for the player (optional)
  • default_image_selector [ float ]
    Default cover shot selector (optional) Specify in percentages where the snapshot should be made from in the video. 0 indicates the very start. 0.5 means at the middle of the video, while 1 means the end of the video.
  • performance_warning [ bool ]
    Show a performance warning when the framerate is low This is shown to the people recording video so that they are aware of the same.
  • 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 parameter will make the recording experience easier by showing you mirrored screen allowing people to naturally point and orient themselves during recording. Your videos would however still be saved in original orientation so that it easy for you to review them.
  • flip-camera [ bool ]
    Flip camera vertically This parameter will make the recording experience easier by showing you mirrored screen allowing people to naturally point and orient themselves during recording. Your videos would however still be saved in original orientation so that it easy for you to review them.
  • early_rerecord [ bool ]
    Early re-recording Allow the user to cancel any uploading / processing of the current recording and start over immediately.
  • early-rerecord [ bool ]
    Early re-recording Allow the user to cancel any uploading / processing of the current recording and start over 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 If your setup requires tokens to be able to function, you would place here the token created by one of the Server Side SDKs
  • server-auth [ string ]
    Server-Side Authorization Token If your setup requires tokens to be able to function, you would place here the token created by one of the Server Side SDKs
  • client_auth [ string ]
    Client-Side Authorization Token If your setup requires tokens, to be able to function, you would place here the token created by JavaScript SDK or the one you created manually.
  • client-auth [ string ]
    Client-Side Authorization Token If your setup requires tokens, to be able to function, you would place here the token created by JavaScript SDK or the one you created manually.
  • expiration_days [ int ]
    After how many days should the video automatically be deleted? (disabled by default) Setting 0 will mean that your videos will only be deleted manually, while setting it with x number of days will mean that our system will delete the videos for you at the specified days interval.
  • expiration-days [ int ]
    After how many days should the video automatically be deleted? (disabled by default) Setting 0 will mean that your videos will only be deleted manually, while setting it with x number of days will mean that our system will delete the videos for you at the specified days interval.
  • Video management parameters
  • recording_width [ int ]
    Default value: 640 Resolution width of the recording This is the width of the recording itself. Setting this up determines the size of the video recorded. Smaller sizes mean faster uploads, however it is recommended to set it to minimal size of the video recording resolution that you are using in your Video Profiles setup - so if you are using HD Video Profiles, this should be left as is, or set to the same HD resolution width
  • recordingwidth [ int ]
    Default value: 640 Resolution width of the recording This is the width of the recording itself. Setting this up determines the size of the video recorded. Smaller sizes mean faster uploads, however it is recommended to set it to minimal size of the video recording resolution that you are using in your Video Profiles setup - so if you are using HD Video Profiles, this should be left as is, or set to the same HD resolution width
  • recording_height [ int ]
    Default value: 480 Resolution height of the recording This is the height of the recording itself. Setting this up determines the size of the video recorded. Smaller sizes mean faster uploads, however it is recommended to set it to minimal size of the video recording resolution that you are using in your Video Profiles setup - so if you are using HD Video Profiles, this should be left as is, or set to the same HD resolution height
  • recordingheight [ int ]
    Default value: 480 Resolution height of the recording This is the height of the recording itself. Setting this up determines the size of the video recorded. Smaller sizes mean faster uploads, however it is recommended to set it to minimal size of the video recording resolution that you are using in your Video Profiles setup - so if you are using HD Video Profiles, this should be left as is, or set to the same HD resolution height
  • video [ string ]
    Video token or key When you are adding token, you should add it as is. When you are adding key you should add underscore ( _ ) in front of it first (even if your key starts with one), so if your key is 'my_key' when adding it to video token it should be added as '_my_key'.
  • stream [ string ]
    Stream token or key Useful for player only. It allows you to specify the exact stream that you wish to play in your video player (For example, the one with your logo or the one with logo 2? Maybe a video with effect? That is what stream can help with.
  • effect_profile [ array ]
    If applied to a recorder, specifies all effect profiles that should be applied; if applied to a player, specifies the prefered effect profile It is possible for you to want to have different effects applied, so we create streams with all of the effect profiles that you have mentioned in recorder embedding. When you specify the effect later on in the player, this tells us to search for the specific effect on that video and play it with the same. It does however require that the effect was set during recording, otherwise the same effect would not be available for it afterwards.
  • effect-profile [ array ]
    If applied to a recorder, specifies all effect profiles that should be applied; if applied to a player, specifies the prefered effect profile It is possible for you to want to have different effects applied, so we create streams with all of the effect profiles that you have mentioned in recorder embedding. When you specify the effect later on in the player, this tells us to search for the specific effect on that video and play it with the same. It does however require that the effect was set during recording, otherwise the same effect would not be available for it afterwards.
  • auto_crop [ bool ]
    Automatically crop videos When set on recorder, this will make your recorder auto crop the videos where needed. What this means is that top and bottom could end up cut off if they are too large. The same applies to width and depends on videos resolution.
  • auto-crop [ bool ]
    Automatically crop videos When set on recorder, this will make your recorder auto crop the videos where needed. What this means is that top and bottom could end up cut off if they are too large. The same applies to width and depends on videos resolution.
  • auto_pad [ bool ]
    Automatically pad videos When set on recorder, this will make your recorder auto pad the videos on top and bottom or left and right. What this means is that instead of video getting cut, extra padding will be added to keep entire video and fill out the parts that are not satisfying the resolution with the padding.
  • auto-pad [ bool ]
    Automatically pad videos When set on recorder, this will make your recorder auto pad the videos on top and bottom or left and right. What this means is that instead of video getting cut, extra padding will be added to keep entire video and fill out the parts that are not satisfying the resolution with the padding.
  • key [ string ]
    Key that a newly created video should be associated with It is added to recorder to set which key should the video be saved under.
  • limit [ int ]
    Maximum duration of video Limits the duration of the video making sure that your customers record videos up to specific timeframe and not to go over the same. The limit is specified in seconds
  • timelimit [ int ]
    Maximum duration of video Limits the duration of the video making sure that your customers record videos up to specific timeframe and not to go over the same. The limit is specified in seconds
  • minlimit [ int ]
    Minimum duration of video If you want to make the video length of at least some minimum amount of time, this is the setup that you should use. The value is presented in number of seconds that the video should last.
  • timeminlimit [ int ]
    Minimum duration of video If you want to make the video length of at least some minimum amount of time, this is the setup that you should use. The value is presented in number of seconds that the video should last.
  • video_profile [ string ]
    Specify the video profile by key or token that you want to be used (optional) Video profiles allow you to specify your own resolution SD or HD and allow you to have your recordings prepared with the specified resolution. If you are specifying a key, then you would need to add underscore before its name in this parameter, otherwise if it is token, you can just add it as it is. In recorder it tells our servers which profile to apply to recorded video and in player it says which profile to use for playback.
  • video-profile [ string ]
    Specify the video profile by key or token that you want to be used (optional) Video profiles allow you to specify your own resolution SD or HD and allow you to have your recordings prepared with the specified resolution. If you are specifying a key, then you would need to add underscore before its name in this parameter, otherwise if it is token, you can just add it as it is. In recorder it tells our servers which profile to apply to recorded video and in player it says which profile to use for playback.
  • meta_profile [ string ]
    Specify the meta profile by key or token that you want to be used (optional) Meta profile allows you to specify which meta actions should be taken once video gets recorded
  • meta-profile [ string ]
    Specify the meta profile by key or token that you want to be used (optional) Meta profile allows you to specify which meta actions should be taken once video gets recorded
  • enforce_duration [ bool ]
    Reject videos that are too long instead of auto-cropping them By default we will detect that the video is longer than what you specified in the limit attribute and cut the video at the desired time. With this parameter set to true, you will actually reject all videos that are longer than what you set.
  • enforce-duration [ bool ]
    Reject videos that are too long instead of auto-cropping them By default we will detect that the video is longer than what you specified in the timelimit attribute and cut the video at the desired time. With this parameter set to true, you will actually reject all videos that are longer than what you set.
  • nosound [ bool ]
    Disable recording any sound If this parameter is present, only video data will be recorded while audio will be removed completely.
  • noaudio [ bool ]
    Disable recording any sound If this parameter is present, only video data will be recorded while audio will be removed completely.
  • 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 that a newly created video should be associated with Since you can use tags to do searches through index() function this is a great way to help you find the video in both administration panel and through code. For more on how they can help you, check out our @TODO - add API LINK HERE
  • data [ json ]
    Custom data that a newly created video should be associated with This accepts any amount of data that you want to have saved next to the video as long as the data is saved in proper JSON format.
  • custom-data [ json ]
    Custom data that a newly created video should be associated with This accepts any amount of data that you want to have saved 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, allowing you to easily grab the same value at the later time.
  • description [ string ]
    Video description (optional) Saves any notes or description related to the video.
  • Operational parameters
  • manual_upload [ bool ]
    Trigger the uploading of a selected video file manually Setting this up will cause your embedding to allow file to be selected, however it will not start the upload itself. To start the upload you would need to call the `embedding.upload();` method (see Callable Methods for more).
  • modes [ array ]
    Allowed modes for embedding
    • recorder Allows the embedding to be used as recorder
    • player Allows the embedding to be used as player
    • rerecorder Allows the embedding to be used as rerecorder
    This allows you to fine tune how your video embedding should be presented and what features would it offer. 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 the 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 user videos
    • forbidrecord Disable recording using the user's webcam
    • forbidswitch Disable switching between uploading and recording
    • forbidrerecord Disable rerecording
    • 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. Althernatively 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 the user
  • id [ string ]
    ID of embedding to look it up (via ZiggeoApi.Embed.get('id')) This is not to be mistaken for HTML element ID. It allows you to specify the embedding ID so that you can use this later on to call it or change some settings about the same.
  • 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 after recording and having the video uploaded to our servers.
  • autoplay [ bool ]
    Automatically play back video in the player Starts the playback of the video as soon as the player loads, making it a great option to use if you want your videos to start on page load or after the embedding has been created.
  • loop [ bool ]
    Loop video playback indefinitely Setting it up will cause your player to loop the video (start the video from start once it reaches finish) causing video to act as infinite animation
  • recordings [ int ]
    Default value: null Number of recordings that can be made This is the limit of the recordings that you can make at one go. This includes first recording and rerecordings. There is no limit by default.
  • rerecordings [ int ]
    Limit the number of rerecordings Allows you to specify how many times someone can re-record themselves before the video is considered as finalized. This is similar to recordings parameter, however this does not count the first recording - only the re-recordings which are made afterwards. * You can use either of the 2 parameters, however we do not recommend using both.
  • allowed_extensions [ array ]
    Allowed video file extensions that a user can upload (optional)
  • allowedextensions [ array ]
    Allowed video file extensions that a user can upload (optional)
  • apitoken [ string ]
    Overwrite default application token Allows you to use one application token in general on your page and then to specify another token for the specific embedding.
  • application [ string ]
    Overwrite default application token Allows you to use one application token in general on your page and then to specify another token for the specific embedding.
  • limit_upload_size [ int ]
    Limit the size of videos being uploaded (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 mebagyte = 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 the size of videos being uploaded (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 mebagyte = 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 through flash.
  • 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 through flash.
  • simulate [ bool ]
    Simulate recording experience without actually recording it Allow your customers to record a test video that is never saved or use it for custom testing while you develop video recording events on your side.
  • 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 explicitly submit the video.
  • initialseek [ float ]
    Initially seek to a position in the video
  • playfullscreenonmobile [ bool ]
    Automatically play fullscreen on mobile devices
  • Form and HTML parameters
  • input_bind [ string ]
    Bind video token to form input field by given name Once the video is recorded, if this is set, SDK will search for this name and add the token into the same field.
  • form_accept [ string ]
    Only allow form submission (jquery selector) if video has been recorded You would be providing jQuery selector for the form that you want to 'freeze' until the video is recorded. This would allow you to stop the default form submission action by checking if the video is recorded first. Once it is recorded, SDK will allow submission to be made.
  • input-bind [ string ]
    Bind video token to form input field by given name Once the video is recorded, if this is set, SDK will search for this name and add the token into the same field.
  • form-accept [ string ]
    Only allow form submission (jquery selector) if video has been recorded You would be providing jQuery selector for the form that you want to 'freeze' until the video is recorded. This would allow you to stop the default form submission action by checking if the video is recorded first. Once it is recorded, SDK will allow submission to be made.