Declared in Voiceflow.schema.json

Overview

Specifies the parameters for saving recorded audio to a file. "saveAudioParams" configuration is used in Voiceflow Modules that use of "recordAudioParams" for recording audio.

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.

Properties

  •   fileType

    Specifies the audio file type. Valid audio file types: "wav", "caf", and "m4a". Default: "wav". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   fileName

    File name that will contain the recorded audio. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   fileLocation

    URL or location path of folder where "fileName" containing the recorded audio will be located.The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   languageFolder

    Specifies the name of the folder specific to language locale. This folder name is used as part of "fileLocation" for the final location to save "fileName" at. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   audioFormat

    Specifies the name of the recorded audio format in a file, which may be different thant the original format of the audio recorded. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   requestID

    Specifies an ID that can be used to distinguish recorded audio files from others. User Defined. "requestID" is included in the name of the "fileName". Default: "" (an empty string is inserted in the filename). The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   includeTimeStamp

    Specifies whether to include a time stamp as part of the recorded audio file name. Default: "false". The value can be set at runtime using the "includeTimeStampRuntime" property.

    Parameter is optional.

           json parameter
  •   includeTimeStampRuntime

    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 "includeTimeStamp" property. Example: "$[IncludeTimeStamp]".

    Parameter is optional.

           json parameter

JSON Parameters

audioFormat

"audioFormat": object - audioFormat

Discussion

Specifies the name of the recorded audio format in a file, which may be different thant the original format of the audio recorded. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

fileLocation

"fileLocation": string

Discussion

URL or location path of folder where "fileName" containing the recorded audio will be located.The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

fileName

"fileName": string

Discussion

File name that will contain the recorded audio. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

fileType

"fileType": string

Discussion

Specifies the audio file type. Valid audio file types: "wav", "caf", and "m4a". Default: "wav". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

includeTimeStamp

"includeTimeStamp": boolean

Discussion

Specifies whether to include a time stamp as part of the recorded audio file name. Default: "false". The value can be set at runtime using the "includeTimeStampRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

includeTimeStampRuntime

"includeTimeStampRuntime": 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 "includeTimeStamp" property. Example: "$[IncludeTimeStamp]".

Parameter is optional.

Declared In

Voiceflow.schema.json

languageFolder

"languageFolder": string

Discussion

Specifies the name of the folder specific to language locale. This folder name is used as part of "fileLocation" for the final location to save "fileName" at. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

requestID

"requestID": string

Discussion

Specifies an ID that can be used to distinguish recorded audio files from others. User Defined. "requestID" is included in the name of the "fileName". Default: "" (an empty string is inserted in the filename). The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json