Skip to content

Commit

Permalink
Revert "DC-321 (#395)"
Browse files Browse the repository at this point in the history
This reverts commit ca217bc.
  • Loading branch information
avoliva committed Mar 3, 2022
1 parent b06089a commit fd9d064
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/streamingapi/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Symbl's Streaming API is based on the WebSocket protocol and can be used for rea
Currently, Streaming API is supported in English only. However, the support for Spanish is available as a part of Symbl Labs.
:::

:::note Opus codec
Streaming API supports Opus with 48000 Hz sample rate.
:::

## Request Parameters

#### Endpoint
Expand Down Expand Up @@ -77,17 +81,17 @@ Field | Required | Supported value | Default Value | Description

Field | Required | Supported value | Default Value | Description
---------- | ------- | ------- | ------- | -------
```encoding``` | false | `LINEAR16`, `FLAC`, `MULAW`, `Opus` | `LINEAR16` | Audio Encoding in which the audio will be sent over the WebSocket.
```sampleRateHertz ``` | false | | `16000` | The rate of the incoming audio stream. The following are supported with the sample rates: <br/> encoding `LINEAR16` for sample rates `8000` to `48000`, <br/> encoding `FLAC` for sample rates `16000 ` and above, <br/> encoding `MULAW` for sample rates `8000`, <br/> encoding `Opus` for sample rates `16000` to `48000`.
```encoding``` | false | LINEAR16, FLAC, MULAW | LINEAR16 | Audio Encoding in which the audio will be sent over the WebSocket.
```sampleRateHertz ``` | false | | 16000 | The rate of the incoming audio stream.


##### Code Example

```js
{
"speechRecognition": {
"encoding": "LINEAR16",
"sampleRateHertz": 16000 // Make sure the correct sample rate is provided for best results
"sampleRateHertz": 44100 // Make sure the correct sample rate is provided for best results
}
}
```
Expand Down

0 comments on commit fd9d064

Please sign in to comment.