LogoLogo
WherebyStatusCommunity
  • 📹Whereby 101
    • Create Your Video Experience
      • Get started in 3 steps
      • Embedding Whereby in a web app
        • Using Whereby's Web Component & Pre-built UI
          • Script Tags
          • With Low Code
            • Embedding in Squarespace or Wordpress
            • No code video conferencing in Bubble
        • Using Whereby's Browser SDK with React Hooks for a fully custom UI
      • Embedding Whereby in a mobile app
        • Embedding Whereby in iOS
          • Using Whereby's Native iOS SDK
        • Embedding Whereby in Android
          • Using Whereby's Native SDK
        • Using Flutter
        • Using React Native
      • Github SDK Examples
      • Meeting scheduling with Cronofy
    • Generating Room URLs
      • Name prefixes
      • Using “Create a room”
      • Using Postman
    • Customize Your Video Experience
      • During room creation
      • Using Attributes/URL Params
      • Global preferences
      • Branding elements
      • Dial-In
      • File sharing
      • Breakout Groups with Embedded
      • Waiting Rooms
    • User roles & Meeting Permissions
    • FAQ
      • Accessibility
      • Whereby Words
      • Firewall & Security
      • HIPAA compliant setup
      • Allowed Domains & Localhost
      • Whereby Embedded Feature Comparison
  • 🔍Meeting Content & Quality
    • Recording
      • Cloud Recording
      • Local Recording
    • Transcribing
      • Session Transcription
      • Recording Transcription
    • Live Captions
    • Session summaries
    • Live streaming RTMP
    • Quality Insights
      • Real-time troubleshooting
      • Using the Insights dashboard
      • Improving call quality
      • Tracking room events with Webhooks
  • 🤷End User
    • End User Support Guides
      • Supported Browsers & Devices
      • Screen Sharing Setup & Usage
      • Using Breakout Groups
      • Troubleshooting & Basics
  • 🚚Developer Guides
    • Quickly deploy Whereby to your domain
    • Tracking Customer Usage
    • Migrating from Twilio
      • Twilio JS SDK Quick Migration
      • Twilio JS SDK Direct Migration
  • 🖥️Reference
    • REST API Reference
      • /meetings
      • /insights
      • /recordings
      • /transcriptions
      • /summaries
      • /rooms
    • Web Component Reference
    • React Hooks Reference
      • Quick Start
        • Getting started with the Browser SDK
      • Guides & Tutorials
        • Migrate from version 2.x to 3
        • Grid logic
        • Custom Video Tiles with React
        • Usage with Next.js
        • How to customize the toolbar
      • API Reference
        • WherebyProvider
        • VideoView
        • VideoGrid
        • useLocalMedia
        • useRoomConnection
      • Types
    • React Native Reference
      • Quick Start
      • WherebyEmbed
    • Webhooks Reference
Powered by GitBook
On this page
  • Manual Transcriptions
  • Programmatic Recording Transcriptions
  • Supported Languages
  • Known limitations

Was this helpful?

Edit on GitHub
  1. Meeting Content & Quality
  2. Transcribing

Recording Transcription

Recording Transcription allows you to get a transcript of any session recording stored in Whereby-provided storage

Last updated 10 months ago

Was this helpful?

Recording Transcription is a supplementary feature of our paid Whereby Embedded plans. You can review the pricing and options .

Recording Transcription is available by default for all session recordings stored in Whereby-provided storage and there is no need to enable or configure this feature. Recording transcripts are derived from recordings and saved as text files accessible through the customer portal or via the API. They can be used as a standalone resource (eg. for compliance purposes) or sent to an external service for post processing (eg. to derive key topics or create a session summary).

In order to produce a transcript from a recording of Whereby session you need to follow these steps:

  1. Create a Whereby room with cloud recording enabled and configured to use Whereby-provided storage.

  2. Record the session.

  3. Trigger the transcription for the recording.

You can use Recording Transcription manually through the customer portal, or programatically with the combination of API requests and webhook events.

Manual Transcriptions

In order to use Recording Transcription you need to first configure meeting recordings to use cloud recording with Whereby-provided storage. Go to “Configure” → “Recording” section of your customer portal and choose "Whereby-hosted cloud recording" option with the trigger and recording format of your choice. .

When configuring cloud recording options via the customer portal, they will be applied as default settings for all rooms and meetings. However, you can override the defaults by specifying different preferences in the POST requests used to create meetings.

When the sessions get recorded, you can access all recordings saved in the Whereby-provided storage from the “Recordings” page of your customer portal. Find the session that you want to transcribe and choose the "Start transcription" option from the Actions column.

The transcription process may take some time, especially for recordings longer than 30 minutes. Once the transcript is ready, you can download it. The transcript is downloaded as an .md file.

You can also download or delete transcriptions that have been already created from the “Recordings” page of your customer portal.

Programmatic Recording Transcriptions

If you want to automate the process of transcribing recorded Whereby sessions, you can do so with a combination of API requests and webhook events.

Configure session recoding

First make sure that meetings are configured to use cloud recording with Whereby-provided storage:

  • If you want to use cloud recording with Whereby-provided storage globally for all rooms, go to “Configure” → “Recording” section of your customer portal and choose "Whereby-hosted cloud recording" option with the trigger and recording format of your choice.

"recording": {
    "type": "cloud",
    "destination": {
      "provider": "whereby",
      "fileFormat": "mp4"
    },
    "startTrigger": "none"
   },       

Record and transcribe the session

Depending on the type of recording trigger specified for the meeting, it will be recorded automatically or the host will need to start the recording manually.

Delete the recording and transcription files

Both the recording and the transcript of the session will be stored in the Whereby-provided storage until you delete them. If you want to optimise the cost or minimise the time when your sessions' content is stored in the Whereby-provided storage you can delete the assets with 2 API requests:

Supported Languages

Recording Transcriptions feature automatically identifies the dominant language spoken in the session and creates a transcript in this language. The following languages are supported: Chinese, Dutch, English, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish, Turkish, Ukrainian.

Known limitations

Recording Transcriptions are only available for session recordings stored in Whereby-provided storage. If you store session recordings in your own Amazon S3 bucket, it will be not possible to trigger transcriptions for these recordings.

Recording Transcriptions sometimes fail for recordings of sessions longer than 45 minutes, so it is recommended to use this feature for shorter sessions. We will not charge you for failed transcriptions.

If you prefer to set the recording type for each room or meeting individually, create the meeting with request using the following parameters for recording (with the "startTrigger" and "fileFormat" of your choice):

When the recording is completed, Whereby sends a recording.finished event. Hook onto that event to fetch the recordingId of the session that you want to transcribe.

Then send a request with the recordingId to start the transcription job.

The transcription process may take some time, especially for recordings longer than 30 minutes. Once the transcript is ready, Whereby sends a transcription.finished event. Hook onto that event to fetch the transcriptionId of the session that you want to transcribe.

Send a request to get the download link of the transcription file. Transcripts are downloaded as .md files.

Since recording transcripts are derived from recordings saved in Whereby-provided storage, this feature is not considered to be HIPAA compliant. Avoid using recording transcription in order to maintain HIPAA compliance of your Whereby sessions. .

🔍
Learn more about Whereby HIPAA compliant setup
on our site
Learn more about recording options
POST /meetings
POST /transcriptions
GET /transcriptions/{transcriptionId}/access-link
DELETE /recordings/{recordingId}
DELETE /transcriptions/{transcriptionId}
Set "Whereby-hosted cloud recording" as Recording option
Start the transcription for selected recording of a Whereby session
Download the transcript from the session recording
webhook
webhook