Skip to main content
Skip table of contents

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 and Trigger Scales

The Audio level scales can be configured separately for the faders and the level meter, which latter 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

Segments

The whole scale is spared into several segments, which all have an upper and lower edge (defined in dB). The edges of the segments must match. The lower edge of the first segment is the lower edge of the whole meter; the upper edge of the last segment is the upper edge of the whole meter

Each segment is divided into a "dB-linear" range. This means the dB values follow a linear sequence (e.g. -3, -6, -9, -12)

The visual space of each segment is defined as a percentage of the whole level meter.

The string defines one or more segments (separator is ';'):
"segment1; segment2"

A single segment consists of the height value in percent and 2 or more scale values (separator is ','):
"100.0, 2.0, 1.0, 0.0, -1.0, -2.0"  (here amount is 100%, values are 2.0...-2.0)

A scale with 2 segments can look like this:
"40, 2, 1, 0; 60, 0,-1,-2,-3,-4,-5,-6,-8,-9,-12,-15,-18.-24,-48" (here we have two segments, the first with 40% of height and values 2..0, the second 60% of height and values 0..-48)

Note positive gain values can make sense for the input fader only (but can lead into signal clipping).

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

Per ROAD Backend Configuration

To use different ROAD backends with a fixed configuration you need to add to the InstaRecorder folder name “_yourhostname” like defined in the RoadServiceList.

Example:

RoadServiceList=
[
{ "name": "host1",
"value": "http://localhost:11003",
"selected": false},
{ "name": "host2",
"value": "https://localhost:11005",
"selected": true}
]

InstaRecorder_host1
InstaRecorder_host2

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

AutoLogout

0

If set to a value greater 0 it will logout after N seconds of user inactivity (as of 29.04.2026 unreleased)

InstaRecorder

ContentManagerButtonVisible

True

True/False

Defines if the “Open Content Manager button” and Content Manager link in the top left drop down will be visible.

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

RoadServiceList

no

CODE 
[
{ "name": "Host 1",
"value": "http://localhost:11003",
"selected": false},
{ "name": "Host 2",
"value": "https://localhost:11005",
"selected": true}
]

List of ROAD service addresses in JSON. Selected = true marks the default entry.

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: 

  • "soft": the database entry is soft-deleted

  • "hard": the database entry is hard-deleted

  • "no": the database entry is not deleted

InstaRecorder / Format

CreateMpeg

{ "bitRate": "192", "jointStereo": false }

JSON formatted value with optional bitRate and jointStereo.
e.g. { "bitRate": "192", "jointStereo": false }
This parameter object is optional. If it is present, the audio content of the WAVE file will be encoded as MPEG Layer 2.

bitRate: Bit rate in kbit/s. Valid values are 192, 160, 128, 112, 96, 80, 64, 56, 48, 32 for mono, and 384, 320, 256, 224, 192, 160, 128, 112, 96, 64 for stereo. The field is optional, default is 192.

jointStereo: Either true or false. If true, and you have a stereo encoding, the encoder will use "Joint Stereo" mode. The field is optional, default is false.

Notes:
MPEG encoding is only possible, if the output graph has not more than 2 channels, and its sample rate is valid for MPEG Layer 2 (32000, 44100 or 48000).

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, 6.0, 3.0, 0.0, -3.0, -6.0, -9.0, -12.0, -48.0

see description above

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, -3.0, -6.0, -12.0, -48.0

see description above

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 ( '\'), like in the example.

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 
{
  "filterName": "acompressor",
  "options": {
    "level_in": 1.0,
    "mode": "downward",
    "threshold": 0.125,
    "ratio": 2.0,
    "attack": 20.0,
    "release": 250.0,
    "makeup": 1.0,
    "knee": 2.82843,
    "link": "average",
    "detection": "rms",
    "level_sc": 1.0,
    "mix": 1.0
  }
}

JSON structure representing a FFMpeg audio filter. See more information here.

InstaRecorder / Effects / My other effect etc

Other effects that can be used 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close