AEC Adapt Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for executing multiple AEC tasks and collect AEC statistics for each task if "adaptAEC" is set to "true".
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
-
initialDelayOffsetMspropertySpecifies initial delay offset duration in milliseconds. Default: 0. The value can be set at runtime using the
"initialDelayOffsetMsRuntime"property.Parameter is optional.
-
initialDelayOffsetMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"initialDelayOffsetMs"property. Example:"$[InitialDelayOffsetMs]".Parameter is optional.
-
finalDelayOffsetMspropertySpecifies final delay offset duration in milliseconds. Default: 0. Example:
"finalDelayOffsetMs"= 75. The value can be set at runtime using the"finalDelayOffsetMsRuntime"property.Parameter is optional.
-
finalDelayOffsetMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"finalDelayOffsetMs"property. Example:"$[FinalDelayOffsetMs]".Parameter is optional.
-
delayOffsetIncrementMspropertySpecifies delay offset duration increment in milliseconds. Default: 5. The value can be set at runtime using the
"delayOffsetIncrementMsRuntime"property.Parameter is optional.
-
delayOffsetIncrementMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"delayOffsetIncrementMs"property. Example:"$[DelayOffsetIncrementMs]".Parameter is optional.
-
resultDataFileNamepropertyFile name containing the AEC data and statistics results generated by executing the AEC tasks. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
resultDataFileLocationpropertyURL or location of folder where
"resultDataFileName"will be located. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
Properties
delayOffsetIncrementMs
"delayOffsetIncrementMs": integer
Discussion
Specifies delay offset duration increment in milliseconds. Default: 5. The value can be set at runtime using the "delayOffsetIncrementMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
delayOffsetIncrementMsRuntime
"delayOffsetIncrementMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "delayOffsetIncrementMs" property. Example: "$[DelayOffsetIncrementMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
finalDelayOffsetMs
"finalDelayOffsetMs": integer
Discussion
Specifies final delay offset duration in milliseconds. Default: 0. Example: "finalDelayOffsetMs" = 75. The value can be set at runtime using the "finalDelayOffsetMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
finalDelayOffsetMsRuntime
"finalDelayOffsetMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "finalDelayOffsetMs" property. Example: "$[FinalDelayOffsetMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
initialDelayOffsetMs
"initialDelayOffsetMs": integer
Discussion
Specifies initial delay offset duration in milliseconds. Default: 0. The value can be set at runtime using the "initialDelayOffsetMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
initialDelayOffsetMsRuntime
"initialDelayOffsetMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "initialDelayOffsetMs" property. Example: "$[InitialDelayOffsetMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json