Skip to content

Commit

Permalink
update docs upon feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
sachaarbonel committed Mar 13, 2024
1 parent 6b4ec4b commit 8c4f9f1
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Calls can be recorded for later use. Calls recording can be started/stopped via API calls or configured to start automatically when the first user joins the call.
Call recording is done by Stream server-side and later stored on AWS S3. You can also configure your Stream application to have files stored on your own S3 bucket (in that case, storage costs will not apply).
Call recording is done by Stream server-side and later stored on AWS S3. There is no charge for storage of recordings. You can also configure your Stream application to have files stored on your own S3 bucket.

By default, calls will be recorded as mp4 video files. You can configure recording to only capture the audio.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ title: Transcribing calls
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Transcribing calls allows for the conversion of spoken words into written text. Transcription can be started/stopped via API calls or configured to start automatically when the first user joins the call. Call transcription is done by the Stream server-side and later stored on AWS S3. You can also configure your Stream application to have files stored on your own S3 bucket (in that case, storage costs will not apply).
Transcribing calls allows for the conversion of spoken words into written text. Transcription can be started/stopped via API calls or configured to start automatically when the first user joins the call. Call transcription is done by the Stream server-side and later stored on AWS S3. There is no charge for storage of transcriptions. You can also configure your Stream application to have files stored on your own S3 bucket.

By default, transcriptions will be provided in a jsonl file.

Note: Transcriptions will capture all speakers in a single file.
> **Note:** Transcriptions will capture all speakers in a single file.
> **Note:** It's important to note that transcriptions should not be used as a replacement for closed captioning (CC). We have it planned on our [roadmap](https://github.com/GetStream/protocol/discussions/127) to support CC in the future.
## Start and stop call transcription

Expand All @@ -31,10 +33,10 @@ call.stopTranscription();
<TabItem value="py" label="Python">

```py
// starts transcribing
# starts transcribing
call.start_transcription()

// stops the transcription for the call
# stops the transcription for the call
call.stop_transcription()
```

Expand Down Expand Up @@ -82,10 +84,23 @@ curl -X GET "https://video.stream-io-api.com/video/call/default/${CALL_ID}/trans

These events are sent to users connected to the call and your webhook/SQS:

- `call.transcription_started` when the call transcription has started
- `call.transcription_stopped` when the call transcription has stopped
- `call.transcription_ready` when the transcription is available for download
- `call.transcription_failed` when transcribing fails for any reason
- `call.transcription_started` sent when the transcription of the call has started
- `call.transcription_stopped` this event is sent only when the transcription is explicitly stopped through an API call, not in cases where the transcription process encounters an error.
- `call.transcription_ready` dispatched when the transcription is completed and available for download. An example payload of this event is detailed below.
- `call.transcription_failed` sent if the transcription process encounters any issues.


## Transcription JSONL file format

```jsonl
{"type":"speech", "start_time": "2024-02-28T08:18:18.061031795Z", "stop_time":"2024-02-28T08:18:22.401031795Z", "speaker_id": "Sacha_Arbonel", "text": "hello"}
{"type":"speech", "start_time": "2024-02-28T08:18:22.401031795Z", "stop_time":"2024-02-28T08:18:26.741031795Z", "speaker_id": "Sacha_Arbonel", "text": "how are you"}
{"type":"speech", "start_time": "2024-02-28T08:18:26.741031795Z", "stop_time":"2024-02-28T08:18:31.081031795Z", "speaker_id": "Tommaso_Barbugli", "text": "I'm good"}
{"type":"speech", "start_time": "2024-02-28T08:18:31.081031795Z", "stop_time":"2024-02-28T08:18:35.421031795Z", "speaker_id": "Tommaso_Barbugli", "text": "how about you"}
{"type":"speech", "start_time": "2024-02-28T08:18:35.421031795Z", "stop_time":"2024-02-28T08:18:39.761031795Z", "speaker_id": "Sacha_Arbonel", "text": "I'm good too"}
{"type":"speech", "start_time": "2024-02-28T08:18:39.761031795Z", "stop_time":"2024-02-28T08:18:44.101031795Z", "speaker_id": "Tommaso_Barbugli", "text": "that's great"}
{"type":"speech", "start_time": "2024-02-28T08:18:44.101031795Z", "stop_time":"2024-02-28T08:18:48.441031795Z", "speaker_id": "Tommaso_Barbugli", "text": "I'm glad to hear that"}
```

## User Permissions

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/video/docusaurus/docs/api/webhooks/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Here you can find the list of events are sent to Webhook and SQS.
| call.recording_stopped | Sent when call recording has stopped |
| call.recording_ready | Sent when the recording is available for download |
| call.recording_failed | Sent when recording fails for any reason |
| call.transcription_started | Sent when the transcription has started |
| call.transcription_stopped | Sent when the transcription is stopped |
| call.transcription_ready | Sent when the transcription is ready |
| call.transcription_failed | Sent when the transcription fails |


You can find the definition of each events in the OpenAPI spec available [here](https://github.com/GetStream/protocol/blob/main/openapi/video-openapi.yaml)

0 comments on commit 8c4f9f1

Please sign in to comment.