Configure InstaRecorder
Setting the DigaSystem parameters for the InstaRecoder has the following sections:
Each parameter is described in the complete list.
Audio Format
The Audio format is the one used for all recordings in InstaRecorder.
It specifies the resolution and the sample rate.
Parameters:
- Resolution
- SampleRate
Audio level scales
The Audio level scales can be configured separately for the faders and the level meter, which shares one scale with the level trigger.
Each scale value to be displayed can be defined. They can be represented in logarithmic or linear scale.
Parameters:
- LinearDbScale
- Segments
Recorders
Any amount of recorder strips can be defined to appear by default.
Parameter: RecorderCount
Configure each Recorder
Each Recorder gets a set of parameters defining the defaults for device, channels, DigaSystem table and title:
Its parameters are placed in a sub-folders Recorders\Recorder_<x> (<x> subsequent from 1 to the number of recorders), which contains:
- Device
- Table
- Title
- a sub-folder Channels with one key for each channel
- CH<x> (<x> is the indicated channel number)
Automated Start Trigger
The Start Trigger mechanism is used to automatically start a recording when the audio level of a source device reaches a certain level for at least a defined amount of time.
Parameters:
- AutoTrigger\StartLevelDb
- AutoTrigger\StartDurationMs
- AutoTrigger\StartDelayMs
Automated Stop Trigger
The Stop Trigger mechanism is used to automatically stop a recording when the audio level of a source device reaches a certain level for at least a defined amount of time.
Parameters:
- AutoTrigger\StopLevelDb
- AutoTrigger\StopDurationMs
- AutoTrigger\StopAction
Effects
Effects have to be Global
Effects have to be defined in the Global\Default namespace!
To apply effects to your recording (both for the monitoring and the output of the recording in DPE.
A sample parameter file is available as road-clients/docs/DPE-Parameter-samples/InstaRecorder_Effects_examples.par
The configuration keys are the following:
- Effects\SaveRawAudioWhenApplyingEffect
- Effects\FreezeEffectWhileRecording
- Effects\My Effect\Label
- Effects\My Effect\FilterSpec
- Effects\Another Effect\Label
- Effects\Another Effect\FilterSpec
- Effect\ ...
Each subfolder of the InstaRecorder \ Effects folder will be an effect, with a label and a filterSpec (see more details and example in the table below)
Because applying an effect to a recording could incur data losses (if the effect renders the output audio file unusable), InstaRecorder will save a RAW audio file (without effect) alongside the primary recording (with the effect).
This behavior is controlled by the key InstaRecorder / Effects / SaveRawAudioWhenApplyingEffect
which defaults to true.
Be aware that setting this key to false could incur data losses.
See more information below
An effect can be selected (through a dropdown) by the user, and can be switched on/off before the beginning of the recording.
This behavior is controlled by the key InstaRecorder / Effects / FreezeEffectWhileRecording
which defaults to true.
If the parameter is set to true, the effect will be fixed when starting the recording, i.e. when click on the "Record" button.
If the parameter is set to false, the effect can be switched on/off while the recording is created, but the selected effect cannot be changed.
Complete list of DigaSystem parameters for InstaRecorder
Folder | Parameter | Default Value | Format / Example | Description |
---|---|---|---|---|
InstaRecorder | ApplicationId | InstaRecorder_Default | Id of the InstaRecorder instance. All instances with the same id are synchronized. | |
InstaRecorder | MaxRecordingLength | 01:00:00 | 01:00:00 | Duration after which an automatic switch of output files is done. |
InstaRecorder | RecorderCount | 8 | Number of recorders to be available in parallel For each of them a section "InstaRecorder / Recorders / Recorder_x" can be configured (see below). | |
InstaRecorder | RoadServiceUrl | https://my-road-admin.internal.com:11005/ | Full URL (including protocol and port) of the ROAD Service | |
InstaRecorder | TitleTemplate | {Title} [${StartTime||yyyy-MM-dd HH:mm:ss||L}] {Counter} | {Title} [${StartTime||yyyy-MM-dd HH:mm:ss||L}] {Counter} | Pattern to use when saving an entry to DPE. The {Title} will be filled from the specific recorder's title entry and be supplemented with start time and counter as specified in this pattern. |
InstaRecorder | ZeroLengthFileDeletion | no | soft / hard / no | Zero length entries are created with a paused recording which never started. This parameter specifies what to do with those entries:
|
InstaRecorder / Format | Resolution | 24 | 24 | A number that represents the resolution (in bits) of the audio stream. |
InstaRecorder / Format | SampleRate | 44100 | 48000 | A number that represents the sample rate (in Hz) of the audio stream. |
InstaRecorder / InputScale | LinearDbScale | false | true / false | If the level meter's scale is linear or logarithmic |
InstaRecorder / InputScale | Segments | 100.0,6.0,3.0,0.0,-3.0,-6.0,-9.0,-12.0,-48.0 | 100.0, 6.0, 3.0, 0.0, -3.0, -6.0, -9.0, -12.0, -48.0 | Comma-separated floating point number which should be shown on the level meter's scale. |
InstaRecorder / TriggerScale | LinearDbScale | false | true / false | If the trigger's scale is linear or logarithmic |
InstaRecorder / TriggerScale | Segments | 100.0,0.0,-3.0,-6.0,-12.0,-48.0 | 100.0, 6.0, 3.0, 0.0, -3.0, -6.0, -9.0, -12.0, -48.0 | Comma-separated floating point number which should be shown on the trigger fader's scale. |
InstaRecorder / AutoTrigger | StartLevelDb | -40.0 | -40 | Floating point number that represents the required audio level (in dB) at which the recording will be triggered. |
InstaRecorder / AutoTrigger | StartDurationMs | 100 | 100 | Required time in milliseconds that the audio has to be over the StartLevelDb in order to trigger the recording. Minimum value allowed is 100 milliseconds. |
InstaRecorder / AutoTrigger | StartDelayMs | 0 | 0 | Required time in milliseconds to delay the recording after StartDurationMs. Enter a negative value to get audio from before the trigger hits. |
InstaRecorder / AutoTrigger | StopLevelDb | -60.0 | -60 | Floating point number that represents the required audio level (in dB) at which the recording will be stopped. |
InstaRecorder / AutoTrigger | StopDurationMs | 500 | 500 | Required time in milliseconds that the audio has to be below the StopLevelDb in order to stop the recording. Minimum value allowed is 500 milliseconds. |
InstaRecorder / AutoTrigger | StopAction | Pause + Switch output file | Pause + Switch output file | Action which needs to done when the stop trigger hits. Options are "Pause + Switch output file", "Pause" and "Finish". |
InstaRecorder / AutoTrigger | ForcedDiffStartStopDb | 20 | 20 | The difference between start level and stop level in dB. Minimum value allowed is 20dB. |
InstaRecorder / Recorders / Recorder_1 | Device | The device selected by default on this recorder | ||
InstaRecorder / Recorders / Recorder_1 | Table | VM-DIGAS\Production_Recording | The default DPE output table - where the recordings made on this recorder will be saved Must contain the name of the database and the name of the table, separated with a backslash ( ' | |
InstaRecorder / Recorders / Recorder_1 | Title | The default title of the recording for this recorder. This title is inserted into the TitleTemplate when saving output to DPE. | ||
InstaRecorder / Recorders / Recorder_1 / Channels | CH1 | One parameter key per channel (e.g. CH1 ) with the value being the fader's default level (in dB) as a floating point number. | ||
InstaRecorder / Recorders / Recorder_1 / Channels | CH2 etc. | Any amount of channels | ||
InstaRecorder / Recorders / Recorder_2 etc. | All recorder parameters until RecorderCount | |||
InstaRecorder / Effects | FreezeEffectWhileRecording | true | Binary value determining if the effect could be switched on/off while a recording is active | |
InstaRecorder / Effects | SaveRawAudioWhenApplyingEffect | true | When applying an effect to the audio output, InstaRecorder will still record the raw audio alongside the audio with the filter applied, in case the effect renders the recording unusable. | |
InstaRecorder / Effects / My Effect | Label | Compressor | The name of the effect that will be displayed in the UI. If this key is not present, the name of the folder (e.g. "My Effect") will be used to be displayed in the UI. | |
InstaRecorder / Effects / My Effect | FilterSpec |
CODE
| JSON structure representing a FFMpeg audio filter. See more information here. | |
InstaRecorder / Effects / My other effect etc | Other effects that can be used |