Advanced Microphone Configuration

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

Instance ID
Recording Name
Recording Description
Show Audio Visualizaion
Metadata
Sources
Default Mobile Camera
Preroll Count
Max Length
Min Length
Mirror Image During Recording
Poll Server For Processed Event
#prompts
Metadata
Default SMS Country
Default SMS Message
Recording Stack
Default to sharing the user's screen (instead of a webcam)

id

A unique identifier for this room (in case you have more than one on the page)
<microphone id='myMicrophone' data-app-id='[YOUR_APP_UUID]'></microphone>

data-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)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-name='Billy Birthday Wish'></microphone>

data-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)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-description='Billy wishes grandma a very happy birthday during his soccer game.'></microphone>

data-show-visualization

Determines if the microphone will show the audio visulaization during recording
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-show-visualization='true'></microphone>

data-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)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-metadata='{"user_id": 1234, "user_name": "Jon Doe"}'></microphone>

data-sources

<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-sources='["record", "upload", "sms"]'></microphone>

data-facing-mode

Which of the cameras on a mobile device should be used by default
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-facing-mode=''></microphone>

data-pre-roll-length

Number of seconds to count down before recording starts
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-pre-roll-length='5'></microphone>

data-maxlength

The max length (in seconds) of videos recorded (does not apply to uploads)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-maxlength='30'></microphone>

data-maxlength

The min length (in seconds) of videos recorded (does not apply to uploads)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-minlength='3'></microphone>

data-mirror-recording

When set to false the camera will NOT horizontally flip the image preview during recording.
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-mirror-recording='true'></microphone>

data-poll-for-processed

Setting this attribute to false will instruct the camera not to poll our severs for the the 'processed' event.
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-poll-for-processed='true'></microphone>

data-prompts

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

data-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)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-metdata='{"user_id": 1234, "user_name": "Jon Doe"}'></microphone>

data-default-sms-country

Sets the default country code listed in the SMS form (takes ISO 3166-1 alpha-2 codes)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-default-sms-country='us'></microphone>

data-txt-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.
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-txt-message='To record this video using your mobile phone please visit <<url>> in your mobile browser'></microphone>

data-stack

Manually select the recording stack CameraTag will use (leave blank to have CameraTag auto-select based on client capabilities)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-stack='auto'></microphone>

data-share-screen

Default to sharing the user's screen (instead of a webcam)
<microphone id='myBoooth1' data-app-id='[YOUR_APP_UUID]' data-share-screen='false'></microphone>