Audio Codec JSON Reference
| Declared in | AudioPromptModuleList.schema.json |
Overview
(Experimental) The audio codec parameters to use for audio playback if one is not specified in "audioFormat" parameter.
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
-
payloadTypepropertyType of payload. Examples: 0 for PCMU; 8 for PCMA; 9 for G&22; 120 foe OPUS, etc. The value can be set at runtime using the
"payloadTypeRuntime"property..Parameter is required.
-
payloadTypeRuntimepropertyContains 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"payloadType"property. Example:"$[PayloadType]".Parameter is optional.
-
payloadNamepropertyName of audio codec payload. Examples:
"PCMU","PCMA","G722","OPUS". etc. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is required.
-
payloadFrequencypropertySampling rate: number of samples per second. Examples: 8000, 16000, 320000, 48000, etc. The value can be set at runtime using the
"payloadFrequencyRuntime"property.Parameter is required.
-
payloadFrequencyRuntimepropertyContains 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"payloadFrequency"property. Example:"$[PayloadFrequency]".Parameter is optional.
-
audioPacketSizeBytespropertySize of an audio frame packet. Example: sampling rate divided by 100 for a 10ms frame and multiplied by number of bytes per sample. The value can be set at runtime using the
"audioPacketSizeBytesRuntime"property.Parameter is required.
-
audioPacketSizeBytesRuntimepropertyContains 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"audioPacketSizeBytes"property. Example:"$[AudioPacketSizeBytes]".Parameter is optional.
-
numberChannelsPerAudioSamplepropertyNumber of channels. Values: 1 for mono or 2 for stereo. The value can be set at runtime using the
"numberChannelsPerAudioSampleRuntime"property.Parameter is required.
-
numberChannelsPerAudioSampleRuntimepropertyContains 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"numberChannelsPerAudioSample"property. Example:"$[NumberChannelsPerAudioSample]".Parameter is optional.
-
sampleRateBitsPerSecondpropertyBit rate per second. Example: sampling rate multiplied by number of bytes per sample multiplied by number of bits per byte. The value can be set at runtime using the
"sampleRateBitsPerSecondRuntime"property.Parameter is required.
-
sampleRateBitsPerSecondRuntimepropertyContains 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"sampleRateBitsPerSecond"property. Example:"$[SampleRateBitsPerSecond]".Parameter is optional.
Properties
audioPacketSizeBytes
"audioPacketSizeBytes": integer
Discussion
Size of an audio frame packet. Example: sampling rate divided by 100 for a 10ms frame and multiplied by number of bytes per sample. The value can be set at runtime using the "audioPacketSizeBytesRuntime" property.
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
audioPacketSizeBytesRuntime
"audioPacketSizeBytesRuntime": 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 "audioPacketSizeBytes" property. Example: "$[AudioPacketSizeBytes]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
numberChannelsPerAudioSample
"numberChannelsPerAudioSample": integer
Discussion
Number of channels. Values: 1 for mono or 2 for stereo. The value can be set at runtime using the "numberChannelsPerAudioSampleRuntime" property.
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
numberChannelsPerAudioSampleRuntime
"numberChannelsPerAudioSampleRuntime": 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 "numberChannelsPerAudioSample" property. Example: "$[NumberChannelsPerAudioSample]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
payloadFrequency
"payloadFrequency": integer
Discussion
Sampling rate: number of samples per second. Examples: 8000, 16000, 320000, 48000, etc. The value can be set at runtime using the "payloadFrequencyRuntime" property.
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
payloadFrequencyRuntime
"payloadFrequencyRuntime": 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 "payloadFrequency" property. Example: "$[PayloadFrequency]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
payloadName
"payloadName": string
Discussion
Name of audio codec payload. Examples: "PCMU", "PCMA", "G722", "OPUS". etc. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
payloadType
"payloadType": integer
Discussion
Type of payload. Examples: 0 for PCMU; 8 for PCMA; 9 for G&22; 120 foe OPUS, etc. The value can be set at runtime using the "payloadTypeRuntime" property..
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
payloadTypeRuntime
"payloadTypeRuntime": 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 "payloadType" property. Example: "$[PayloadType]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
sampleRateBitsPerSecond
"sampleRateBitsPerSecond": integer
Discussion
Bit rate per second. Example: sampling rate multiplied by number of bytes per sample multiplied by number of bits per byte. The value can be set at runtime using the "sampleRateBitsPerSecondRuntime" property.
Parameter is required.
Declared In
AudioPromptModuleList.schema.json
sampleRateBitsPerSecondRuntime
"sampleRateBitsPerSecondRuntime": 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 "sampleRateBitsPerSecond" property. Example: "$[SampleRateBitsPerSecond]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json