Camera Tag: Video Recording API & More!

Intro

Overview New in V15

Apps

Overview Configuration

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Videos

Overview Embedding Configuration Custom Interface JS Methods JS Events

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Audio

<room>

Overview Embedding Configuration Custom Interface JS Methods JS Events

Overview Embedding Configuration JS Methods & Events

<wall>

Overview Embedding Configuration JS Methods

<photo>

Overview Embedding

REST API

Overview

Assets

List Assets Show Asset Update Asset Delete Asset

Apps

List Apps Show App Create App Update App

Media Factories

List Media Factories Show Media Factory Create Media Factory Update Media Factory

Asset Responses

Video Object Photo Object Audio Object

Rooms

List Rooms Create Room Show Room Update Room Delete Room

Advanced microphone Configuration

You can configure your microphone by passing ina data attributes on your <microphone> tag. The id and app-id attributes are required.

Instance ID
Recording Name
Recording Description
Metadata
Sources
Preroll Count
Max Length
Min Length
#prompts
Mobile Recording URL
Recording Stack
Permitted File Extensions
Existing UUID
Disable Audio Processing
Poll Server For Processed State
Skip Preview
Audio Bit Rate

Instance ID

A unique identifier for this camera The default value is "myMic"

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-id='myMic'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  id: ''
})

REACT

Recording 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)

HTML

Vanilla JS

React JS

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

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  name: 'Billy Birthday Wish'
})

REACT

Recording 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)

HTML

Vanilla JS

React JS

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

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  description: 'Billy wishes grandma a very happy birthday during his soccer game.'
})

REACT

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) The default value is "{}"

HTML

Vanilla JS

React JS

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

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  metadata: "{\"user_id\": 1234, \"user_name\": \"Jon Doe\"}"
})

REACT

Sources

The default value is "record,upload,sms" Acceptable values are 'record', 'upload', 'sms'

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-sources='record'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  sources: 'record'
})

REACT

Preroll Count

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

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-preroll='5'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  preroll: '5'
})

REACT

Max Length

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

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-maxLength='30'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  maxLength: '30'
})

REACT

Min Length

The min length (in seconds) of videos recorded (does not apply to uploads) The default value is "3"

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-minLength='3'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  minLength: '3'
})

REACT

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-prompts='null'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  prompts: null
})

REACT

Mobile Recording URL

Sets the URL for the QR code used for mobile recording

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-mobileRecordingUrl='https://www.mysite.com/record?user_id=123'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  mobileRecordingUrl: 'https://www.mysite.com/record?user_id=123'
})

REACT

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', 'mobile'

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-defaultStack='mediarecorder'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  defaultStack: 'mediarecorder'
})

REACT

Permitted File Extensions

When uploading what file types should be allowed The default value is "mov,mp4,webm,flv,mv4,mov,avi,wmv,mpeg,mpg,m4v,wav,mp3,aif,aiff,aifc" Acceptable values are 'mov', 'mp4', 'webm', 'flv', 'mv4', 'mov', 'avi', 'wmv', 'mpeg', 'mpg', 'm4v', 'wav', 'mp3', 'aif', 'aiff', 'aifc'

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-permittedExtensions='["mov", "mp4", "webm", "flv", "mv4", "mov", "avi", "wmv", "mpeg", "mpg", "m4v", "wav", "mp3", "aif", "aiff", "aifc"]'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  permittedExtensions: '["mov", "mp4", "webm", "flv", "mv4", "mov", "avi", "wmv", "mpeg", "mpg", "m4v", "wav", "mp3", "aif", "aiff", "aifc"]'
})

REACT

Existing UUID

If you would like to record with a UUID of your own derivation

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-existingUuid='v-123-456-789'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  existingUuid: 'v-123-456-789'
})

REACT

Disable Audio Processing

Turn off advanced audio processing such as gain control and echo cancelation.

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-disableAudioProcessing='true'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  disableAudioProcessing: true
})

REACT

Poll Server For Processed State

Have the recorder poll the server to know when the recorded / uploaded asset has finished processing.

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-pollServer='true'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  pollServer: true
})

REACT

Skip Preview

Skip the video review step and automatically publish after stopping

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-skipPreview='true'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  skipPreview: true
})

REACT

Audio Bit Rate

The taregt bit rate for the audio stream (in bits per second) The default value is "128000"

HTML

Vanilla JS

React JS

<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-audioBitRate='128000'></microphone>

CameraTag.init('targetDivID', 'microphone', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'mymicrophone',
  audioBitRate: '128000'
})

REACT