> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt

# VoxEngine

## Docs

- [VoxEngine](https://docs.voximplant.ai/api-reference/voxengine/overview.md): Reference for the JavaScript runtime that executes Voximplant scenarios
- [VoxEngine](https://docs.voximplant.ai/api-reference/voxengine/voxengine.md)
- [Scenario globals](https://docs.voximplant.ai/api-reference/voxengine/scenario-globals.md): Top-level functions and type aliases available in every VoxEngine scenario.
- [Modules](https://docs.voximplant.ai/api-reference/voxengine/modules.md): 26 values
- [AppEvents](https://docs.voximplant.ai/api-reference/voxengine/app-events.md): 7 values
- [TerminationStatus](https://docs.voximplant.ai/api-reference/voxengine/termination-status.md): The SmartQueue termination status.
- [ApplicationStorage](https://docs.voximplant.ai/api-reference/voxengine/application-storage.md): Represents an application storage object to manipulate key-value pairs.
- [Logger](https://docs.voximplant.ai/api-reference/voxengine/logger.md)
- [Crypto](https://docs.voximplant.ai/api-reference/voxengine/crypto.md)
- [Net](https://docs.voximplant.ai/api-reference/voxengine/net.md)
- [MeasurementProtocol](https://docs.voximplant.ai/api-reference/voxengine/measurement-protocol.md): Implementation of the Measurement Protocol v1.
- [VoximplantAPI](https://docs.voximplant.ai/api-reference/voxengine/voximplant-api/overview.md)
- [Client](https://docs.voximplant.ai/api-reference/voxengine/voximplant-api/client.md)
- [Call](https://docs.voximplant.ai/api-reference/voxengine/call.md): Represents an audio or video call.
- [Endpoint](https://docs.voximplant.ai/api-reference/voxengine/endpoint.md): Represents any remote media unit in a session.
- [Conference](https://docs.voximplant.ai/api-reference/voxengine/conference.md): Represents audio or video conference. Add the following line to your scenario code to use the class: ``` require(Modules.Conference); ```
- [ConferenceDirection](https://docs.voximplant.ai/api-reference/voxengine/conference-direction.md): Add the following line to your scenario code to use the enum: ``` require(Modules.Conference); ```
- [ConferenceEvents](https://docs.voximplant.ai/api-reference/voxengine/conference-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Conference); ```
- [ConferenceMode](https://docs.voximplant.ai/api-reference/voxengine/conference-mode.md): Add the following line to your scenario code to use the enum: ``` require(Modules.Conference); ```
- [ConferenceRecorder](https://docs.voximplant.ai/api-reference/voxengine/conference-recorder.md): Represents a conference recorder. Add the following line to your scenario code to use the class: ``` require(Modules.Recorder); ```
- [PhoneNumber](https://docs.voximplant.ai/api-reference/voxengine/phone-number.md)
- [DTMFType](https://docs.voximplant.ai/api-reference/voxengine/dtmf-type.md): The DTMF type.
- [VideoCodecs](https://docs.voximplant.ai/api-reference/voxengine/video-codecs.md): Supported video codecs for VoxEngine.setVideoCodec.
- [Player](https://docs.voximplant.ai/api-reference/voxengine/player.md): Represents an instance of an audio player.
- [PlayerEvents](https://docs.voximplant.ai/api-reference/voxengine/player-events.md): 9 values
- [StreamingAgent](https://docs.voximplant.ai/api-reference/voxengine/streaming-agent.md): Represents a streaming object to interact with streaming platforms.
- [StreamingAgentEvents](https://docs.voximplant.ai/api-reference/voxengine/streaming-agent-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.StreamingAgent); ```
- [SequencePlayer](https://docs.voximplant.ai/api-reference/voxengine/sequence-player.md): Represents an instance with segments represented by audio and URL players. Can be created by calling the VoxEngine.createSequencePlayer method.
- [SequencePlayerEvents](https://docs.voximplant.ai/api-reference/voxengine/sequence-player-events.md): 7 values
- [Recorder](https://docs.voximplant.ai/api-reference/voxengine/recorder.md): Represents an audio and video recorder. Add the following line to your scenario code to use the class: ``` require(Modules.Recorder); ```
- [RecorderDirection](https://docs.voximplant.ai/api-reference/voxengine/recorder-direction.md): An object that specifies video frame's direction.
- [RecorderEvents](https://docs.voximplant.ai/api-reference/voxengine/recorder-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Recorder); ```
- [RecorderLabelFont](https://docs.voximplant.ai/api-reference/voxengine/recorder-label-font.md): Enumeration of the recorder video fonts.
- [RecorderLabelPosition](https://docs.voximplant.ai/api-reference/voxengine/recorder-label-position.md): Enumeration of the recorder label position.
- [RecorderLabelTextAlign](https://docs.voximplant.ai/api-reference/voxengine/recorder-label-text-align.md): Enumeration of the recorder label text alignment.
- [RecorderLayout](https://docs.voximplant.ai/api-reference/voxengine/recorder-layout.md): An object that specifies video layout settings.
- [RecorderObjectFit](https://docs.voximplant.ai/api-reference/voxengine/recorder-object-fit.md): An object that specifies how to fill a participant's video source to the conference frame.
- [RecorderProfile](https://docs.voximplant.ai/api-reference/voxengine/recorder-profile.md): Enumeration of the video quality profiles.
- [RecordExpireTime](https://docs.voximplant.ai/api-reference/voxengine/record-expire-time.md): List of available values for the RecorderParameters.expire parameter.
- [URLPlayerRequestMethod](https://docs.voximplant.ai/api-reference/voxengine/url-player-request-method.md): The URLPlayerRequest method.
- [ASR](https://docs.voximplant.ai/api-reference/voxengine/asr.md): Represents an ASR object provides speech recognition capabilities.
- [ASRDictionary](https://docs.voximplant.ai/api-reference/voxengine/asr-dictionary.md): List of available dictionaries for ASR. Add the following line to your scenario code to use the enum: ``` require(Modules.ASR); ```
- [ASREvents](https://docs.voximplant.ai/api-reference/voxengine/asr-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.ASR); ```
- [ASRLanguage](https://docs.voximplant.ai/api-reference/voxengine/asr-language.md): List of available languages for ASR. RUSSIAN_RU' language. Add the following line to your scenario code to use the enum: ``` require(Modules.ASR); ```
- [ASRModel](https://docs.voximplant.ai/api-reference/voxengine/asr-model.md): Represents an ASR recognition model. List of all supported models: ASRModelList.
- [ASRModelList](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/overview.md): List of available ASR models.
- [Amazon](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/amazon.md): List of Amazon ASR models.
- [Cartesia](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/cartesia.md): List of Cartesia ASR models.
- [Deepgram](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/deepgram.md): List of Deepgram ASR models.
- [Google](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/google.md): List of Google ASR models.
- [Microsoft](https://docs.voximplant.ai/api-reference/voxengine/asr-model-list/microsoft.md): List of Microsoft ASR models.
- [ASRProfile](https://docs.voximplant.ai/api-reference/voxengine/asr-profile.md): Represents a profile that specifies an ASR provider and a language to use. List of all supported profiles: ASRProfileList.
- [ASRProfileList](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/overview.md): List of available ASR profiles.
- [Amazon](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/amazon.md): List of Amazon ASR profiles.
- [Cartesia](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/cartesia.md): List of Cartesia ASR profiles.
- [Deepgram](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/deepgram.md): List of Deepgram ASR profiles.
- [Google](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/google.md): List of Google ASR profiles.
- [Microsoft](https://docs.voximplant.ai/api-reference/voxengine/asr-profile-list/microsoft.md): List of Microsoft ASR profiles.
- [Voice](https://docs.voximplant.ai/api-reference/voxengine/voice.md): Represents a language and a voice for TTS. List of all supported voices: VoiceList.
- [VoiceList](https://docs.voximplant.ai/api-reference/voxengine/voice-list/overview.md): List of available TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Amazon](https://docs.voximplant.ai/api-reference/voxengine/voice-list/amazon/overview.md): List of available Amazon TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Neural](https://docs.voximplant.ai/api-reference/voxengine/voice-list/amazon/neural.md): List of available premium Amazon TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Default](https://docs.voximplant.ai/api-reference/voxengine/voice-list/default.md): List of available freemium TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [ElevenLabs](https://docs.voximplant.ai/api-reference/voxengine/voice-list/elevenlabs.md): List of available ElevenLabs TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Google](https://docs.voximplant.ai/api-reference/voxengine/voice-list/google.md): List of available Google TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [IBM](https://docs.voximplant.ai/api-reference/voxengine/voice-list/ibm/overview.md): List of available IBM TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Neural](https://docs.voximplant.ai/api-reference/voxengine/voice-list/ibm/neural.md): List of available premium IBM TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Microsoft](https://docs.voximplant.ai/api-reference/voxengine/voice-list/microsoft/overview.md): List of available Microsoft TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [Neural](https://docs.voximplant.ai/api-reference/voxengine/voice-list/microsoft/neural.md): List of available premium Microsoft TTS voices for the Call.say(/api-reference/voxengine/call#say) and…
- [TranscriptionProvider](https://docs.voximplant.ai/api-reference/voxengine/transcription-provider.md): List of available values for the CallRecordParameters.provider parameter.
- [TTSEffectsProfile](https://docs.voximplant.ai/api-reference/voxengine/tts-effects-profile.md): List of available audio effect (profiles that are applied on post synthesized text to speech) for the…
- [VoxTTS](https://docs.voximplant.ai/api-reference/voxengine/vox-tts/overview.md)
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/vox-tts/realtime-tts-player.md)
- [VoxTTSModelList](https://docs.voximplant.ai/api-reference/voxengine/vox-tts-model-list.md): The list of available models for VoxTTS.
- [VoxTTSVoiceList](https://docs.voximplant.ai/api-reference/voxengine/vox-tts-voice-list.md): The list of available voices for VoxTTS.
- [Hush](https://docs.voximplant.ai/api-reference/voxengine/hush/overview.md)
- [Events](https://docs.voximplant.ai/api-reference/voxengine/hush/events.md): 2 values
- [NoiseSuppression](https://docs.voximplant.ai/api-reference/voxengine/hush/noise-suppression.md)
- [NoiseSuppressionEvents](https://docs.voximplant.ai/api-reference/voxengine/hush/noise-suppression-events.md): 3 values
- [Silero](https://docs.voximplant.ai/api-reference/voxengine/silero/overview.md)
- [VAD](https://docs.voximplant.ai/api-reference/voxengine/silero/vad.md)
- [VADEvents](https://docs.voximplant.ai/api-reference/voxengine/silero/vad-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Silero); ```
- [DialogflowLanguage](https://docs.voximplant.ai/api-reference/voxengine/dialogflow-language.md): See the [Dialogflow ES language table](https://cloud.google.com/dialogflow/es/docs/reference/language#table) for reference.
- [DialogflowModel](https://docs.voximplant.ai/api-reference/voxengine/dialogflow-model.md): Add the following line to your scenario code to use the enum: ``` require(Modules.AI); ```
- [DialogflowModelVariant](https://docs.voximplant.ai/api-reference/voxengine/dialogflow-model-variant.md): Add the following line to your scenario code to use the enum: ``` require(Modules.AI); ```
- [DialogflowSsmlVoiceGender](https://docs.voximplant.ai/api-reference/voxengine/dialogflow-ssml-voice-gender.md): Add the following line to your scenario code to use the enum: ``` require(Modules.AI); ```
- [AI](https://docs.voximplant.ai/api-reference/voxengine/ai/overview.md): The AI module provides additional methods that use Artificial Intelligence.
- [DialogflowInstance](https://docs.voximplant.ai/api-reference/voxengine/ai/dialogflow-instance.md): Represents a Dialogflow instance. Add the following line to your scenario code to use the class: ``` require(Modules.AI); ```
- [Events](https://docs.voximplant.ai/api-reference/voxengine/ai/events.md): Add the following line to your scenario code to use the events: ``` require(Modules.AI); ```
- [AMD](https://docs.voximplant.ai/api-reference/voxengine/amd/overview.md): Answering Machine Detection provides methods that allow developers to recognize voicemail prompts with the help of artificial intelligence.
- [AnsweringMachineDetector](https://docs.voximplant.ai/api-reference/voxengine/amd/answering-machine-detector.md): Answering machine or voicemail detector class.
- [Events](https://docs.voximplant.ai/api-reference/voxengine/amd/events.md): 2 values
- [Model](https://docs.voximplant.ai/api-reference/voxengine/amd/model.md): Answering machine or voicemail detector model.
- [ResultClass](https://docs.voximplant.ai/api-reference/voxengine/amd/result-class.md): Answering machine result class, such as human, voicemail, timeout or call termination.
- [ResultSubtype](https://docs.voximplant.ai/api-reference/voxengine/amd/result-subtype.md): Answering machine result subtype, such as mimic or none.
- [Agentic](https://docs.voximplant.ai/api-reference/voxengine/agentic/overview.md)
- [VoiceDSP](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp.md): Agentic voice DSP is a composite connector working with underlying Silero.VAD and Pipecat.TurnDetector.
- [VoiceDSPEvents](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Agentic); ```
- [VoiceDSPStrategies](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/overview.md)
- [MinWordsStart](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/min-words-start.md): A start strategy that requires the user to speak a minimum number of words before triggering a turn start.
- [SpeechTimeoutStop](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/speech-timeout-stop.md): A stop strategy that uses a configurable timeout to determine if the user is done speaking.
- [TranscriptionStart](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/transcription-start.md): A start strategy that triggers a user turn start when a transcription is received.
- [TurnDetectorStop](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/turn-detector-stop.md): A stop strategy that uses the AI-powered turn detection model to determine if the user is done speaking.
- [VADStart](https://docs.voximplant.ai/api-reference/voxengine/agentic/voice-dsp-strategies/vad-start.md): A start strategy that triggers a user turn start based on Voice Activity Detection.
- [Cartesia](https://docs.voximplant.ai/api-reference/voxengine/cartesia.md): Agents WebSocket client for Cartesia Line voice agent scenarios.
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/cartesia/realtime-tts-player.md)
- [CCAI](https://docs.voximplant.ai/api-reference/voxengine/ccai/overview.md)
- [Agent](https://docs.voximplant.ai/api-reference/voxengine/ccai/agent.md): Represents a CCAI Agent instance.
- [Conversation](https://docs.voximplant.ai/api-reference/voxengine/ccai/conversation.md): Represents a CCAI conversation instance.
- [Events](https://docs.voximplant.ai/api-reference/voxengine/ccai/events/overview.md)
- [Agent](https://docs.voximplant.ai/api-reference/voxengine/ccai/events/agent.md): Events related to CCAI agents.
- [Conversation](https://docs.voximplant.ai/api-reference/voxengine/ccai/events/conversation.md): Events related to CCAI conversations.
- [Participant](https://docs.voximplant.ai/api-reference/voxengine/ccai/events/participant.md): Events related to CCAI participants.
- [Participant](https://docs.voximplant.ai/api-reference/voxengine/ccai/participant.md): Represents a CCAI participant instance.
- [Vendor](https://docs.voximplant.ai/api-reference/voxengine/ccai/vendor/overview.md)
- [Role](https://docs.voximplant.ai/api-reference/voxengine/ccai/vendor/role.md): Enumeration of the roles a participant can play in a conversation.
- [Deepgram](https://docs.voximplant.ai/api-reference/voxengine/deepgram/overview.md): Voice Agent API and Realtime TTS for Deepgram scenarios.
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/deepgram/realtime-tts-player.md)
- [ElevenLabs](https://docs.voximplant.ai/api-reference/voxengine/elevenlabs/overview.md): Agents WebSocket client for ElevenLabs conversational AI scenarios.
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/elevenlabs/realtime-tts-player.md)
- [Gemini](https://docs.voximplant.ai/api-reference/voxengine/gemini.md): Voice agent client for Google Gemini Live API real-time voice scenarios.
- [Google](https://docs.voximplant.ai/api-reference/voxengine/google/overview.md)
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/google/realtime-tts-player.md)
- [Inworld](https://docs.voximplant.ai/api-reference/voxengine/inworld.md): Realtime TTS player for Inworld speech synthesis in VoxEngine.
- [Events](https://docs.voximplant.ai/api-reference/voxengine/inworld/events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Inworld); ```
- [RealtimeAPIClient](https://docs.voximplant.ai/api-reference/voxengine/inworld/realtime-api-client.md)
- [RealtimeAPIEvents](https://docs.voximplant.ai/api-reference/voxengine/inworld/realtime-api-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.Inworld); ```
- [OpenAI](https://docs.voximplant.ai/api-reference/voxengine/openai/overview.md): API clients for OpenAI chat completions, responses, realtime, and GPT Live voice scenarios.
- [RealtimeAPIClientType](https://docs.voximplant.ai/api-reference/voxengine/openai/realtime-api-client-type.md): OpenAI.RealtimeAPIClient parameters. Can be passed as arguments to the OpenAI.createRealtimeAPIClient method.
- [Pipecat](https://docs.voximplant.ai/api-reference/voxengine/pipecat.md): Turn detector client for Pipecat Cloud WebSocket turn prediction.
- [Ultravox](https://docs.voximplant.ai/api-reference/voxengine/ultravox.md): WebSocket API client for Ultravox real-time agent scenarios.
- [XAI](https://docs.voximplant.ai/api-reference/voxengine/xai/overview.md): Voice Agent API and Realtime TTS for xAI Grok scenarios.
- [RealtimeTTSPlayer](https://docs.voximplant.ai/api-reference/voxengine/xai/realtime-tts-player.md)
- [MCP](https://docs.voximplant.ai/api-reference/voxengine/mcp/overview.md)
- [Client](https://docs.voximplant.ai/api-reference/voxengine/mcp/client.md): Note that the MCP.Client uses the [Model Context Protocol Go SDK v1.5.0](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk@v1.5.0).
- [ServerEvents](https://docs.voximplant.ai/api-reference/voxengine/mcp/server-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.MCP); ```
- [WebSocket](https://docs.voximplant.ai/api-reference/voxengine/websocket.md): Represents a WebSocket instance that provides the API for creating and managing an outgoing or incoming WebSocket connection, as well as for sending and…
- [WebSocketAudioEncoding](https://docs.voximplant.ai/api-reference/voxengine/websocket-audio-encoding.md): Available audio encoding formats. Can be passed via the SendMediaParameters.encoding parameter. The default value is **PCM16_8KHZ**.
- [WebSocketCloseCode](https://docs.voximplant.ai/api-reference/voxengine/websocket-close-code.md): 15 values
- [WebSocketEvents](https://docs.voximplant.ai/api-reference/voxengine/websocket-events.md): 7 values
- [WebSocketReadyState](https://docs.voximplant.ai/api-reference/voxengine/websocket-ready-state.md): 4 values
- [CallList](https://docs.voximplant.ai/api-reference/voxengine/call-list.md): Represents a call list to interact with Voximplant's call list processing functionality.
- [ACDEvents](https://docs.voximplant.ai/api-reference/voxengine/acd-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.ACD); ```
- [ACDRequest](https://docs.voximplant.ai/api-reference/voxengine/acd-request.md): Represents a request that is put to the ACD queue. Add the following line to your scenario code to use the class: ``` require(Modules.ACD); ```
- [SmartQueueEvents](https://docs.voximplant.ai/api-reference/voxengine/smart-queue-events.md): Add the following line to your scenario code to use the events: ``` require(Modules.SmartQueue); ```
- [SmartQueueOperatorSettingsMode](https://docs.voximplant.ai/api-reference/voxengine/smart-queue-operator-settings-mode.md): The SmartQueue task distribution mode. Can be passed via the SmartQueueOperatorSettings.mode parameter.
- [SmartQueueTask](https://docs.voximplant.ai/api-reference/voxengine/smart-queue-task.md): A SmartQueue task is for a certain agent, which can be a call or a chat.
- [TaskWaitingCode](https://docs.voximplant.ai/api-reference/voxengine/task-waiting-code.md): The SmartQueue task's waiting code.