Paraformer Realtime speech recognition C# SDK overview
Stream audio to Paraformer with the C# SDK and receive recognition results.
Quick start
Follow SDK overview to install the SDK and configure your API key. Replace WorkspaceId in the example endpoint with your workspace ID from the same region.
Save the sample audio as asr_example.wav. The example reads the file in chunks to simulate live input without a microphone.
Transcribe the audio and print the final text of each sentence to the console.
using DashScope.Speech;
await using var client = new FunAsrSpeechTranscriber(new FunAsrTranscriberOptions
{
Model = "paraformer-realtime-v2",
Url = "wss://WorkspaceId.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference",
Format = "wav",
SampleRate = 16000,
});
client.SentenceEnd += (_, e) => Console.WriteLine(e.Sentence.Text);
using var audio = File.OpenRead("asr_example.wav");
byte[] buffer = new byte[3200];
await client.StartAsync();
int count;
while ((count = await audio.ReadAsync(buffer)) > 0)
{
await client.SendAudioAsync(buffer.AsMemory(0, count));
await Task.Delay(100);
}
await client.StopAsync();
Call workflow
- Create a
FunAsrSpeechTranscriberinstance withModelset toparaformer-realtime-v2(orparaformer-realtime-8k-v2) and subscribe to events such asSentenceEnd. - Call
StartAsyncto connect, sendrun-task, and wait fortask-started. - After
TranscriberStarted, callSendAudioAsynccontinuously at the audio playback rate. - Receive final sentence results in
SentenceEnd. - After all audio is sent, call
StopAsyncand wait fortask-finished(Completed). - Call
DisposeAsyncto release the connection when done.
Request parameters
Pass FunAsrTranscriberOptions to the FunAsrSpeechTranscriber constructor. Optional values set to null are omitted from the request.
| Parameter | Type | Default | Description |
|---|---|---|---|
|
|
| Model ID. Set the model for this family explicitly. |
|
|
| Audio format. |
|
|
| Set the sample rate in Hz to match the input audio. |
|
|
| Semantic sentence segmentation. |
|
|
| VAD end-of-sentence silence threshold in milliseconds. |
|
|
| Enable multi-threshold VAD segmentation. |
|
|
| Remove disfluencies. |
|
|
| Keep the connection alive while sending silent audio. |
|
|
| Precompiled vocabulary ID. |
|
|
| Language hints. |
|
|
| Pass a JSON object as a string. Its fields are merged into the protocol |