Declared in Voiceflow.schema.json

Overview

Specifies the parameters for a "runAEC" type Voiceflow Module. "runAECParams" configuration is used in "runAECParams" type Voiceflow Module.

Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.

Tasks

  •   id

    ID of the Acoustic Echo Cancelation (AEC) task. User defined. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   renderPromptID

    ID of Audio Prompt Module processed for audio playback on Device which generated acoustic echo. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   captureFileName

    File name for recorded audio containing acoustic echo generated by audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   captureFileLocation

    URL or location of folder where "captureFileName" is located. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   resultFileName

    File name for resulting processed recorded audio containing audio data with canceled acoustic echo. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   resultFileLocation

    URL or location of folder where "resultFileName" will be located. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   languageCode

    The language locale folder name, containing the AEC files for AEC task, to be added to the "captureFileLocation". Also the language locale folder name is added to the "resultFileLocation" to store the "resultFileName" at. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   audioFormat

    Audio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values: "pcm_8khz", "pcm_16khz", "pcm_32khz", "pcm_48khz", "wav", "compressed" (experimental), "preencoded" (experimental), "media", or "raw". Default: "pcm_16khz". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   vadParams

    Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.

    Parameter is optional.

           property
  •   aecParams

    Specifies the Acoustic Echo Cancelation (AEC) parameters used for processing recorded audio.

    Parameter is optional.

           property
  •   adaptAEC

    Specifies whether this "runAEC" Voiceflow Module will be used to run multiple AEC tasks to collect AEC statistics that help determine the optimal AEC parameters for best AEC performance. Default: "false". The value can be set at runtime using the "adaptAECRuntime" property.

    Parameter is optional.

           property
  •   adaptAECRuntime

    Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "adaptAEC" property. Example: "$[AdaptAEC]".

    Parameter is optional.

           property
  •   aecAdaptParams

    Specifies the parameters for executing multiple AEC tasks and collect AEC statistics for each task if "adaptAEC" is set to "true".

    Parameter is optional.

           property

Properties

adaptAEC

"adaptAEC": boolean

Discussion

Specifies whether this "runAEC" Voiceflow Module will be used to run multiple AEC tasks to collect AEC statistics that help determine the optimal AEC parameters for best AEC performance. Default: "false". The value can be set at runtime using the "adaptAECRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

adaptAECRuntime

"adaptAECRuntime": string

Discussion

Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "adaptAEC" property. Example: "$[AdaptAEC]".

Parameter is optional.

Declared In

Voiceflow.schema.json

aecAdaptParams

"aecAdaptParams": object - AECAdaptParams

Discussion

Specifies the parameters for executing multiple AEC tasks and collect AEC statistics for each task if "adaptAEC" is set to "true".

Parameter is optional.

Declared In

Voiceflow.schema.json

aecParams

"aecParams": object - AECParams

Discussion

Specifies the Acoustic Echo Cancelation (AEC) parameters used for processing recorded audio.

Parameter is optional.

Declared In

Voiceflow.schema.json

audioFormat

"audioFormat": string

Discussion

Audio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values: "pcm_8khz", "pcm_16khz", "pcm_32khz", "pcm_48khz", "wav", "compressed" (experimental), "preencoded" (experimental), "media", or "raw". Default: "pcm_16khz". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

captureFileLocation

"captureFileLocation": string

Discussion

URL or location of folder where "captureFileName" is located. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

captureFileName

"captureFileName": string

Discussion

File name for recorded audio containing acoustic echo generated by audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

id

"id": string

Discussion

ID of the Acoustic Echo Cancelation (AEC) task. User defined. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

languageCode

"languageCode": string

Discussion

The language locale folder name, containing the AEC files for AEC task, to be added to the "captureFileLocation". Also the language locale folder name is added to the "resultFileLocation" to store the "resultFileName" at. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

renderPromptID

"renderPromptID": string

Discussion

ID of Audio Prompt Module processed for audio playback on Device which generated acoustic echo. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

resultFileLocation

"resultFileLocation": string

Discussion

URL or location of folder where "resultFileName" will be located. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

resultFileName

"resultFileName": string

Discussion

File name for resulting processed recorded audio containing audio data with canceled acoustic echo. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

vadParams

"vadParams": object - VADParams

Discussion

Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.

Parameter is optional.

Declared In

Voiceflow.schema.json