Video recording - All parameters
In this section we will provide you with a reference to all configurations available in the video recording component.
| Attribute Name | Description | Data Type | Mandatory | Default Value |
|---|---|---|---|---|
updateObjectName | Object name of the record that needs to be updated | String | True, if One to One | |
updateRecordID | Salesforce ID of the record that needs to be updated | Id | True, if One to One | |
updateField | Lookup field that needs to be updated with the Video ID | String | True, if One to One | |
questionnaireField | API name of the field for the questionnaire lookup | String | False | |
tokenField | Field API Name that contains the token | String | False | Secrect__c |
token | Token value in input, to match the one in the tokenField | String | False | |
createJunctionWithObject | API name of the parent object | String | True, if One to Many | |
createJunctionWithParentID | ID of the parent record to link in the junction object | Id | True, if One to Many | |
createJunctionObject | API name of the junction object to use | String | False | Video_Junction__c |
createJunctionVideoField | Lookup field on the junction populated with the video Id | String | False | Chaq_Video__c |
createJunctionParentField | Field on the junction to reference the parent object | String | False | |
| recordingWidth | Width for the recording, in pixel | Integer | False | 1280 |
| recordingHeight | Height for the recording, in pixel | Integer | False | 720 |
successMessage | Message displayed when the recording has been approved by the user | String | False | Recording successfully uploaded |
| successMessageTitle | Title displayed when the recording has been approved by the user | String | False | |
timeLimit | Max duration of the recording, in seconds | Integer | False | 300 |
countdown | Countdown before starting the recording, in seconds | Integer | False | 3 |
pickSnapshot | Enable users to pick their preferred snapshot | Boolean | False | True |
allowVideoUpload | Allow the manual upload of an existing video | Boolean | False | False |
| skipIntroFields | When false, the user should type a required title and an optional description for the video | Boolean | False | True |
| skipInitialSelection | If "Record Video" is the only option, this attribute allows to control the automatic opening of the camera or not | Boolean | False | True |
primaryColour | Primary colour for the component | Integer | False | |
secondaryColour | Secondary colour for the component | Integer | False | |
tertiaryColour | Tertiary colour for the component | Integer | False | |
questionnaireID | Salesforce Id of the Questionnaire to run | Id | False | |
videoApprovedOrigin | Origin where to push the recording events | String | False | |
| screenRecordingAllowed | Allow the user to record the screen | Boolean | False | False |
| callToActionURL | Call-to-Action URL to display once the video has been played until the end | String | False | |
| flipCamera | Vertically flip the camera preview during the recording | Boolean | False | True |
| effectProfile | Effect Profile to add to the video. Empty string to skip this configuration | String | False | |
| videoProfile | Video Profile to add to the video. Empty string to skip this configuration | String | False | |
| metaProfile | Meta Profile to add to the video. Empty string to skip this configuration | String | False | |
| videoVaultAllowed | Allow the Video Vault | Boolean | False | True |
| transcriptionLanguage | Manually set the language for the audio transcription. Possible values are "nl-NL", "en-US", "en-UK", "fr-FR", "de-DE", "it-IT", "pr-BR", "es-ES", "es-LA" | String | False | "Locale" of the running user |
| maxRecordings | Max number of recordings available (sum of all Redos + 1) | Integer | False | 3 |
| autoApprove | Auto approve the last available recording | Boolean | False | False |
| allowedExtensions | Comma separated list of allowed extensions for video uploads | String | False | mp4,mpg,avi,mov,mkv,wmv,ogv,webm,flv |
| allowedAudioExtensions | Comma separated list of allowed extensions for audio uploads | String | False | mp3,ogg,wav |
| allowCameraRecording | Allow the camera recording | Boolean | False | True |
| allowMultiStreams | Allow the recording of both camera and screen | Boolean | False | False |
| defaultApproveLabel | Customise the label of the approval button | String | False | "Next" |
| enableUploaderMode | When enabled, allow just the uploading of videos | Boolean | False | False |
| allowMultipleUpload | Allow multiple file uploads or just one, if we are in a one to many scenario | Boolean | False | True |
| mediaUploadType | Define which type of files the uploader can accept, between "video", "audio", "all" | String | False | "video" |
| uploadButtonLabel | Label for the button that shows the input file popup | String | False | |
| uploadButtonStyle | Style of the upload button | String | False | |
| uploadButtonIconName | Family and name of the icon to display, e.g. "action:cancel" | String | False | |
| uploadButtonContainerStyle | Style for the container of the upload button | String | False | |
| uploadButtonDisplayType | How to display the the upload functionality | String | False | "buttonOnly" to show just the button |
| enableVersioning | Turn on the versioning, bringing together multiple iteration of the same video concept | Boolean | False | False |
| versioningJunctionId | Salesforce ID of the Junction record to consider when using versioning in a Many to Many scenario | String | False | |
| hideApprovalPage | When true, do not display the approval page | Boolean | False | False |
| hideApprove | When true, the approve button is not displayed | Boolean | False | False |
| enableBoltRecord | Enable the new version of the recorder | Boolean | False | False |
| nativeRecorderMode | Enable the recording through our mobile app | Boolean | False | False |
| nativeRecorderButtonLabel | Label for the button that links to the recorder app | String | False | |
| nativeRecorderBackTo | Define the policy in which we the recording mobile app is navigating back to the Salesforce mobile app:
| String | False | 0 |
| nativeRecorderGreenlight | Enable or disable the greenlight system on the native recorder | Boolean | False | False |
| tagConfigurationCodeName | Code name of the tagging configuration that should be used | String | False | |
| nativeRecorderSourceApp | Source app to link the native recorder app | String | False | "one" or "fsl" |
enablePracticeTest | Activate the practice test for the interviews | Boolean | False | True |
| practiceMessage | Final message displayed to the candidate at the end of a practice interview | String | False | |
| practiceMessageTitle | Title displayed to the candidate at the end of a practice interview | String | False | |
| videoRecordCntDomId | DOM container ID for the recorder container | String | False | The same value will be included in the VideoRecordingEvent under the "containerDomId" attribute |
| keepAspectRatio | If true, try to keep the original aspect ratio defined by the camera / screen recording | Boolean | False | True |
| allowAudioRecording | Enable audio recording | Boolean | False | False |