---
updatedAt: 2026-08-18T01:46:20.000Z
---
Fetch the complete documentation index at: https://docs.apptek.com/llms.txt. Use this file to discover all available pages before exploring further.
# Interfaces
# Interfaces & Data Models
A complete reference for all interface configurations, data payloads, and callback types.
## Quick Index
* [AppTekSDKCallbacks](#appteksdkcallbacks)
* [AudioMetrics](#audiometrics)
* [ClientAuth](#clientauth)
* [Language](#language)
* [MicrophoneConfig](#microphoneconfig)
* [NetworkStatsResponse](#networkstatsresponse)
* [PingResponse](#pingresponse)
* [Recognize2AudioConfig](#recognize2audioconfig)
* [Recognize2AvailableResponse](#recognize2availableresponse)
* [Recognize2DiarizationInformation](#recognize2diarizationinformation)
* [Recognize2DiarizationSpeakerSection](#recognize2diarizationspeakersection)
* [Recognize2DiarizerConfig](#recognize2diarizerconfig)
* [Recognize2PCTranscription](#recognize2pctranscription)
* [Recognize2Progress](#recognize2progress)
* [Recognize2Segment](#recognize2segment)
* [Recognize2SegmenterConfig](#recognize2segmenterconfig)
* [Recognize2SpeechConfig](#recognize2speechconfig)
* [Recognize2StreamConfig](#recognize2streamconfig)
* [Recognize2StreamResponse](#recognize2streamresponse)
* [Recognize2TimedTranscription](#recognize2timedtranscription)
* [Recognize2Transcription](#recognize2transcription)
* [Recognize2TranslateConfig](#recognize2translateconfig)
* [Recognize2Translation](#recognize2translation)
* [RecognizeAvailable](#recognizeavailable)
* [RoomActivatedStatus](#roomactivatedstatus)
* [RoomActivationMessage](#roomactivationmessage)
* [RoomListResponse](#roomlistresponse)
* [RoomResponse](#roomresponse)
* [TranslateAvailable](#translateavailable)
* [TranslateAvailableResponse](#translateavailableresponse)
* [TranslateGlossaryOptions](#translateglossaryoptions)
* [TranslateTextMetaOptions](#translatetextmetaoptions)
***
## AppTekSDKCallbacks
### Properties
| Property | Type | Description |
| ------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `onAudioMetrics?` | (`metrics`) => `void` | Optional callback that receives real-time audio quality metrics. |
| `onData` | (`data`) => `void` | Called when data receives from the server. The data object contains fields like transcription, segment, translation, etc. |
| `onError` | (`err`) => `void` | - |
| `onMicrophoneData?` | (`data`) => `void` | Optional callback receives raw microphone input (Float32Array) for visualization. |
| `onStatusChange?` | (`status`) => `void` | - |
***
## AudioMetrics
### Properties
| Property | Type | Description | | |
| ---------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | ---------- |
| `isClipping` | `boolean` | Boolean indicating if the signal is clipping (amplitude near maximum, causing distortion) | | |
| `noiseFloorDb` | `number` | Estimated background noise floor in dB FS (based on a rolling minimum of signal level) | | |
| `peak` | `number` | Maximum absolute peak amplitude in the current frame (0.0 to 1.0) | | |
| `snrDb` | `number` | Estimated Signal-to-Noise Ratio (SNR) in dB. High is good (e.g. >25dB), low indicates noisy speech (e.g. <15dB) | | |
| `status` | `"silent"` \| `"normal"` \| `"clipping"` | Text representation of audio state: 'silent' | 'normal' | 'clipping' |
| `volume` | `number` | Root Mean Square (RMS) volume level, normalized between 0.0 (silence) and 1.0 (max amplitude) | | |
| `volumeDb` | `number` | Volume level represented in Decibels (dB FS), ranging from -100 (silence) to 0 (maximum level) | | |
***
## ClientAuth
### Properties
| Property | Type |
| ------------------------------------ | -------- |
| `licenseKey` | `string` |
***
## Language
### Properties
| Property | Type |
| -------------------------------------- | -------- |
| `direction` | `number` |
| `englishName` | `string` |
| `langCode` | `string` |
| `nativeName` | `string` |
***
## MicrophoneConfig
### Properties
| Property | Type | Description |
| ------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `mediaStream?` | `MediaStream` | Optional MediaStream to use instead of requesting user media. Useful for processing audio from video elements or other sources. |
| `onAudioMetrics?` | (`metrics`) => `void` | Optional callback that receives real-time audio quality metrics. |
| `onData` | (`data`) => `void` | Callback function that receives chunks of Int16 PCM audio data. |
| `onMicrophoneData?` | (`data`) => `void` | Optional callback for raw microphone data (Float32Array), useful for visualization. |
| `sampleRate?` | `number` | Desired sample rate (default 16000). |
| `workletUrl?` | `string` | Optional URL to load the AudioWorklet processor from. If not provided, an inline Blob will be used. Use this if your Content Security Policy (CSP) blocks 'blob:' workers. You will need to serve the processor code (available as 'dist/pcm-processor.js' in the package) yourself. |
***
## NetworkStatsResponse
### Properties
| Property | Type |
| ---------------------------------- | ----------- |
| `pings` | `object`\[] |
| `rttAvg` | `number` |
| `rttJitter` | `number` |
| `rttMax` | `number` |
| `rttMin` | `number` |
***
## PingResponse
### Properties
| Property | Type |
| ------------------------------------------------ | -------- |
| `rtt` | `number` |
| `serverTime` | `number` |
| `serverTimeOffset` | `number` |
***
## Recognize2AudioConfig
### Properties
| Property | Type |
| ---------------------------------------- | -------------------------------------- |
| `channels` | `number` |
| `sampleRateHz` | `number` |
| `sampleType` | `0` \| `"INT16"` \| `"FLOAT32"` \| `1` |
***
## Recognize2AvailableResponse
### Properties
| Property | Type |
| ------------------------ | ------------------------------------------------ |
| `list` | [`RecognizeAvailable`](RecognizeAvailable.md)\[] |
***
## Recognize2DiarizationInformation
### Properties
| Property | Type |
| --------------------------------------- | -------- |
| `speakerId` | `string` |
| `speakerName?` | `string` |
***
## Recognize2DiarizationSpeakerSection
### Properties
| Property | Type |
| ------------------------------------------ | -------- |
| `orth` | `string` |
| `postprocessed` | `string` |
| `speaker` | `string` |
| `startTimeMs` | `number` |
| `stopTimeMs` | `number` |
| `translation` | `string` |
***
## Recognize2DiarizerConfig
### Properties
| Property | Type |
| ---------------------------- | --------- |
| `enable` | `boolean` |
***
## Recognize2PCTranscription
### Properties
| Property | Type |
| ------------------------------------------------------- | ----------------------------------------------------------------- |
| `isAttachedLeft` | `boolean` |
| `isSentenceEnd` | `boolean` |
| `stableTranscription?` | [`Recognize2TimedTranscription`](Recognize2TimedTranscription.md) |
| `text` | `string` |
***
## Recognize2Progress
### Properties
| Property | Type |
| ---------------------------------- | -------- |
| `timestamp` | `string` |
***
## Recognize2Segment
### Properties
| Property | Type |
| ------------------------------------------------------- | ------------------------------------------------------------------------- |
| `diarizerInfo?` | [`Recognize2DiarizationInformation`](Recognize2DiarizationInformation.md) |
| `start?` | `string` |
| `stop?` | `string` |
| `text` | `string` |
| `timedTranscriptions?` | [`Recognize2TimedTranscription`](Recognize2TimedTranscription.md)\[] |
***
## Recognize2SegmenterConfig
### Properties
| Property | Type |
| ------------------------------------------------------------------- | -------- |
| `sentenceEndTokenThreshold?` | `number` |
***
## Recognize2SpeechConfig
### Properties
| Property | Type |
| -------------------------------- | -------- |
| `domain?` | `string` |
| `langCode` | `string` |
***
## Recognize2StreamConfig
### Properties
| Property | Type | Description |
| --------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------ |
| `audioConfiguration` | [`Recognize2AudioConfig`](Recognize2AudioConfig.md) | - |
| `diarizerConfiguration?` | [`Recognize2DiarizerConfig`](Recognize2DiarizerConfig.md) | - |
| `room_id?` | `string` | Optional Room ID to broadcast transcriptions to. |
| `segmenterConfiguration?` | [`Recognize2SegmenterConfig`](Recognize2SegmenterConfig.md) | - |
| `speechConfiguration` | [`Recognize2SpeechConfig`](Recognize2SpeechConfig.md) | - |
| `translateConfigurations?` | [`Recognize2TranslateConfig`](Recognize2TranslateConfig.md)\[] | - |
***
## Recognize2StreamResponse
### Properties
| Property | Type |
| ----------------------------------------------- | ----------------------------------------------------------- |
| `pcTranscription?` | [`Recognize2PCTranscription`](Recognize2PCTranscription.md) |
| `progress?` | [`Recognize2Progress`](Recognize2Progress.md) |
| `segment?` | [`Recognize2Segment`](Recognize2Segment.md) |
| `transcription?` | [`Recognize2Transcription`](Recognize2Transcription.md) |
| `translation?` | [`Recognize2Translation`](Recognize2Translation.md) |
***
## Recognize2TimedTranscription
### Properties
| Property | Type |
| ------------------------------------ | -------- |
| `confidence` | `number` |
| `langCode?` | `string` |
| `start?` | `string` |
| `stop?` | `string` |
| `text` | `string` |
***
## Recognize2Transcription
### Properties
| Property | Type |
| ------------------------------------------------------------- | -------------------------------------------------------------------- |
| `stableTranscriptions?` | [`Recognize2TimedTranscription`](Recognize2TimedTranscription.md)\[] |
| `unstableTranscriptions?` | [`Recognize2TimedTranscription`](Recognize2TimedTranscription.md)\[] |
***
## Recognize2TranslateConfig
### Properties
| Property | Type |
| ----------------------------------------------- | --------------------------------------------------------- |
| `domain` | `string` |
| `glossaryOptions?` | [`TranslateGlossaryOptions`](TranslateGlossaryOptions.md) |
| `metaOptions?` | [`TranslateTextMetaOptions`](TranslateTextMetaOptions.md) |
| `targetLangCode` | `string` |
***
## Recognize2Translation
### Properties
| Property | Type |
| --------------------------------- | -------- |
| `domain?` | `string` |
| `langCode?` | `string` |
| `start?` | `string` |
| `stop?` | `string` |
| `text` | `string` |
***
## RecognizeAvailable
### Properties
| Property | Type |
| -------------------------------------------------- | ---------------------------- |
| `diarization` | `boolean` |
| `domain` | `string` |
| `language` | [`Language`](Language.md) |
| `mtTargetLanguages` | [`Language`](Language.md)\[] |
| `sampleRateHz` | `number` |
***
## RoomActivatedStatus
Status message from the server confirming a room has been activated for broadcasting.
### Properties
| Property | Type |
| ------------------------------ | ------------------ |
| `room_id` | `string` |
| `status` | `"room_activated"` |
***
## RoomActivationMessage
Message sent to the server to dynamically create/activate a room mid-session.
### Properties
| Property | Type | Description |
| ------------------------------ | --------------- | -------------------------------------------- |
| `action` | `"create_room"` | - |
| `room_id` | `string` | The ID of the room to activate/broadcast to. |
***
## RoomListResponse
Response returned when listing rooms associated with a license key.
### Properties
| Property | Type | Description |
| -------------------------- | ----------- | ---------------------------- |
| `rooms` | `string`\[] | An array of active room IDs. |
***
## RoomResponse
Response returned when a new room is created.
### Properties
| Property | Type | Description |
| ------------------------------ | -------- | ------------------------------------------- |
| `room_id` | `string` | The unique identifier for the created room. |
***
## TranslateAvailable
### Properties
| Property | Type |
| -------------------------------------------------- | ------------------------- |
| `computeConfidence` | `boolean` |
| `domain` | `string` |
| `extendedContext` | `boolean` |
| `formats` | `number`\[] |
| `genderCodes` | `string`\[] |
| `genreCodes` | `string`\[] |
| `glossary` | `boolean` |
| `lengthCodes` | `string`\[] |
| `sourceLanguage` | [`Language`](Language.md) |
| `styleCodes` | `string`\[] |
| `targetLanguage` | [`Language`](Language.md) |
| `topicCodes` | `string`\[] |
***
## TranslateAvailableResponse
### Properties
| Property | Type |
| ------------------------ | ------------------------------------------------ |
| `list` | [`TranslateAvailable`](TranslateAvailable.md)\[] |
***
## TranslateGlossaryOptions
### Properties
| Property | Type |
| ------------------------------------------------------ | --------- |
| `enableNumberTagging` | `boolean` |
| `glossaryId` | `string` |
***
## TranslateTextMetaOptions
### Properties
| Property | Type |
| ------------------------------------- | -------- |
| `genderCode?` | `string` |
| `genreCode?` | `string` |
| `lengthCode?` | `string` |
| `styleCode?` | `string` |
| `topicCode?` | `string` |