Camera Tag: WebRTC Recording and Video Processing Service, JS Library and API

You can also view

You are viewing documentation for version 10. This version is antiquated!
The current version is version 13

Introduction

Overview New in V10 Browser Support

Apps

Overview Setup Advanced Config

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Videos

Overview Embedding Configuration JS Methods & Events

Overview Embedding Configuration JS Methods

Overview Embedding Configuration Custom Interface JS Methods JS Events

<photo>

Overview Embedding

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Audio

REST API

Overview List Assets Show Asset Update Asset Delete Asset List Apps Show App Create App Update App Video Object Photo Object Audio Object

Advanced Camera Configuration

Beyond the two required settings for a <camera> there are several optional advanced settings. You can configure these using our Embed Sandbox by clicking on the link labled "Advanced Configuration" or by using data attributes on your own hand-rolled <camera>

App
ID
Width
Height
Name
Description
Metadata
Sources
Default Mobile Camera
Preroll Count
Max Length
Min Length
Video Bitrate
Audio Bitrate
Autopreview After Record
Upload On File Select
Auto-Publish on Upload
Start Recording after Connect
Use Simple Flash Security Box
Mirror Image During Recording
Poll Server For Processed Event
Default SMS Country
Default SMS Message
Enforce Length Restrictions for Mobile Uploads
Recording Stack
Signature
Sigature Expiration

App

Choose the CameraTag App with which this camera should work

<camera id='MyRecorder1' data-app-id=''></camera>

ID

A unique identifiuer for this camera (in case you have more than one on the page) The default value is "myCamera"

<camera id='myCamera' data-app-id='[YOUR_APP_UUID]'></camera>

Width

Width of the camera as integer or percentage (if left blank the player will be sized to one half the recording resoluion)

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-width=''></camera>

Height

Height of the camera as integer (if left blank the player will be sized to one half the recording resoluion)

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-height=''></camera>

Name

A human friendly name for the video to be recorded by this camera. This will be visible in your CameraTag admin and on YouTube (if you have YouTube export enabled)

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-name='Billy Birthday Wish'></camera>

Description

A description for the video to be recorded by this camera. This will be visible in your CameraTag admin and on YouTube (if you have YouTube export enabled)

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-description='Billy wishes grandma a very happy birthday during his soccer game.'></camera>

Metadata

A JSON string to be stored along with the video. This data will be made available in the server callback and the REST API. **Value must be validly formatted JSON (using double quotes)

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-metadata='{"user_id": 1234, "user_name": "Jon Doe"}'></camera>

Sources

Which of the mechanisms for video collecion would you like to enable (you must choose at least one) The default value is "record,upload,sms" Acceptable values are 'record', 'upload', 'sms'

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-sources='record,sms'></camera>

Default Mobile Camera

Which of the cameras on a mobie device should be used by default Acceptable values are '', 'environment', 'user'

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-facing-mode=''></camera>

Preroll Count

Number of seconds to count down before recording starts The default value is "5"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-pre-roll-length='5'></camera>

Max Length

The max length (in seconds) of videos recorded with a webcam (does not apply to uploads) The default value is "30"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-maxlength='30'></camera>

Min Length

The minimum length (in seconds) of videos recorded with a webcam (does not apply to uploads). We recommend at leat 3 seconds to prevent encoding issues. The default value is "3"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-minlength='3'></camera>

Video Bitrate

The video bitrate (in Bits per second) for videos recorded with a webcam The default value is "123456"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-videobitrate='123456'></camera>

Audio Bitrate

The audio bitrate (in Bits per second) for videos recorded with a webcam The default value is "40000"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-audiobitrate='40000'></camera>

Autopreview After Record

When set to true the camera will automatically playback the recorded video after the users stops recording (webcam recording only). The default value is "false"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-autopreview='false'></camera>

Upload On File Select

When set to false the camera will NOT automatically upload a video after it has been selected (file upload only). Your will have to manually call startUpload() using the JS API. The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-upload-on-select='true'></camera>

Auto-Publish on Upload

When set false the camera will NOT automatically publish a video after it has been uploaded to our servers (file upload only). You will have to manually call publish() using the JS API The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-publish-on-upload='true'></camera>

Start Recording after Connect

Setting this attribute to false will eenable you to connect to the server and turn on th camera without starting recording. This is helpful to provide an camera preview for an arbitrary amount of time (otherwise use preroll). You will have to manually call record() from our JS API to begin recording. The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-record-on-connect='true'></camera>

Use Simple Flash Security Box

