BZFileCategory Constants Reference

BZVoiceFlow Framework Reference
1.2.0

Declared in

BZFileCategory.swift

BZFileCategory

This constant enumerator defines the category of files accessed and used as resources by BZVoiceFlow framework for Voiceflow processing.

Definition

enum BZFileCategory: String {

                            
                               case FC_PLAY_AUDIO = "PLAY_AUDIO"

                            
                               case FC_PLAY_TEXT = "PLAY_TEXT"

                            
                               case FC_RECORD_AUDIO = "RECORD_AUDIO"

                            
                               case FC_SPEECH_RECOGNITION = "SPEECH_RECOGNITION"

                            
                               case FC_SPEECH_SYNTHESIS = "SPEECH_SYNTHESIS"

                            
                               case FC_VOICEFLOW = "VOICEFLOW"

                            
                            };

Constants

case FC_PLAY_AUDIO

Represents recorded audio files or audio prompts to be processed for audio playback during Voiceflow processing.

Declared In BZFileCategory.swift.

case FC_PLAY_TEXT

Represents text files containing text to be processed for audio playback using speech synthesis during Voiceflow processing.

Declared In BZFileCategory.swift.

case FC_RECORD_AUDIO

Represents audio files recorded during the processing of Voiceflows. Audio files may be recorded during:
- Processing of “Record Audio” Voiceflow module.
- Speech recognition with saving speech utterance enabled.
- Voice activity detection and silence filtering of audio.
- Offline execution of acoustic echo cancelation.

Declared In BZFileCategory.swift.

case FC_SPEECH_RECOGNITION

Represents files containing optional resources needed to perform customized speech recognition tasks. These files provide the following resources:
- Contextual phrases (AppleSR only).
- Custom dictionaries (PocketSphinxSR only).
- FSG grammars (PocketSphinxSR only).
- JSGF grammars (PocketSphinxSR only).
- Key word spotting grammars (PocketSphinxSR only).
- LM models (PocketSphinxSR only).

Declared In BZFileCategory.swift.

case FC_SPEECH_SYNTHESIS

Represents files containing optional resources needed to perform customized speech synthesis tasks. These files provide the following resources:
- (FliteSS only) Lexicon file conatining custom speech synthesis pronunciations to use by the speech synthesizer for specific words.

Declared In BZFileCategory.swift.

case FC_VOICEFLOW

Represents the Voice Flow files that an application submits for processing. Voice Flow files include:
- Voiceflow (VF) files containing the JSON structured voice flow modules (VFM)s.
- Audio prompt (AP) file contating the JSON structured audio prompt mnodules (APM)s referenced in Voiceflow files.
- Audio-to-text map file which contains mapping of recorded audio file names to their corresponding text which may be used for speech synthesis alternative.

Declared In BZFileCategory.swift.

Declared In

BZFileCategory.swift