Declared in Voiceflow.schema.json

Overview

Specifies the parameters for a "playAudio" type Voiceflow Module. "playAudioParams" configuration is used in "playAudio" 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

  •   style

    Specifies the style or method for processing the Audio Prompt Modules configured for audio playback. Values: "single", "select", or "combo". Default: "single" if "promptID" is configured or "combo" if "promptCollection" is configured. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   promptID

    The ID of an Audio Prompt Module to process for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   promptCollection

    An array that represents a collection or a group of Audio Prompt Module IDs to process for audio playback.

    Parameter is optional.

           property
  •   ssEngine

    The default speech synthesizer engine to use for processing text audio segments referenced by Audio Prompt Modules configured in this Voiceflow Module. Values: "flite" or "apple". Default: "flite" or "apple" depending which was initialized last and if both flite and apple speech synthesizers are active. This applies to the Voiceflow Module. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           property
  •   ssVoiceParams

    Specifies the parameters of the voice used for Speech Synthesis. If declared in a "processParams" then this applies globally to all VoiceFlows. If declared in "playAudioParams" then this applies to the Voiceflow Module. if declared in an audio segment then this applies for that audio segment only.

    Parameter is optional.

           property

Properties

promptCollection

"promptCollection": array - [Prompt]

Discussion

An array that represents a collection or a group of Audio Prompt Module IDs to process for audio playback.

Parameter is optional.

Declared In

Voiceflow.schema.json

promptID

"promptID": string

Discussion

The ID of an Audio Prompt Module to process for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

ssEngine

"ssEngine": string

Discussion

The default speech synthesizer engine to use for processing text audio segments referenced by Audio Prompt Modules configured in this Voiceflow Module. Values: "flite" or "apple". Default: "flite" or "apple" depending which was initialized last and if both flite and apple speech synthesizers are active. This applies to the Voiceflow Module. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

ssVoiceParams

"ssVoiceParams": object - SSVoiceParams

Discussion

Specifies the parameters of the voice used for Speech Synthesis. If declared in a "processParams" then this applies globally to all VoiceFlows. If declared in "playAudioParams" then this applies to the Voiceflow Module. if declared in an audio segment then this applies for that audio segment only.

Parameter is optional.

Declared In

Voiceflow.schema.json

style

"style": string

Discussion

Specifies the style or method for processing the Audio Prompt Modules configured for audio playback. Values: "single", "select", or "combo". Default: "single" if "promptID" is configured or "combo" if "promptCollection" is configured. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json