Instructs the Flash recording engine to present the user with the simplified security dialog when asking for camera access. The default value is "false"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-simple-security='false'></camera>

Mirror Image During Recording

When set to false the camera will NOT horizontally flip the image preview during recording. The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-mirror-recording='true'></camera>

Poll Server For Processed Event

Setting this attribute to false will instruct the camera not to poll our severs for the the 'processed' event. The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-poll-for-processed='true'></camera>

Default SMS Country

Sets the default country code listed in the SMS form (takes ISO 3166-1 alpha-2 codes) The default value is "us" Acceptable values are 'af', 'al', 'dz', 'as', 'ad', 'ao', 'ai', 'ag', 'ar', 'am', 'aw', 'au', 'at', 'az', 'bs', 'bh', 'bd', 'bb', 'by', 'be', 'bz', 'bj', 'bm', 'bt', 'bo', 'ba', 'bw', 'br', 'io', 'vg', 'bn', 'bg', 'bf', 'bi', 'kh', 'cm', 'ca', 'cv', 'bq', 'ky', 'cf', 'td', 'cl', 'cn', 'co', 'km', 'cd', 'cg', 'ck', 'cr', 'ci', 'hr', 'cu', 'cw', 'cy', 'cz', 'dk', 'dj', 'dm', 'do', 'ec', 'eg', 'sv', 'gq', 'er', 'ee', 'et', 'fk', 'fo', 'fj', 'fi', 'fr', 'gf', 'pf', 'ga', 'gm', 'ge', 'de', 'gh', 'gi', 'gr', 'gl', 'gd', 'gp', 'gu', 'gt', 'gn', 'gw', 'gy', 'ht', 'hn', 'hk', 'hu', 'is', 'in', 'id', 'ir', 'iq', 'ie', 'il', 'it', 'jm', 'jp', 'jo', 'kz', 'ke', 'ki', 'kw', 'kg', 'la', 'lv', 'lb', 'ls', 'lr', 'ly', 'li', 'lt', 'lu', 'mo', 'mk', 'mg', 'mw', 'my', 'mv', 'ml', 'mt', 'mh', 'mq', 'mr', 'mu', 'mx', 'fm', 'md', 'mc', 'mn', 'me', 'ms', 'ma', 'mz', 'mm', 'na', 'nr', 'np', 'nl', 'nc', 'nz', 'ni', 'ne', 'ng', 'nu', 'nf', 'kp', 'mp', 'no', 'om', 'pk', 'pw', 'ps', 'pa', 'pg', 'py', 'pe', 'ph', 'pl', 'pt', 'pr', 'qa', 're', 'ro', 'ru', 'rw', 'bl', 'sh', 'kn', 'lc', 'mf', 'pm', 'vc', 'ws', 'sm', 'st', 'sa', 'sn', 'rs', 'sc', 'sl', 'sg', 'sx', 'sk', 'si', 'sb', 'so', 'za', 'kr', 'ss', 'es', 'lk', 'sd', 'sr', 'sz', 'se', 'ch', 'sy', 'tw', 'tj', 'tz', 'th', 'tl', 'tg', 'tk', 'to', 'tt', 'tn', 'tr', 'tm', 'tc', 'tv', 'vi', 'ug', 'ua', 'ae', 'gb', 'us', 'uy', 'uz', 'vu', 'va', 've', 'vn', 'wf', 'ye', 'zm', 'zw'

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-default-sms-country='us'></camera>

Default SMS Message

Change the default SMS message sent to users when using SMS mobile recording. You can use the <<url>> or <<uuid>> interpolation codes to have our server auomatically inject the current video's uuid and/or cameratag.com mobile recording page. The default value is "To record this video using your mobile phone please visit <<url>> in your mobile browser"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-txt-message='To record this video using your mobile phone please visit <<url>> in your mobile browser'></camera>

Enforce Length Restrictions for Mobile Uploads

Use this setting to turn off enforcement of max lengths for mobile uploads The default value is "true"

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-enforce-mobile-length='true'></camera>

Recording Stack

Manually select the recording stack CameraTag will use (leave blank to have CameraTag auto-select based on client capabilities) The default value is "auto" Acceptable values are 'auto', 'webrtc', 'mediarecorder', 'flash', 'mobile'

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-stack='auto'></camera>

Signature

If publish signature security is enabled for your app you will need to provide a signaure calculated on your server

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-signature='ab123c456d899f90afc426'></camera>

Sigature Expiration

If publish signature security is enabled for your app you will need to provide a signaure expiration calculated on your server.

<camera id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-signature-expiration='1589111222'></camera>