Extensions

Setup

1. Please make sure your SAMMI is updated to the latest version. OBS 29 or higher recommended.
2. Install the extension. You can follow the Extension Install Guide.
3. Add the --use-fake-ui-for-media-stream flag to your OBS executable (if Bridge is running as a dock in OBS):
   1. Navigate to where your OBS shortcut or obs64.exe is located. This could be on your desktop, taskbar, or in the Start menu. Alternatively, find the obs64.exe file in your Program Files folder.
   2. If you’re using the obs64.exe, right-click on it and choose Create shortcut..
   3. Modify Properties: Right-click on the new shortcut and choose Properties.
   4. Add Flag: In the Target field, you’ll see the path to obs64.exe. Add a space at the end of this line and then add --use-fake-ui-for-media-stream. The Target field should look something like this: "C:\Program Files\obs-studio\bin\64bit\obs64.exe" --use-fake-ui-for-media-stream`
   5. Click OK or Apply to save these changes.
   6. Now, whenever you launch OBS from this shortcut, it will run with this particular flag, which is required for this extension.

      

      
4. Navigate to the premade deck and open the Settings button to set up the extension:
   • General Settings
     • Default Engine - Default engine to use in all your queries
     • Silence Length - If Auto Stop is enabled, the transcription will automatically stop after X seconds of silence
     • Silence Threshold - Define what level of noise is considered ‘silence’, adjust for noisier settings
     • Log Usage - Track your usage with Get and Reset Usage commands. Accuracy is not guaranteed, setting up billing alerts is STRONGLY ADVISED for all used services to avoid unexpected charges.
5. Check your recording device is correctly set (only available if Bridge is running inside OBS dock)
   • Navigate to Bridge - STT by K tab and optionally choose a different recording device
6. Continue setting up your desired engine inside Settings button. See more information for each engine and its settings below.

Available Engines

Google Cloud

Free 60 minutes/month. You can monitor usage at Google Cloud - Billing - Overview.
Strongly Advised: Configure notifications at Google Cloud - Billing - Budgets & alerts.

Settings (accessed via Settings button):

• Google Cloud API Key - Your Google Cloud API Key with Text to Speech API enabled
• Language - Transcription language
• Profanity Filter - Attempts to filter out profanities, replaces all but the initial character in each filtered word with **
• Enable Punctuation - Adds punctuation to results (only in select languages)
• Enable Emoji - Converts spoken emojis to Unicode symbols in the text

How to create Google Cloud account and an API key:

1. Log in or sign up at Google Cloud
2. Watch the video below.
   • At 0:50 enable Cloud Speech-to-Text API instead and at 1:35 restrict the API key to Cloud Speech-to-Text API instead.
   • Ignore everything else after 1:50 and simply copy paste the API key into the ‘Google Cloud API key’ box in the Google Cloud settings command.
3. Don’t forget to set up a payment method under Billing.

OpenAI

No free tier. You can monitor usage at OpenAI Dashboard
Strongly Advised: Set usage limits

Settings: (accessed via Settings button):

• OpenAI API Key - Find yours at OpenAI platform
• Language - Transcription language

How to create an OpenAI account and an API key:

1. Log in or sign up at OpenAI Dashboard
2. Watch the video below:
3. Don’t forget to set up a payment method under Billing - Payment methods.

Microsoft Azure

Free 5 hours/month. You can monitor usage at Azure Portal
Strongly Advised: Setup a budget at Cost Management and Budgets

Settings: (accessed via Settings button):

• Azure API Key - Azure API key for the Resource that’s configured for SpeechServices in your Azure Portal
• Azure region - Azure region for the Resource that’s configured for SpeechServices
• Language - Transcription language
• Profanity Filter - Specify how to handle profanity in transcriptions: - masked - replaces profanity with asterisks - removed - removes all profanity from the result. - raw - includes profanity in the result.

How to create an Azure account and an API key:\

1. Log in or sign up at Azure Portal
2. Setup your billing account at Cost Management + Billing
3. Watch the video below:

   Note: When creating the new resource as shown in the video, create or use an existing Resource Group, and select region closest to your location.

Transcribing

To record and transcribe speech using your microphone, use the STT by K Transcribe command. You can start, stop, or cancel the recording as needed. The transcription will be saved in the variable name you specify in the Start action.

Time limits:

• Google Cloud: Up to 1 minute per transcription
• OpenAI: Up to 2 minutes per transcription
• Azure: Up to 1 minute per transcription

Getting and Resetting Usage

You can use STT by K usage command to get the current usage or reset usage for all the engines. Useful to do at the end of the billing month.