You can also view
You are viewing documentation for version 10. This version is antiquated!
The current version is version 11

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>

App
ID
Name
Description
Show Visualizaion
Metadata
Sources
Preroll Count
Max Length
Min Length
Autopreview After Record
Upload On File Select
Auto-Publish on Upload
Use Simple Flash Security Box
Poll Server For Processed Event
Use WebRTC When Available
WebRTC Recording Buffer Size

App

Choose the CameraTag App with which this microphone should work
<microphone id='MyRecorder1' data-app-id=''></microphone>

ID

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

Name

A human friendly name for the video to be recorded by this microphone. This will be visible in your CameraTag admin and on YouTube (if you have YouTube export enabled)
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-name='Billy Birthday Wish'></microphone>

Description

A description for the video to be recorded by this microphone. This will be visible in your CameraTag admin
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-description='Billy wishes grandma a very happy birthday during his soccer game.'></microphone>

Show Visualizaion

Determines if the microphone will show the audio visulaization during recording The default value is "true"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-show-visualization='false'></microphone>

Metadata

A JSON string to be stored along with the audio. 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='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-metadata='{"user_id": 1234, "user_name": "Jon Doe"}'></microphone>

Sources

Which of the mechanisms for audio collecion would you like to enable (you must choose at least one) The default value is "record,upload" Acceptable values are 'record', 'upload'
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-sources='record,upload'></microphone>

Preroll Count

Number of seconds to count down before recording starts The default value is "5"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-pre-roll-length='5'></microphone>

Max Length

The max length (in seconds) of audio recorded with a webcam (does not apply to uploads) The default value is "30"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-maxlength='30'></microphone>

Min Length

The minimum length (in seconds) of audio recorded with a webcam (does not apply to uploads). We recommend at leat 3 seconds to prevent encoding issues. The default value is "3"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-minlength='3'></microphone>

Autopreview After Record

When set to true the microphone will automatically playback the recorded audio after the user stops recording (recording only). The default value is "false"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-autopreview='false'></microphone>

Upload On File Select

When set to false the microphone will NOT automatically upload an audio after it has been selected (file upload only). Your will have to manually call startUpload() using the JS API. The default value is "true"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-upload-on-select='true'></microphone>

Auto-Publish on Upload

When set false the microphone will NOT automatically publish an audio 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"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-publish-on-upload='true'></microphone>

Use Simple Flash Security Box

Instructs the Flash recording engine to present the user with the simplified security dialog when asking for microphone access. The default value is "false"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-simple-security='false'></microphone>

Poll Server For Processed Event

Setting this attribute to true will instruct the camera to poll our severs for the state of an audio after it has been publish. When the audio has been processed by our servers the camera will emit the 'processed' event. The default value is "false"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-poll-for-processed='false'></microphone>

Use WebRTC When Available

Set this attribute to false to diable WebRTC recording (using only Flash for webcam recordings) The default value is "true"
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-webrtc='true'></microphone>

WebRTC Recording Buffer Size

This value controls how frequently the audioprocess event is dispatched and how many sample-frames need to be processed each call. The default value is "16384" Acceptable values are '256', '512', '1024', '2048', '4096', '8192', '16384'
<microphone id='MyRecorder1' data-app-id='[YOUR_APP_UUID]' data-buffer-size='16384'></microphone>