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 room Configuration

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

Instance ID
Room
User
Start Time
End Time
Disconnect Warning Duration
Signature
Sigature Expiration
Auto Connect
Auto Publish
View Only Mode
Max Length

Instance ID

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

HTML

Vanilla JS

React JS

<room id='myRoomTag1' data-app-id='[YOUR_APP_UUID]'></room>

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

REACT

Room

A unique for the conference room you want this user to enter The default value is "room_name"

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-room_name='myRoom'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  room_name: 'myRoom'
})

REACT

User

Allows you to pre-define the user name (if not provided the user will be prompted). *No special characters no spaces

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-user_name='Bill'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  user_name: 'Bill'
})

REACT

Start Time

The time the room should first be available to users. The value should be an integer datetime (Unix Epoch). If left empty the room will open immediately

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-start_time='1608055508'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  start_time: '1608055508'
})

REACT

End Time

The time the room will close and disconnect all users. The value should be an integer datetime (Unix Epoch). If left empty the default is 20 minutes after the start time

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-end_time='1608075508'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  end_time: '1608075508'
})

REACT

Disconnect Warning Duration

How far in advance to show the disconnect warning The default value is "30"

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-disconnect_warning_duration='30'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  disconnect_warning_duration: '30'
})

REACT

Signature

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

HTML

Vanilla JS

React JS

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

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  signature: ''
})

REACT

Sigature Expiration

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

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-signatureExpiration=''></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  signatureExpiration: ''
})

REACT

Auto Connect

When set to false the <room> will not connect immediately after initializing The default value is "true"

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-auto_connect='true'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  auto_connect: 'false'
})

REACT

Auto Publish

When set to false the <room> will not publish immediately after connecting to the room The default value is "true"

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-auto_publish='true'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  auto_publish: 'false'
})

REACT

View Only Mode

Join the room in view only mode (not as a participant)

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-view_only='true'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  view_only: 'true'
})

REACT

Max Length

The max length for the room (in seconds)

HTML

Vanilla JS

React JS

<room id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-max_length='3600'></room>

CameraTag.init('targetDivID', 'room', {
  appUuid: '[YOUR_APP_UUID]',
  id: 'myRoom',
  max_length: '3600'
})

REACT