SDKsHarmonyOSEnterprise

Check speech-to-text capabilities

Query audio formats, sampling rates, and constraints supported by the speech recognition service.

Query speech recognition capabilities before displaying transcription buttons or initializing audio recording.

Code example

import sdk, { GetSpeechToTextCapabilitiesResp } from '@openimsdk/imsdk';

const capabilities: GetSpeechToTextCapabilitiesResp = await sdk.getSpeechToTextCapabilities();
configureRecorder(
  capabilities.format,
  capabilities.sampleRateHz,
  capabilities.maxRecordTimeMs,
  capabilities.maxFileSize,
);

Parameters

This method does not take any parameters.

Return value

Returns a Promise resolving to GetSpeechToTextCapabilitiesResp:

Property	Type	Description
`format`	`string`	Audio encoding format (for example, `m4a`, `mp3`).
`sampleRateHz`	`number`	Required audio sampling rate in Hz.
`maxRecordTimeMs`	`number`	Maximum allowed recording duration in milliseconds.
`maxFileSize`	`number`	Maximum allowed audio payload size in bytes.
`provider`	`string`	Speech-to-text recognition service provider.
`requestType`	`string`	Integration request method type.
`crossDomain`	`boolean`	Cross-origin configuration setting.

maxRecordTimeMs is in milliseconds, and maxFileSize is in bytes. When this request fails or returned capability properties are empty, disable or hide the transcription interface rather than assuming default parameters. This query does not record audio, transcribe voice messages, or trigger message events. To transcribe audio, see Transcribe audio to text.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call