Embedding Parameters
Parameters let you customize the functionality and behavior of your embeddings.
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.
List of parameters
Presentational parameters
All of the parameters that affect the presentation of your embeddings
These parameters might change how something is handled however they are first and foremost going to change the presentational aspect of your embedding.
aspectratiofloatdefault:—Define aspect ratio of container
The aspect ratio will be used when only width or only height is defined.
video player, video recorder
audio-transcription-as-subtitlesbooldefault:falseShow audio transcription as subtitles (if available)
video player
autorecordbooldefault:false(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
audio recorder, image capture, video recorder
countdownintdefault:3Countdown 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.
audio recorder, image capture, video recorder
display-timerbooldefault:trueShow timer to user
Remove any distractions by hiding the recording time. And get insight into recording time without limits.
audio recorder, video recorder
early-rerecordbooldefault:falseEarly re-recording
Let individuals cancel any uploading or processing of recordings so re-recording can begin immediately.
audio recorder, image capture, video recorder
faceoutlinebooldefault:falseShows 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.
image capture, video recorder
flip-camerabooldefault:falseFlip camera horizontally
This enables a mirrored screen which allows for natural orientation during recording. Note: videos are saved in original orientation for easy review.
image capture, video recorder
flipscreenbooldefault:falseToggle screen flipping when you are doing a screen-recording
image capture, video recorder
fullscreenmandatorybooldefault:falseAllow fullscreen on devices where custom controls are not supported
video player
gallerysnapshotsintdefault:3Maximum 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.
audio recorder, image capture, video recorder
heightintdefault:480Height of embedding
This is the height of the embedding itself. It will not impact the recording resolution. Use true number or number with % for variable width. Please do not add any other text behind the number (px or alike).
audio player, audio recorder, image capture, image viewer, video player, video recorder
hidebarafterintdefault:5000Inactivity period in milliseconds
Tells the embedding how long to wait before hiding the controls
image viewer, video player
hideoninactivitybooldefault:trueHide controls on inactivity
Hides the controls of the embedding if the activity was not present for a specific amount of time. This includes the activity from mouse as well as keyboard.
image viewer, video player
hidevolumebarbooldefault:falseHides volume bar
video player
localplaybackbooldefault:falseShow 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)
audio recorder, image capture, video recorder
maxheightintdefault:—Maximum height of the embedding (in pixels)
video player, video recorder
maxwidthintdefault:—Maximum width of the embedding (in pixels)
video player, video recorder
minheightintdefault:240Minimum height of the embedding (in pixels)
video player, video recorder
minwidthintdefault:320Minimum width of the embedding (in pixels)
video player, video recorder
multistreamdraggablebooldefault:trueAllow dragging of stream-in-stream
video recorder
multistreamresizeablebooldefault:falseAllow resizing of stream-in-stream
video recorder
multistreamreversablebooldefault:trueAllow reversability of stream-in-stream
video recorder
nofullscreenbooldefault:falseDisable fullscreen capabilities in video player
image capture, image viewer, video player, video recorder
pickcovershotframebooldefault:falseAllow user to pick any frame as covershot
Let user pick any frame from video to use as covershot, as opposed to selecting from snapshots gallery.
picksnapshotmandatorybooldefault:falseUser has to pick snapshot
video player
picksnapshotsbooldefault:trueAllow selection of snapshots
Let user pick covershots. Disabling this option will make the system automatically selects cover shot.
video recorder
popupbooldefault:falsePlayer pops up after clicking play
image viewer, video player, video recorder
popup-heightintdefault:autoHeight of popup
image viewer, video player, video recorder
popup-stretchbooldefault:falseAllow the popup player to stretch and fill out the full width of the area that it has been given.
image viewer, video player, video recorder
popup-widthintdefault:autoWidth of popup
image viewer, video player, video recorder
posterstringdefault:—Link to image that should be used as poster
The image that is pointed to will be shown with the play icon when embedding loads and before the video is played. This will usually be using image from our server, however you can override it using this parameter and show your own
video player
posterfitstrategystringdefault:cropDefine how poster image should fit inside container
It can be cropped, padded or maintain original resolution
video player, video recorder
primaryrecordbooldefault:trueMake recording primary option
audio recorder, image capture, video recorder
sharevideoarraydefault:autoShow share buttons for social networks
Supported values: 'facebook', 'twitter', 'gplus'
video player
showdurationbooldefault:falseShows duration of the video before the playback starts
Instead of waiting for video to start, your video duration is shown on the image itself
video player
showplayersettingsmenubooldefault:trueAs a property show/hide after recorder player settings from users
video player
showsettingsbooldefault:trueAllow user to change player settings, like playback speed
video player
showsettingsmenubooldefault:trueAs a property show/hide settings from users
video player
skipinitialbooldefault:falseDisable initial screen of recorder
Want to enable camera preview immediately so video recording can begin? Note: permission for camera access may still be required.
audio recorder, image capture, video player, video recorder
skipinitialonrerecordbooldefault:falseDisable 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.
audio recorder, image capture, video recorder
skipsecondsintdefault:5Keyboard left / right key shortcut to seek video
This parameter allows you to set up how many seconds you want to use for the keyboard left and keyboard right keys to skip the video. This operates like seek(current playback time + time you set to skip).
audio player, video player
snapshotmaxintdefault:15Maximum number of snapshots of the recorded video to be collected
video recorder
stickybooldefault:falseStick video to the screen when it scrolls out of view
The sticky video can be moved around by the user so it doesn't block content from the page.
video player
stream-heightintdefault:480Specify optimal stream video height for player (optional)
image viewer, video player
stream-widthintdefault:640Specify optimal stream video width for player (optional)
image viewer, video player
stretchbooldefault:falseAllow 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
image capture, image viewer
themestringdefault:defaultSets 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 <a href='/features/video-player-themes'>video player and recorder themes</a>
audio player, audio recorder, image capture, image viewer, video player, video recorder
themecolorstringdefault:—Sets the theme color of player and recorder
Currently includes red, green and blue.
audio player, audio recorder, image viewer, video player, video recorder
tracktagsarraydefault:—Set the player to show subtitles from your own servers.
Accepts .vtt subtitle file format and it is an array of objects. objects are made out of different parameters you need to pass.
audio player, video player
tracktagsstyledbooldefault:trueShow subtitles in Ziggeo created style
If you set it to false every browser will have its own style shown which will create different UX, so we suggest to leave it on default.
audio player, video player
videofitstrategystringdefault:padDefine how video should fit inside container
It can be cropped, padded or maintain original resolution
video player, video recorder
visualeffectvisiblebooldefault:trueSets the visual effects on or off
audio player, audio recorder
widthintdefault:640Width of embedding
This is the width of the embedding itself. It will not impact the recording resolution. Use true number or number with % for variable width. Please do not add any other text behind the number (px or alike).
audio player, audio recorder, image capture, image viewer, video player, video recorder
Media Management parameters
All of the parameters that help you manage what happens with your media
The following parameters will help you change or get certain workflows to happen. They will offer you ways to manage what is to happen to media that you or your visitors/customers/clients can see.
Just the same they offer you ways for something to happen behind the scenes.
audiobitrateintdefault:autoOverwrite the audio bitrate in kbs
audio recorder, video recorder
auto-cropbooldefault:falseAutomatically 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.
image capture, video recorder
auto-padbooldefault:falseAutomatically pad videos
When set on recorder, videos will 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.
image capture, video recorder
custom-covershotsbooldefault:falseAllow user to upload any image to use as covershot
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. picksnapshots must be true (it already is by default) to be able to use this parameter.
video recorder
default-fallbackbooldefault:falsevideo player
effect-profilearraydefault:—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).
image capture, image viewer, video player, video recorder
enforce-durationbooldefault:falseReject 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.
audio recorder, video recorder
framerateintdefault:25Set the number of frames that should be captured in a single second.
24 frames is least to have fluid movement. Lower framerate will result in strange movement. Above 30 needs to be supported by camera to actually make a difference in video, however higher numbers will always result in larger video sizes.
video recorder
keystringdefault:—Associate key with newly created video
It is added to recorder to set which key should the video be saved under.
audio recorder, image capture, video recorder
maxuploadingheightintdefault:autoMaximal allowed height of uploaded video
image capture, video recorder
maxuploadingwidthintdefault:autoMaximal allowed width of uploaded video
image capture, video recorder
meta-profilestringdefault:—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
audio recorder, image capture, video recorder
microphone-volumefloatdefault:1Microphone volume gain
audio recorder, video recorder
minuploadingheightintdefault:autoMinimal allowed height of uploaded video
image capture, video recorder
minuploadingwidthintdefault:autoMinimal allowed width of uploaded video
image capture, video recorder
noaudiobooldefault:falseDisable recording any sound
By setting this parameter, only video data will be recorded -- all audio will be removed.
video recorder
preview-effect-profilestringdefault:—If applied to recorder, it specifies the effect profile that should be played back in preview after recording
image capture, video recorder
recordingheightintdefault:autoResolution 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).
image capture, video recorder
recordingwidthintdefault:autoResolution 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).
image capture, video recorder
selectfirstcovershotonskipbooldefault:falseAutomated covershot creation when skip is clicked.
When the gallery of snapshots is shown and the person that had recorded the video clicks on skip button and this option is set as true, it will cause the very first frame to be used as cover image.
video recorder
sourcestringdefault:—URL to your own media that you want to show
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.
audio player, image viewer, video player
streamstringdefault:—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.
audio player, image viewer, video player
timelimitintdefault:0Maximum video length
Limits duration of video to ensure videos are recorded within specific timeframe (and not over). Limit is specified in seconds.
audio recorder, video recorder
timeminlimitintdefault:0Minimum 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.
audio recorder, video recorder
transcript-languagestringdefault:en-USSelect language for audio transcription.
By default the audio transcription is done for English language only. Use 'auto' for auto-detection of language instead. This rquires meta profile to be set up and applied for it to be considered.
video recorder
videostringdefault:—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.
video player, video recorder
video-profilestringdefault:—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 recorder
videobitrateintdefault:autoOverwrite the automatic video bitrate in kbs
video recorder
Operational parameters
The list of parameters shown will allow you to modify how your embedding works or behaves
It is always fun changing how things work. Especially if you can do it easily and have it happen in style. All of the parameters here allow you to do just that.
It might be something as simple as showing multiple videos in a list. It could also be something complex, yet so easy to set up as screen recording combined with your camera.
addstreamminheightintdefault:95Specify the minimal height of the additional stream embedding
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreamminwidthintdefault:120Specify the minimal width of the additional stream embedding
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreampositionheightintdefault:95Specify the width of the additional stream embedding
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreampositionwidthintdefault:120Specify the width of the additional stream embedding
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreampositionxintdefault:5Specify the position where the additional stream should be embedded at on the x-axis
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreampositionyintdefault:5Specify the position where the additional stream should be embedded at on the y-axis
This must be a number. Note: Do not add 'px' or other text behind number.
video recorder
addstreamproportionalbooldefault:trueAdd stream-in-stream with proportional aspect-ratio
video recorder
airplaybooldefault:falseAllow Airplay
video player
allowcancelbooldefault:falseAllows user to cancel the upload of a video
audio recorder, video recorder
allowcustomuploadbooldefault:trueAllow 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.
audio recorder, image capture, video recorder
allowedextensionsarraydefault:—Permitted video file extensions that users can upload (optional)
audio recorder, image capture, video recorder
allowmultistreamsbooldefault:falseAllow the user to include multiple streams in one video, e.g. screen recording and camera
video recorder
allowpipbooldefault:falseAllow user to activate picture-in-picture playback
audio player, video player
allowrecordbooldefault:trueAllow recording to be made with your customer's web cam through the embedding
audio recorder, image capture, video recorder
allowscreenbooldefault:falseAllow screen recording instead of via camera (experimental, Firefox, Chrome and Opera only)
video recorder
allowtexttrackuploadbooldefault:falseAllow users to upload subtitles
video player, video recorder
allowtrimbooldefault:falseAllow user to trim the video after recording
Allow user to trim time from the start and/or end of video after recording. Trimming will be skipped if the video format is not supported by the browser.
video recorder
allowuploadbooldefault:trueAllow 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.
audio recorder, image capture, video recorder
applicationstringdefault:—Overwrite default application token
Lets you use one general application token on your page as well as another token for this specific embedding.
audio player, audio recorder, image capture, image viewer, video player, video recorder
audiostringdefault:—Audio token or key
You can either specify the token or a key that represents your audio media. Please remember to add underscore if you are using keys before the key name.
audio player, audio recorder
audio-test-mandatorybooldefault:falseTest microphone before recording
audio recorder, video recorder
autoplaybooldefault:falseAutomatically 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
audio player, audio recorder, video player, video recorder
camerafacefrontbooldefault:falseShould the front face camera be used
This option allows you to set up the embedding to use front facing camera
image capture, video recorder
chromecastbooldefault:falseAllow Chromecast
video player
cpu-friendlybooldefault:falseWill use low CPU of the computer, which could cause low quality of the video.
video recorder
createthumbnailsbooldefault:falseCreates thumbnails of recorded/uploaded video
video recorder
delete-old-streamsbooldefault:falseDelete old streams after re-recording
audio recorder, image capture, video recorder
disablepausebooldefault:falseDisables pausing in the player
audio player, video player
disableseekingbooldefault:falseDisables seeking in the player
audio player, video player
filesizelimitintdefault:—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.
audio recorder, image capture, video recorder
fittodimensionsbooldefault:falseFix precisely to recordingwidth and recordingheight even if not supported natively
video recorder
flashincognitosupportbooldefault:falseAllow 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.
audio recorder, image capture, video recorder
force-overwritebooldefault:trueOverwrite 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.
audio recorder, image capture, video recorder
forceflashbooldefault:falseForces 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.
audio player, audio recorder, image capture, video player, video recorder
forcerefreshbooldefault:falseaudio player, image viewer, video player
framerate-warningbooldefault:falseShow a performance warning when framerate is under this threshold.
video recorder
initialseekfloatdefault:0Initially seek to a position in the video
audio player, video player
lazy-applicationbooldefault:falseAllow an application to be defined after the embeddings are initialized
video player, video recorder
loopbooldefault:falseLoop video playback indefinitely
Setting this parameter will cause your player to loop the video (video starts once it finishes) for infinite loop.
audio player, video player
loopallbooldefault:falseLoop video playlist indefinitely
Setting this parameter will cause your player to loop the playlist.
audio player, video player
manual-uploadbooldefault:falseTrigger 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 <a href='/docs/sdks/javascript/browser-interaction/methods'>Callable Methods</a> for more).
video recorder
manualsubmitbooldefault:falseUser manual submission
Provide the user an option to confirm the submission of their video by clicking a button.
audio recorder, image capture, video recorder
media-orientationstringdefault:—Will allow record only provided option landscape or portrait mode
video recorder
noflashbooldefault:falseForce 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.
audio player, audio recorder, image capture, video player, video recorder
onlyaudiobooldefault:falseOnly record audio, no video.
video recorder
orientationstringdefault:autoForce particular device orientation on mobile ('portrait' or 'landscape')
image capture, video recorder
outsource-selectorsstringdefault:—Add possibility to move camera and mic selection outside of recorder
Selectors should start with cam-* or/and mic-*. Useful with skipinitial option which will get access to the devices sooner. Examples: 'cam-my-own-id-selector;mic-my-own-id-selector' or more options: cam-my-own-id-selector[type='select',disabled=false,showCapabilities=true];mic-my-own-id-selector[type='radio',className='class1 class2 etc']
video recorder
pausablebooldefault:falseAllow user to pause the recording
audio recorder, video recorder
pauseonclickbooldefault:truePause video when user clicks on player if the video is playing
audio player, video player
pauseonplaybooldefault:falsePause playback when another video is being played back
audio player, video player
playermodeifexistsbooldefault:falseRun recorder in player mode if video already exists
If you provide a key or token of existing video, the recorder will become a player instead if this is set to true.
audio recorder, image capture, video recorder
playfullscreenonmobilebooldefault:falseAutomatically play fullscreen on mobile devices
video player
playlistarraydefault:autoAllows 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
audio player, video player
playonclickbooldefault:truePlay video when user clicks on player if the video is paused
audio player, video player
playwhenvisiblebooldefault:falseAutomatically play video once it becomes visible
audio player, video player
preloadbooldefault:falsePreload media data
Instead of loading the media such as video on click, you can start loading it as soon as page opens. This way your video playback, especially of higher resolutions or longer times begins instantly.
audio player, video player
prerollbooldefault:falseShould ad be prerolled?
video player
preventinteractionbooldefault:falsePrevent user interaction after some time in the player
Shows the player, however makes it impossible for someone to click to pause or seek through. Useful in workflows or environments where you want to play the video like in video theaters, background video setups, exams and alike.
video player
recordermodebooldefault:trueTurns the ziggeorecorder embedding into recorder
Recorder can be used as re-recorder or recorder. With this parameter we set it to be recorder only.
audio recorder, image capture, video recorder
recordingsintdefault:autoLimit number of recordings
Specifies number of times someone is able to (re-)record before the video is considered as finalized.
audio recorder, image capture, video recorder
rerecordablebooldefault:autoAllows embedding to be used as re-recorder
Sets if re-recordings can be made. This is true by default for recorders/capture embeddings and by default false for players/viewer embeddings.
audio player, audio recorder, image capture, image viewer, video player, video recorder
rerecordableifexistsbooldefault:trueAllow to re-record video if it already exists
By default if you use a recorder that is set with rerecording options it will allow you to rerecord over it. If you set this parameter as false, it will not allow you to take a new video over existing one.
audio recorder, image capture, video recorder
screenrecordmandatorybooldefault:falseMake screen recording mandatory
Make screen recording mandatory for the user.
video recorder
showaddstreambuttonbooldefault:falseEnable the end-user to select multiple streams in one video, e.g. screen recording and camera
video recorder
simulatebooldefault:falseSimulate 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.
audio recorder, image capture, video recorder
snapshotfrommobilecapturebooldefault:falseLet user pick a snapshot from mobile video capture
video recorder
snapshotfromuploaderbooldefault:falseLet user pick a snapshot from uploaded video files
video recorder
trimoverlaybooldefault:trueDefine if embedding should show trimming overlay or not when allowtrim is set to true.
video recorder
uploadlocalesarraydefault:autoSpecify which locales can be uploaded
This can be used to allow only specific translations to be uploaded. For example: `[{lang: 'en', label: 'English'}, {lang: 'de', label: 'Deutsch'}]` would allow English and Deutsch language files to be uploaded.
video player, video recorder
visibilityfractionfloatdefault:0.8Define when player will automatically start to play video
Define in percentage, what part of the player has to be visible player start automatically start to play video
audio player, video player
volumefloatdefault:1You can use this to set the volume of your video when playback starts
With '0' as a value you would have muted video and with '1' you would have 100% sound volume.
audio player, video player
webrtconmobilebooldefault:falseSet WebRTC to be used on mobile device instead of native camera app
Might not yet be supported on all devices however generally gives you much more control and is part of the page.
audio recorder, video recorder
webrtcstreamingbooldefault:falseSet WebRTC Streaming on your embedding
Allows you to override the setting for a specific embedding regardless of the application wide setup.
audio recorder, video recorder
Data parameters
Want to save some data?
Ziggeo accepts more than just media. We know that sometimes key+words might be just the right thing you needed. All of the parameters here allow you to add your data in one format or the other.
custom-datajsondefault:autoCustom 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.
audio recorder, image capture, video recorder
descriptionstringdefault:—Video description (optional)
Saves any notes or description related to a video.
audio recorder, image capture, video recorder
tagsarraydefault:—Tags (keywords) to associate 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.
audio recorder, image capture, video recorder
titlestringdefault:—Video title (optional)
This is saved next to video as its title, letting you easily obtain the value at a later time. Some themes might also use and display this for you.
audio recorder, image capture, video recorder
Security parameters
Various parameters that help with with AAA aspect of your app (Accounting Authorization Authentication)
Security in the online world is very important. Because of that we have prepared some parameters that help you with the same yet allow you to use them in the way you prefer or see as fit.
client-authstringdefault:—Client-Side Authorization Token
In the event your setup requires tokens to function, place the token locally generated by one of the <a href='/docs/sdks/server-side'>Server Side SDKs</a>.
audio player, audio recorder, image capture, image viewer, video player, video recorder
expiration-daysintdefault:autoAfter 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.
audio recorder, image capture, video recorder
server-authstringdefault:autoServer-Side Authorization Token
In the event your setup requires tokens to function, place the token generated by one of the <a href='/docs/sdks/server-side'>Server Side SDKs</a> -- or one created manually -- here
audio player, audio recorder, image capture, image viewer, video player, video recorder
Form / HTML parameters
Various parameters that make it easier to work with forms and HTML
We know, sometimes you need a way to make things work in combination with the form elements on your page. Maybe you are not allowed adding JavaScript events, or you prefer not to. Regardless of the reason, we have few parameters here, yet helpful for most common scenarios.
form-acceptstringdefault:autoOnly allow form submission (css selector) if video has been recorded
Ziggeo will prevent the submission of the specified form as long as no video has been recorded / uploaded.
audio recorder, image capture, video recorder
input-bindstringdefault:—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.
audio recorder, image capture, video recorder
Various other parameters
Various parameters that do not fit other criteria
Sometimes the image is black and white. Very simple to know what is what. What about when we get some nice shades of gray? Well that would get here. This is a list of parameters that we believe will help you, however do not really go well into any of the categories before.