You can also view
You are viewing documentation for version 14. This is the most recent stable release!

Advanced Room Configuration

Beyond the two required settings for a <room> 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 <room>

App ID
Instance ID
Room
User
Start Time
End Time
Disconnect Warning Duration
Signature
Sigature Expiration
Auto Connect
Auto Publish

App ID

Choose the CameraTag App with which this room should work
<room id='[INSTANCE_ID]' data-app-id='' data-room='[ROOM_NAME]'></room>

Instance ID

A unique identifiuer for this room (in case you have more than one on the page) The default value is "myRoomTag1"
<room id='myRoomTag1' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Room

A unique for the conference room you want this user to enter
<room id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room=''></room>

User

Allows you to pre-define the user name (if not provided the user will be prompted). *No special characters no spaces
<room data-user='Bill' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

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
<room data-start-time='1608055508' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

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
<room data-end-time='1608075508' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Disconnect Warning Duration

How far in advance to show the disconnect warning The default value is "30"
<room data-disconnect-warning='30' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Signature

If signature security is enabled for your app you will need to provide a signaure calculated on your server
<room data-signature='ab123c456d899f90afc426' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Sigature Expiration

If signature security is enabled for your app you will need to provide a signaure calculated on your server
<room data-signature-expiration='1589111222' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Auto Connect

When set to false the <room> will not connect immediately after initializing The default value is "true"
<room data-auto-connect='false' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>

Auto Publish

When set to false the <room> will not publish immediately after connecting to the room The default value is "true"
<room data-auto-publish='false' id='[INSTANCE_ID]' data-app-id='[YOUR_APP_UUID]' data-room='[ROOM_NAME]'></room>