audioFormat JSON Reference
| Declared in | AudioPromptModuleList.schema.json |
Overview
The parameters to control the audio format of recorded audio to a file
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
-
formatIDjson parameterThe audio format of the recorded audio to a file. Options are:
"linearpcm"for linear PCM,"aac"for Apple MPEG4 AAC, and"alac"for Apple Lossless. Default value is"linearpcm".The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
commonFormatjson parameterThe common format of the recorded audio to a file. Options are:
"int16","int32","float32"and"float64". Default value is"float32".The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
sampleRatejson parameterThe sampling rate of the recorded audio to a file. Options are:
"16000","22050","32000","44100"and"48000". Default value is determined automatically by the media engine. The value can be set at runtime using the"sampleRateRuntime"property.Parameter is optional.
-
sampleRateRuntimejson parameterContains 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"sampleRate"property. Example:"$[SampleRate]".Parameter is optional.
-
channelCountjson parameterThe number of channerls of the recorded audio to a file. Options are:
"1"and"2". Default value is determined automatically by the media engine. The value can be set at runtime using the"channelCountRuntime"property.Parameter is optional.
-
channelCountRuntimejson parameterContains 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"channelCount"property. Example:"$[ChannelCount]".Parameter is optional.
-
encoderBitsPerSamplejson parameterThe number of encoder bits per sample of the recorded audio to a file. This only applies to format ID
"alac“. Options are:"16","20","24"and"32". Default value is"32". The value can be set at runtime using the"encoderBitsPerSampleRuntime"property.Parameter is optional.
-
encoderBitsPerSampleRuntimejson parameterContains 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"encoderBitsPerSample"property. Example:"$[EncoderBitsPerSample]".Parameter is optional.
-
encoderBitRatejson parameterThe encoder bit rate of the recorded audio to a file. This only applies to format ID
"aac“. Examples of values:"32000","64000","96000"and"128000". Default value is determined automatically by the media engine. Note: Setting the bit rate to higher may result in failure in recording audio to a file. The value can be set at runtime using the"encoderBitRateRuntime"property.Parameter is optional.
-
encoderBitRateRuntimejson parameterContains 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"encoderBitRate"property. Example:"$[EncoderBitRate]".Parameter is optional.
JSON Parameters
channelCount
"channelCount": integer
Discussion
The number of channerls of the recorded audio to a file. Options are: "1" and "2". Default value is determined automatically by the media engine. The value can be set at runtime using the "channelCountRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
channelCountRuntime
"channelCountRuntime": 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 "channelCount" property. Example: "$[ChannelCount]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
commonFormat
"commonFormat": string
Discussion
The common format of the recorded audio to a file. Options are: "int16", "int32", "float32" and "float64". Default value is "float32".The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
encoderBitRate
"encoderBitRate": integer
Discussion
The encoder bit rate of the recorded audio to a file. This only applies to format ID "aac“. Examples of values: "32000", "64000", "96000" and "128000". Default value is determined automatically by the media engine. Note: Setting the bit rate to higher may result in failure in recording audio to a file. The value can be set at runtime using the "encoderBitRateRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
encoderBitRateRuntime
"encoderBitRateRuntime": 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 "encoderBitRate" property. Example: "$[EncoderBitRate]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
encoderBitsPerSample
"encoderBitsPerSample": integer
Discussion
The number of encoder bits per sample of the recorded audio to a file. This only applies to format ID "alac“. Options are: "16", "20", "24" and "32". Default value is "32". The value can be set at runtime using the "encoderBitsPerSampleRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
encoderBitsPerSampleRuntime
"encoderBitsPerSampleRuntime": 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 "encoderBitsPerSample" property. Example: "$[EncoderBitsPerSample]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
formatID
"formatID": string
Discussion
The audio format of the recorded audio to a file. Options are: "linearpcm" for linear PCM, "aac" for Apple MPEG4 AAC, and "alac" for Apple Lossless. Default value is "linearpcm".The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
sampleRate
"sampleRate": integer
Discussion
The sampling rate of the recorded audio to a file. Options are: "16000", "22050", "32000", "44100" and "48000". Default value is determined automatically by the media engine. The value can be set at runtime using the "sampleRateRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
sampleRateRuntime
"sampleRateRuntime": 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 "sampleRate" property. Example: "$[SampleRate]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json