Transcribe specified hosts

Real-Time STT supports 2 transcription modes:

• Channel-based transcription for all active hosts in a channel. To enable it, see REST Quickstart.
• Transcription of the specified hosts audio only and ignoring all other hosts.

This page explains how to implement transcription of specified hosts only.

Prerequisites

To follow this procedure, you must:

• Have a valid Agora Account.

• Have a valid Agora project with an app ID and a temporary token or a token server. For details, see Agora account management.

• Have a computer with access to the internet. If your network has a firewall, follow the steps in Firewall requirements.

• Join a Video SDK channel as a host and start streaming. Refer to the Voice SDK quickstart guide.

• Make sure Real-Time STT is enabled for your app.

Implementation

To transcribe a specific host, follow the API call sequence from the REST Quickstart and modify the start request to add the subscribeAudioUids parameter as follows:

curl --location --request POST 'https://api.agora.io/api/speech-to-text/v1/projects/{appId}/join' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <credentials>' \
--data '{
    "name": "unique-agent-id",
    "languages": [
        "en-US"
    ],
    "maxIdleTime": 50,
    "rtcConfig": {
        "channelName": "<YourChannelName>",
        "subBotUid": "<YourSubscribeUid>",
        "subBotToken": "<YourSubscribeToken>",
        "pubBotUid": "<YourPublishUid>",
        "pubBotToken": "<YourPublishToken>",
        "subscribeAudioUids": ["123", "456"]
    }
}'

Alternatively, you can specify the user IDs for the audio streams you do not want to subscribe in the unSubscribeAudioUids parameter. You can set either subscribeAudioUids or unSubscribeAudioUids.