# Zip Captions Help Site

Welcome to the Zip Captions help site. Use the menu to see all the pages, or choose a section below to get started. 

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started with Zip Captions</strong></td><td>Discover how to get started with Zip Captions. This is a great place to start if you're new here!</td><td><a href="/pages/ZbWnLMt21FGEHH9VCyLE">/pages/ZbWnLMt21FGEHH9VCyLE</a></td></tr><tr><td><strong>Understanding the Settings</strong></td><td>Dive into customising Zip Captions and discover how you can make it your own.</td><td><a href="/pages/M1gkG8Fqug3AFT1XZ83A">/pages/M1gkG8Fqug3AFT1XZ83A</a></td></tr><tr><td><strong>Sharing Captions With Others</strong></td><td>Zip Captions allows you to share your captions with others, and to follow others captions live. Discover how to set up and join a broadcast stream of captions. Discover how to add captions to your Live Streaming with OBS.</td><td><a href="/pages/h7NF0hLZP4gf8LnosPlE">/pages/h7NF0hLZP4gf8LnosPlE</a></td></tr><tr><td><strong>Known Issues</strong></td><td>Discover how to overcome some known issues, and things that are outside of our control.</td><td><a href="/pages/7qA0fXh8cKlCdsSYtUEo">/pages/7qA0fXh8cKlCdsSYtUEo</a></td></tr><tr><td><strong>Example Use Cases</strong></td><td>Looking for some more advanced use cases for Zip Captions? This is the spot.</td><td><a href="/pages/MILozXn4AKpanBjk6QSI">/pages/MILozXn4AKpanBjk6QSI</a></td></tr><tr><td><strong>Change Log</strong></td><td>Check out our latest releases and what has changed.</td><td><a href="/pages/WYYY2OwRTp8rt7LE9OOT">/pages/WYYY2OwRTp8rt7LE9OOT</a></td></tr></tbody></table>


# Starting Captioning with Zip Captions

Zip Captions works on any device which runs Google Chrome or Safari.&#x20;

1. Open Zip Captions
2. Click on the Microphone in the top right corner

<figure><img src="/files/CPNrTP2ocbu4s05v09gt" alt=""><figcaption></figcaption></figure>

3. Accept the permissions

<figure><img src="/files/QQufMUCP2e0DDXXzZ0ct" alt=""><figcaption></figcaption></figure>

3. Start speaking and the captions will appear

<figure><img src="/files/pHkIEJrD9ovDjb1HtZA5" alt=""><figcaption></figcaption></figure>


# Cookies

We use cookies to save your settings, that’s all that we do with them. If you change your mind about cookies, you click on the image of the cookie at the bottom of the screen at any time. If you would like to decline, click the “Reject” button and we won’t ask again for 180 days.

<figure><img src="/files/f8zqQ1WoXKMtjVxcgrVE" alt=""><figcaption></figcaption></figure>


# Installing the Zip Captions App

Zip Captions can be installed on your device as a Progressive Web App. Depending on your browser and your device, you will need to follow some different steps.&#x20;

{% tabs %}
{% tab title="Desktop (Chrome)" %}
**Using Google Chrome**

1. Go to <https://zipcaptions.app>
2. Click on the Install prompt which appears in the Omnibox

<figure><img src="/files/5mi0gH2LIsIgfMXt9u5u" alt=""><figcaption></figcaption></figure>

3. Confirm that you want to install Zip Captions

<figure><img src="/files/4atjWyK3QnEaNmvMCVXQ" alt=""><figcaption></figcaption></figure>

4. You can also install the Progressive Web App from the Menu
   {% endtab %}

{% tab title="Desktop (Safari)" %}
Safari does not support PWA installation on MacOS. If you need to run Zip Captions as a standalone app, please use Chrome.
{% endtab %}

{% tab title="Android" %}
{% hint style="info" %}
Both of the methods below, install the same app. Installing from the Google Play Store may be easier for some users, however, if you encounter issues with speech recognition, then you should install the PWA version using Google Chrome.&#x20;
{% endhint %}

**From the Google Play Store:**

Visit: <https://play.google.com/store/apps/details?id=app.zipcaptions.twa>

Click on Install&#x20;

If you encounter any issues with the app, try the PWA option below.

***

**As a Progressive Web App (PWA):**

Before you being, please ensure that you have the [Google Chrom](https://play.google.com/store/apps/details?id=com.android.chrome\&hl=en_CA)e browser installed on your device.&#x20;

1. Visit [https://zipcaptions.app ](https://zipcaptions.app)in Chrome
2. Tap on the three dots\
   ![](/files/dFPveKY7obDz4sHcOABv)
3. Choose **Add to Home Screen** from the menu\
   ![](/files/Rm2u3SBT9lbHnyZnN1Bw)
4. Choose **Install** from the prompt that appears\
   ![](/files/ZejL0zqASDDHTtFsDKZi)
5. Zip Captions will now appear in your list of apps, and you can launch it from your app launcher on your Android device.&#x20;
   {% endtab %}

{% tab title="iOS / iPad OS" %}
Coming Soon
{% endtab %}

{% tab title="Microsoft Store" %}
You can install Zip Captions from the Microsoft Store on a computer running Windows 10 or 11.&#x20;

[Install Now](https://apps.microsoft.com/detail/9pjn1f4bf2mh?hl=en-US\&gl=US)
{% endtab %}
{% endtabs %}


# Supported Browsers

We currently support the following browsers:

| Browser  | Works in Browser | Works as PWA |
| -------- | :--------------: | :----------: |
| Brave    |       ❌[^1]      |     ❌[^1]    |
| Chrome   |       ✅[^2]      |     ✅[^3]    |
| Chromium |       ❌[^1]      |     ❌[^1]    |
| Edge     |      🚧[^4]      |    ✅[^5]\*   |
| Firefox  |       ❌[^6]      |     ❌[^6]    |
| Opera    |       ❌[^7]      |     ❌[^7]    |
| Safari   |       ✅[^8]      |    🚧[^9]    |

{% hint style="warning" %}
This list is subject to change.
{% endhint %}

[^1]: Chromium based browsers other than Chrome do not support WebSpeech due to Google not providing access to their Voice to Text API

[^2]: Chrome fully supports captioning in thee browser.&#x20;

[^3]: Chrome fully supports installations of PWA's on all systems that it runs on.

[^4]: Microsoft's implementation of the WebSpeech API is not standard. We are working on support in Edge.

[^5]: Edge is supported as long as Zip Captions is installed via the [Microsoft Store](https://apps.microsoft.com/detail/9pjn1f4bf2mh?hl=en-US\&gl=US)

[^6]: Firefox does not support the WebSpeech API

[^7]: Opera should support the WebSpeech API however, no results are returned in Opera

[^8]: Safari fully supports Zip Captions in the browser

[^9]: Apple only support the installation of PWA's as shortcuts on iOS and iPadOS. PWA's are not supported on MacOS.


# Improving Captioning Accuracy

There are a number of ways that you can improve the accuracy of captioning.&#x20;

* Sign up for our [Advanced AI Captioning](/settings/ai-captions).&#x20;
* Using Wireless Microphones ([Amazon](https://amzn.to/49wyQaK) affiliate link)
* Integrating with existing systems ([Phoank](/example-use-cases/in-the-classroom))
* Connecting a professional mixer with an USB interface

Connecting the external microphone to your computer allows better captioning quality.&#x20;

You way also require:

* TRS to TRRS Splitter ([Amazon](https://amzn.to/43OA3sM) affiliate link)

  *This allows you to split the headphone jack on your laptop into separate Microphone and headphone/line jacks.*
* External Sound Card (Amazon affiliate links - [TRRS](https://amzn.to/3POel2n) | [Mic & Headphone](https://amzn.to/3VViqFA) | [Cheap](https://amzn.to/3vL7Vdt))

  *This will allow you better control especially when working with a TRS to TRRS splitter.*&#x20;


# Changing Settings

You can easily change the settings for Zip Captions using our settings menu

**There are two ways to access the settings in Zip Captions:**

* [Via the Settings Menu](#when-you-are-on-the-homepage-you-can)
* [Via the Quick Settings](#when-you-are-in-the-captioning-screen-you-can-access-the-quick-settings)

***

### Via the Settings Menu

1. Click on the hamburger menu ☰
2. Choose “Settings” from the list
3. Choose "**Look & Feel**"

<figure><img src="/files/kJf7L1o8DNwQEBEHmTgq" alt=""><figcaption></figcaption></figure>

Here you can change the:

* **Theme** - change the colour settings
* **Language** - choose from one of our supported languages
* **Font**
* **Screenwake Setting** - stop your screen from going to sleep
* **On Screen Results** - the number of lines of captions shown
* **Text Size**
* **Line Spacing**

Once you are finished click on “Save and Close” at the bottom of the screen.

{% hint style="info" %}
In order to sync your settings, ensure that you are logged into your account, and follow [these instructions](/settings/sync-your-settings).
{% endhint %}

***

### Via the Quick Access Settings

The quick access settings can be accessed from the captioning screen.

{% hint style="danger" %}
Currently the quick settings do not sync with the settings sync and they must be set each time that you use Zip Captions.&#x20;
{% endhint %}

1. Click on the arrow on the right hand side of the screen

<figure><img src="/files/bRP0cQuPOGsEzNO7N38c" alt="" width="563"><figcaption></figcaption></figure>

2. The mini settings menu will appear

<figure><img src="/files/00rER4ET4AybGWr4Jzxn" alt="" width="563"><figcaption></figcaption></figure>

Here you can change the:

* **Text Size** - the size of the text
* **Line Spacing** - the amount of space between each line
* **On Screen Results** - the number of lines of captions shown
* **Text Flow** - move the text to the top or bottom of the page
* **Go Full Screen** - remove the header and footer


# Transcripts

Zip Captions can save your broadcast session as a transcript.&#x20;

Transcripts must be enabled by the user, on each device that they wish to use them on before they are available to use.&#x20;

To do this:

1. Go to Settings
2. Click on the transcripts tab (or the icon on mobile)\
   ![](/files/Il1UyzB0wsIWHzhJtbiq)
3. Turn on Transcripts by checking the box\
   ![](/files/ADcrVSK5EMOgQ86eOIaV)
4. Click on Save

Transcripts are now available on the captioning screen.&#x20;

Read more about Transcripts and how to use them [here](/transcriptions/introducing-transcripts).

{% hint style="danger" %}
Transcriptions are stored on each device locally.&#x20;
{% endhint %}


# Sync Your Settings

Zip Captions can sync your settings against your stored settings on our cloud server. This allows you to store your preferred settings across multiple devices, or to restore your settings after a temporary change.

To get started:

1. Click on Login on the homepage.&#x20;

   <figure><img src="/files/bEsZgElAdYI9MJ6HrYYw" alt=""><figcaption></figcaption></figure>
2. Choose the account that you want to login with from the menu&#x20;

   <figure><img src="/files/lzdBkszd271NLw3pU5a4" alt=""><figcaption></figcaption></figure>
3. You will now be redirected to your My Account page.

   <figure><img src="/files/UCN9qKc4aFYL977Na8ht" alt="" width="386"><figcaption></figcaption></figure>
4. Click on the three lines in the right corner, and choose **Settings**. Now choose **Sync**. Your first step is to save your current settings to the server. To do this, click on the ‘**Save Current**’ button.

   <figure><img src="/files/dyn9SYTCBtWZs1imVrdH" alt=""><figcaption></figcaption></figure>
5. You can now choose to apply these settings everywhere you log in if you wish by checking the box **"Use these settings everywhere I log in"**.

   <figure><img src="/files/MZHQrxzooJs5fuSNjeCu" alt=""><figcaption></figcaption></figure>
6. Once you make a change to your settings which differ to the ones that are saved on the server, you will see this tile in the sync tab. Here you can choose to toggle between the local settings, and server settings. Choosing to **save current** will overwrite your saved server settings with your current local ones, or choosing to **Apply Saved** will overwrite your local settings with the cloud based ones. Switching the **Local** or **Server** toggle will allow you to see the differences between your current and saved settings.

   <figure><img src="/files/7jrkbckQizDWy2sKOlrd" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/MKWGCtlnNC1PezBCBSHB" alt=""><figcaption></figcaption></figure>

1. Click on the ‘Save Current’ button, this will save your current settings&#x20;

   <figure><img src="/files/n780M1MHEtYfZ2tBIz49" alt=""><figcaption></figcaption></figure>
2. Any changes to your settings will now give you this tile, where you can choose to toggle between the local settings, and server settings. Choosing to save current will overwrite your saved settings with your current local ones, or choosing to Apply Saved will overwrite your local settings with the cloud based ones.&#x20;

   <figure><img src="/files/sxdGfQ0TTOL0RZAQpxH9" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
Any settings which you change in the quick access settings will not currently be synced
{% endhint %}


# Logging In

Logging into Zip Captions can be achieved by using a Google or Microsoft account.

To get started:

1. Click on Login on the homepage.&#x20;

   <figure><img src="/files/bEsZgElAdYI9MJ6HrYYw" alt=""><figcaption></figcaption></figure>
2. Choose the account that you want to login with from the menu&#x20;

   <figure><img src="/files/lzdBkszd271NLw3pU5a4" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Google" %}

1. Login to your Google Account&#x20;

   <figure><img src="/files/0iAqzuYIYDKvzNm2SqC5" alt=""><figcaption></figcaption></figure>
2. You will be redirected to your My Account page. &#x20;

   <figure><img src="/files/UCN9qKc4aFYL977Na8ht" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If you support or follow us on Patreon, your patreon account will be linked to your Zip Captions profile.&#x20;
{% endhint %}

{% hint style="warning" %}
Your Patreon account must be registered with the same email address as you are logging into Zip Captions with. If you are using a different account, your Patreon information will not be shown in your account
{% endhint %}
{% endtab %}

{% tab title="Microsoft" %}

1. Login to your Microsoft Account&#x20;

<figure><img src="/files/4lLLGsbtj2u3Ho2HjiPU" alt=""><figcaption></figcaption></figure>

2. You will be redirected to your My Account page&#x20;

<figure><img src="/files/UCN9qKc4aFYL977Na8ht" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If you support or follow us on Patreon, your patreon account will be linked to your Zip Captions profile.&#x20;
{% endhint %}

{% hint style="warning" %}
Your Patreon account must be registered with the same email address as you are logging into Zip Captions with. If you are using a different account, your Patreon information will not be shown in your account
{% endhint %}
{% endtab %}
{% endtabs %}


# Languages

{% hint style="info" %}
The captioning language matches the language of the browser interface.
{% endhint %}

We currently support the following languages:

* English
* French
* Spanish
* German
* Italian
* Ukrainian
* Portuguese
* Indonesian
* Polish

To set a language manually, you can do so by accessing the [Settings page](/settings/changing-settings).

If you would like to see additional languages added you can [create community translations via GitHub](https://github.com/jptrsn/zip-captions?tab=readme-ov-file#languages)


# AI Captions

Zip Captions supports AI Cloud based captions which are more accurate than our regular captioning offering. We are currently using the Azure AI Speech to Text Service from Microsoft.

{% hint style="danger" %}
AI Captions are only available for paying subscribers on Patreon.&#x20;

Join Zip Captions on Patreon [here](https://patreon.com/zipcaptions).&#x20;

View the pricing structure for AI Captions [here](https://zipsolutions.org/pricing.html).&#x20;
{% endhint %}

To get started with AI Captions you must first enable them in the settings.&#x20;

1. Click on the **three lines**&#x20;
2. Click on **Settings**
3. Click on the **Engine** option
4. Click on the drop down menu\ <img src="/files/XIbv3NLX4X3GpXxOF1Pf" alt="" data-size="original">
5. Choose **Azure Cognitive Services** from the drop down list\
   ![](/files/aviaupyrq5InBT8fhi1u)
6. You will see your current balance shown under the description, this is shown in hours and minutes. This is updated live as you use your tokens assigned.
7. You can improve the accuracy of your captioning by choosing a dialect for the chosen language.  *(Language dialects are shown based on the language chosen for your interface and captioning language from the* [***Look & Feel***](https://zipcaptions.app/settings?tabIndex=0) *menu)*
8. Click **Save** to enable your captioning engine. The Save button will now be greyed out. \
   ![](/files/YhqvGPVE3Lcoxja8XyUu)
9. &#x20;You will now see the Microphone button has been converted to the AI Microphone<br>

   <figure><img src="/files/K0rEUiYMKjHDDakAHLUw" alt=""><figcaption><p>The microphone button shows the AI stars when the AI engine is enabled</p></figcaption></figure>
10. To switch back to the regular captioning engine, simply choose the **Browser** option from the drop down list and click on **Save**.


# My Account

Your account page shows everything that we know about you, this includes:

* Your email address
* The providers that you have used to login with
* Your Patreon Tier status
* The ability to delete your account


# Deleting your Account

It is possible to delete your account if you wish to do so.&#x20;

Go to > **menu ≡** > **My Account** > **Delete Account**

<div align="left"><figure><img src="/files/UCN9qKc4aFYL977Na8ht" alt="Menu screenshot showing the Delete my account button" width="386"><figcaption><p>Delete my Account</p></figcaption></figure></div>


# Broadcasting Your Captions to Others

{% hint style="info" %}
This page discusses streaming captions to others, if you want to access a stream, follow the instructions on [**this page**.](/streaming-captions/connecting-to-broadcast-captions)
{% endhint %}

Zip Captions allows you to share your captions with users on other devices. This is very useful in a number of situations, these can include:

* In a classroom, to send captions to students devices instead of displaying them on a central screen
* At a conference, where captions could be too small to read, broadcasting allows captions to be seen on participants screens
* In a setting where there is no screen available

In addition to allowing better access to captions, broadcasting allows more accurate captioning, by allowing users to access captions which were processed on a device near the speaker. External microphones which connect via Bluetooth or other wireless technologies can also enhance the accuracy.&#x20;

{% hint style="info" %}
We offer two types of broadcasts:

[**Anonymous Broadcast**](#anonymous-broadcasting) - this produces a random session each time that you want to share your captions with others. You will need to share the session information each time.&#x20;

[**Static Broadcast**](#static-broadcasting) - this gives you a personal session which remains the same every time you visit Zip Captions. This means that you can print out session information and it will remain the same for your users each time they use your stream

You are able to choose which type of broadcast you use each time you visit Zip Captions and start broadcasting.
{% endhint %}

### Anonymous Broadcasting

1. Click on the broadcast button at the top of the screen (this looks like an antenna with circles coming from it)

<figure><img src="/files/bEsZgElAdYI9MJ6HrYYw" alt=""><figcaption></figcaption></figure>

2. Agree to the privacy warning to confirm that you understand that you are going to share your data with others when you start broadcasting. Click on the **Share** tab.

   <figure><img src="/files/qSnCuceawGp5wHWs2Roc" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
You can choose to use a **Join Code** for your session to ensure that only those that you invite are able to join the stream.&#x20;

**Please note that Join Codes are not static, and will be randomly generated each time you create a session.**
{% endhint %}

2. As you are wanting to start an **Anonymous Broadcast**, make sure that this is chosen in the list.  Decide if you wish to use a **Join Code** (see the box above) and then click on **Start Broadcast**.

   <figure><img src="/files/C5JuiQKJgf2sCj8W7mWd" alt=""><figcaption></figcaption></figure>
3. The broadcast will now be started, you should share the Session ID and the Join code with the people who want to follow along as shown at the top of the screen.&#x20;

<figure><img src="/files/yDcCKkU6XwLpBY79Dy9a" alt=""><figcaption></figcaption></figure>

5. To end your broadcast, click on the disconnect button in the top right hand corner of the screen, then confirm that you are ending your broadcast, this will disconnect all connected users.

<figure><img src="/files/1QIvhWByhsh0BOLwJ68w" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
It's possible to share your information with others via a URL. You can find instructions on how to do that [here](/streaming-captions/connecting-via-a-url#sharing-a-stream-via-a-url).&#x20;
{% endhint %}

### Static Broadcasting

Static broadcasts need to be configured before you begin. To get started go to the **settings** page, and click on the **Sharing** tab.

1. Click on the **Create a Session** button

   <figure><img src="/files/pM5iYZuIndJjWD6boZ2p" alt=""><figcaption></figcaption></figure>
2. You can now choose a **Broadcast ID** from the drop down list. This will be the Session ID that remains static and you can give to users each time. You can also choose here to Require a Join Code, or to make your session available to anonymous users. *Please note that the Join Codes are not static, and will change each time you start a broadcast with your session ID.*

   <figure><img src="/files/fHAtkFmNUVEiXQDcBwLS" alt=""><figcaption></figcaption></figure>
3. Click on **Save and Close.** If you chose to use a Join code a locked padlock will appear, no join code, the padlock will appear unlocked. *The* [*link to your static session*](#user-content-fn-1)[^1] *is shown in the settings tile.*&#x20;

   <figure><img src="/files/8sial77UyX8WjmxzqCHe" alt=""><figcaption></figcaption></figure>
4. Once you're ready to start, click on **Start Broadcast**
5. Next time you want to start a **Static Broadcast**, you can go to the sharing page following the instructions in the **Anonymous Broadcast** section, and choose your static Session ID from the list.

   <figure><img src="/files/HIj8Pbj7ay3PKTX5e9IR" alt=""><figcaption></figcaption></figure>
6. You can come back and edit your Static Session at any point, by clicking on the **Edit** button on the **Sharing** tab of the **Settings** page. Here you can change the authentication of your session, as well as deleting your **Session ID** in case you need to regenerate a new session.

{% hint style="danger" %}
If you **delete** your session ID you cannot retrieve it, and you will be given the choice to choose a new one from the drop down list, the same as when you first setup sharing.&#x20;
{% endhint %}

[^1]: You can share this with others so that they can join your session without having to type in the session ID. For more information see the help section on [**Connecting via a URL**](/streaming-captions/connecting-via-a-url)**.**


# Connecting to Broadcast Captions

{% hint style="info" %}
This page discusses connecting to a stream, if you want to broadcast your captions to others, follow the instructions on [**this page**](/streaming-captions/broadcasting-your-captions-to-others).
{% endhint %}

### Connecting via the Broadcast Interface

Zip Captions allows you to share your captions with users on other devices. This is very useful in a number of situations, these can include:

* In a classroom, to send captions to students devices instead of displaying them on a central screen
* At a conference, where captions could be too small to read, broadcasting allows captions to be seen on participants screens
* In a setting where there is no screen available

To join a broadcast stream:

1. Click on the broadcast button at the top of the screen (this looks like an antenna with circles coming from it)

   <figure><img src="/files/bEsZgElAdYI9MJ6HrYYw" alt=""><figcaption></figcaption></figure>
2. Agree to the privacy warning to confirm that you understand that you are going to share your data with others when you start broadcasting. If you are just joining a stream, you won't be sharing your data.

   <figure><img src="/files/qSnCuceawGp5wHWs2Roc" alt=""><figcaption></figcaption></figure>
3. Type in the **Session ID** that you have been provided with and click on **Connect**

   <figure><img src="/files/dZPCUxh8k0OSCnYI2Wtw" alt=""><figcaption></figcaption></figure>
4. If the session that you are joining requires a **Join Code** you will now be prompted to enter it, do so, and click on **Connect**.

   <figure><img src="/files/4gb2LzGmYurFnDGAxAQd" alt=""><figcaption></figcaption></figure>
5. The broadcast will now be shown on your screen.&#x20;

   <figure><img src="/files/A5Un0rTf3PlPWP8DKNZE" alt=""><figcaption></figcaption></figure>
6. When you are finished you can close the window or click **Leave Session**. If the person streaming the captions closes the broadcast, then your stream will stop.&#x20;

   <figure><img src="/files/P0GI5dK1ndrct9L9Rp3T" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
It's possible to connect to a stream via a URL. You can find instructions on how to do that [here](/streaming-captions/connecting-via-a-url#connecting-via-a-url).&#x20;
{% endhint %}


# Captioning with OBS for Live Streams

### Using ZipCaptions with OBS to add Live Captions to your streams

{% hint style="info" %}
There is more information about other ways to caption using OBS in the [**Advanced**](/advanced/captioning-with-obs-browser-source) section.
{% endhint %}

To use this feature there are some steps that you will need to follow in both ZipCaptions, and in OBS. Before we begin you need to ensure that you have the following:

1. ZipCaptions open in a supported web browser
2. OBS (Open Broadcaster Software) [Download Here](https://obsproject.com/) for Windows, Mac or Linux

Once you have your pre-requisites out of the way you then need to set up OBS

1. Open OBS and click on the **Tools** menu and then **Web Socket Server Settings**&#x20;

   <figure><img src="/files/UtbeMsF2iSdaBeOWepeI" alt=""><figcaption></figcaption></figure>
2. In the window which opens, check the box **Enable WebSocket Server** set a port which you can use (the default is **4455** and should be fine), and click **Generate Password**.&#x20;

   <figure><img src="/files/ALBM9ljXciolK3rQCrCV" alt=""><figcaption></figcaption></figure>
3. Now click on the **Show Connect Info** button and copy the *Password* shown in the box by clicking on the **Copy** button next to it.&#x20;

   <figure><img src="/files/p0nrdpZ1Af1W2jSKJsTa" alt=""><figcaption></figcaption></figure>
4. Now close the box and go to your browser window with ZipCaptions in it. Click on the **hamburger** menu and choose **settings**.

   <figure><img src="/files/bEsZgElAdYI9MJ6HrYYw" alt=""><figcaption></figcaption></figure>
5. Click on the OBS Tab on the settings page

   <figure><img src="/files/SGNChNP9rvsNSK72rX8u" alt=""><figcaption></figcaption></figure>
6. Set the **Server IP** to *localhost* (unless you’re running OBS on a different computer to ZipCaptions, in which case you would enter the IP address of the computer running OBS), set the **Server Port** to *4455* (unless you chose a different port in the setup in OBS, in which case you should enter the port you chose), and finally paste the password that you copied from OBS into the **Password** box and click on the **Connect** button. *The Captioning will now automatically start*.&#x20;

   <figure><img src="/files/UAmewCL7JMlHSFjg5acz" alt=""><figcaption></figcaption></figure>
7. You will now see at the top of the screen that OBS is connected. The OBS icon will now appear at the top of the screen with a blue dot. This icon can be clicked on to control the session.

   <figure><img src="/files/2gi9MU2Yro3n1oX55qfd" alt=""><figcaption></figcaption></figure>
8. Click on the OBS icon in the top right, and choose **Listen**

   <figure><img src="/files/RFUtYYpR7TPeatrJFZL7" alt=""><figcaption></figcaption></figure>
9. This takes you to the captioning screen

   <figure><img src="/files/xFIEGbducLHzrsw1lKnY" alt=""><figcaption></figcaption></figure>
10. Leave ZipCaptions open and head back into OBS, you can now start your stream and the captions will be sent to the stream from OBS.

Depending on the service that you are using you may need to tell it that you are sending captions with your stream. For example, YouTube Live requires you to check the Captions box before you start your stream.

The captions that ZipCaptions outputs are in the 608 Format. You can see an example of the settings required for YouTube Live below:&#x20;

<figure><img src="/files/cA1OR7lgQcum9fI0kgMg" alt=""><figcaption></figcaption></figure>

To disconnect from OBS, click on the OBS icon in Zip Captions and choose **disconnect** or, go to settings and choose **disconnect** under the OBS tab. You can reconnect from the same menu once you have disconnected as long as OBS is still open and the Websocket settings have not changed.


# Connecting via a URL

You can connect to a Broadcast via a URL and also share a broadcast via a URL

* [Connecting via a URL](#connecting-via-a-url)
* [Sharing via a URL](#sharing-a-stream-via-a-url)

***

### Connecting via a URL

It is possible to connect to a stream via a URL

In the URL box in the browser enter the following URL, replacing the placeholders with the information from your stream:&#x20;

```
https://zipcaptions.app/stream/[SESSIONID]?joinCode=[JOINCODE]
```

Example:

```
https://zipcaptions.app/stream/9q4r-j2jk?joinCode=ewqe
```

***

### Sharing a Stream via a URL

It is possible to share the connection information for your broadcast via a URL.

To share a URL, replace the placeholders below with the information from your stream page:

```
https://zipcaptions.app/stream/[SESSIONID]?joinCode=[JOINCODE]
```

Example:

```
https://zipcaptions.app/stream/9q4r-j2jk?joinCode=ewqe
```

{% hint style="success" %}
If you have an **anonymous** stream, or you only want certain people to join your link, you can share the URL without the join code parameter. Using the above example:

```
https://zipcaptions.app/stream/9q4r-j2jk
```

{% endhint %}

{% hint style="info" %}
It's possible to now take this URL and share it as a QR code to make it easy for others to join to your broadcast stream. <https://me-qr.com/> provides a lot of customization.
{% endhint %}

***

### Finding your Stream Link from the Settings Page

Your Stream URL will be shown in the **Sharing** tab on the **Settings** page.


# Introducing Transcripts

{% hint style="info" %}
You must enable Transcripts in the settings, on each device that you wish to use them on,  before you can use them.&#x20;

You can read how to do this [here](/settings/transcripts).&#x20;
{% endhint %}

Transcripts allow you to have a copy of your captioning session once the session has ended.&#x20;

Transcripts can be useful for:

* Taking notes
* Being able to read back over what has happened or been discussed
* To attach to notes that have been given to you so that you can read the instruction as well as the notes
* Adding captions to videos
* And many more uses...

{% hint style="warning" %}
It is important that you inform others that they will be recorded when using Transcripts, as their voice will be turned into text and saved.
{% endhint %}

Zip Captions Transcripts will also allow you to export them into the following file formats:

* SRT (A subtitle file format which can be used with video playback sites like YouTube and Vimeo)
* TXT (A plain text format, which can be opened with your text editor)
* VTT (A format similar to SRT but more customisable)

{% hint style="info" %}
The captioning engine used for transcripts is the same as the one for captions. Transcripts do not use any additional tokens for AI Captioning.
{% endhint %}

{% embed url="<https://youtu.be/sF7n1X1oIFY>" %}

{% embed url="<https://youtu.be/r1RNyEJa3d8>" %}


# Getting Started with Transcripts

{% hint style="info" %}
You must enable Transcripts in the settings, before you can use them.&#x20;

You can read how to do this [here](/settings/transcripts).&#x20;
{% endhint %}

{% hint style="warning" %}
Transcripts are only stored locally on your device, they are not synced to the cloud. This means that you will only be able to see transcripts on the device that you created them on. If you want to use them on other devices you can export them using the instructions [here](/transcriptions/exporting-your-transcripts).
{% endhint %}

1. When you open the captioning window you will now see a Transcription Enabled notification

<figure><img src="/files/euurwiSj9pf3O47K5GZL" alt=""><figcaption></figcaption></figure>

This session is now being captioned.&#x20;

2. Once you have finished the captioning session, click on the Microphone to end captioning
3. Click on the three lines ☰
4. Click on Transcripts\
   ![](/files/krQSnr6VIz4Zzey5XVwb)
5. The Transcripts screen will now appear, this will show all of your locally stored transcripts<br>

   <figure><img src="/files/v9vaxChZJyJBUNjg0AqS" alt=""><figcaption></figcaption></figure>
6. Clicking on the transcript will allow you to view it


# Editing Transcript

You can edit the following aspects of your transcripts:

* The title
* The description
* Any segment of text from your transcript (in the Individual Transcript View)

There are two ways to edit this information:

* From the transcripts screen
* From the individual transcription view

<details>

<summary>From the Transcripts Screen</summary>

1. Click on the Pencil next to the transcript that you wish to edit\ <br>

   <figure><img src="/files/Ae3yIERESXxA937KXLnd" alt=""><figcaption></figcaption></figure>
2. Now enter the information\
   ![](/files/NGZhnqBcqxlihfAK4jci)
3. Click **Save and Close**

</details>

<details>

<summary>From the Individual Transcript View</summary>

1. Open the transcript by clicking on it from the Transcripts Screen
2. Click on the **Edit** toggle at the top of the screen<br>

   <figure><img src="/files/LVyvdcTiBM8KycFleaD0" alt=""><figcaption></figcaption></figure>
3. Add in your title by clicking on the title, and your description, by click in the description pane.&#x20;
4. You can also click on any line from your transcript to edit that segment.\
   ![](/files/SWXsaN6NNvqTtOkcuR69)
5. Click Save once you are done editing that segment
6. Once you are finished, turn off the edit toggle

</details>


# Advanced Transcript Tips

### Transcription Tip # 1 - Toggling Views

{% embed url="<https://youtu.be/JJ5wA5hMUtE>" %}

### Transcription Tip # 2 - Editing Captions

{% embed url="<https://youtu.be/VUY1oPrprBU>" %}


# Exporting your Transcripts

Zip Captions Transcripts will allow you to export your transcripts into the following file formats:

* SRT (A subtitle file format which can be used with video playback sites like YouTube and Vimeo)
* TXT (A plain text format, which can be opened with your text editor)
* VTT (A format similar to SRT but more customizable)

To get started:

1. Visit the transcript that you wish to edit by click on it from the [transcriptions page](https://zipcaptions.app/user/transcripts).&#x20;
2. Click on the file icon in the top right corner\
   ![](/files/MGyDrR151SRFEahX9L7L)
3. Choose the file format in which you want to export your file
4. The file will be downloaded to your device


# Using Transcripts with Generative AI

Using your captioning transcripts with Generative Artificial Intelligence can allow you to produce summaries of meetings, classes and presentations. Discover how to get started with this.

{% hint style="info" %}
The following sections maybe useful before starting with this:

* [Getting Started with Transcripts](/transcriptions/getting-started-with-transcripts)
* [Exporting your Transcript](/transcriptions/exporting-your-transcripts)
  {% endhint %}

{% hint style="info" %}
For this example we are going to use [Google's Notebook LM](https://notebooklm.google.com) tool, but Chat GPT,  Microsoft Co-Pilot, Claude and Gemini could all be used to generate similar results.
{% endhint %}

{% embed url="<https://www.youtube.com/watch?v=cvcumT7QI1A>" %}


# Microphone Goes to Sleep

**If you are using OBS please see** [**this article**](/known-issues/microphone-becomes-unresponsive-using-obs) **instead**

**ISSUE:**&#x20;

The microphone will sleep when the active tab is moved away from

**SOLUTION:**&#x20;

Instead of running the app in an active tab, install the Progressive Web App (PWA) version of ZipCaptions.

To install the PWA you need to:

1. Click on the menu in your web browser

<figure><img src="/files/5TerYXCRBecceTMz311i" alt=""><figcaption></figcaption></figure>

1. Click on **Install Zip Captions**


# Microphone Shows as Exclamation Mark

**ISSUE:**&#x20;

The Microphone Appears as an Exclamation Mark (⚠️)

This can be caused by:

* A lack of microphone on the computer
  * **SOLUTION:** Install a microphone on the computer
* A change in the audio input
  * **SOLUTION:** Reload the page so that the microphone can be seen
* Incorrect permissions for the microphone
  * **SOLUTION:** Click on the lock in the address bar and change the permissions

<figure><img src="/files/fqB9fhaRbYkTOcnygi8l" alt=""><figcaption></figcaption></figure>

* Some other error, which will appear in the footer of the application.
  * SOLUTION: The error message will tell you what the issue is


# Microphone Becomes Unresponsive Using OBS

ISSUE:

When using OBS the microphone may become unresponsive as the browser window is forced into the background

SOLUTION:

1. Running ZipCaptions as a Progressive Web App (PWA) will see the page running in its own browser instance. This will stop the microphone from sleeping.
2. Adding <https://zipcaptions.app> to the [chrome://settings/performance page](chrome://settings/performance%20page) will prevent Chrome from putting the tab to sleep when you move away from it.


# Microphone Volume is Automatically Adjusted

**ISSUE:**

When using Zip Captions in Chrome on Windows, the volume of the microphone is adjusted, and in a recording the user cannot be heard.

**CAUSE:**

Chrome has the ability to manage the volume of the microphone. This setting is called “WebRTC adjust the input volume”.

**SOLUTION:**

1. Disable the feature by turning off the following Chrome Flag: ‘WebRTC to adjust the input volume’. In order to do this, go to [chrome://flags](chrome://flags/) and search for the ‘WebRTC to adjust the input volume’ flag. Turn it off by changing the drop down to ‘Disabled’.
2. Installing the ‘Disabled Automatic Gain Control’ Google Chrome Extension from the Chrome Web Store will also disable this feature. You can find it at <https://chromewebstore.google.com/detail/disable-automatic-gain-co/clpapnmmlmecieknddelobgikompchkk?pli=1>.


# iOS Devices Give an Error

If you are using an iOS device and you get the error:

> Speech recognition error: The user agent disallowed the requested speech recognition service, either because the user agent doesn't support it or because of reasons of security, privacy or user preference.

<div align="left"><figure><img src="/files/mI7crWeAX2sYLVGpp9IX" alt="" width="375"><figcaption></figcaption></figure></div>

You need to enable the **Speech Recognition Engine** in the device settings. To do this:

1. Go to Settings\ <img src="/files/g7gx60YNBPV9cWxnCDl6" alt="" data-size="original">
2. Go to Privacy & Security\
   ![](/files/pSG1rzcMgKjFArqRGWYD)
3. Choose Speech Recognition\
   ![](/files/KRULbSlcSCJHbJ0jddza)
4. Ensure that the toggle that is next to your browser is **Green**
5. Go back to **Settings** > **General** > **Keyboard**\
   ![](/files/xTNTMrPxTy1yLh5tanO2)
6. Scroll down until you get to **Dictation**\
   ![](/files/FKHzE4dqAazLKsu7ZCYm)
7. Disable dictation by sliding the green toggle\
   ![](/files/hdVmrawBcsAa21xIjjAd)
8. Now **re-enable dictation** by **sliding the slider** across again, and **choosing Enable in the prompt** which appears\
   ![](/files/WrJJAK6slhfcCpfZMCmd)
9. Return to Zip Captions, and your captioning should now work


# App Installed from the Google Play Store does not work

There are a few things at play here:

1. Your browser must support the WebSpeech API, while you may have a compatible browser on your device, the browser that your device manufacturer ships with your device may be affecting the ability for your device to run the Play Store version correctly.
2. Your device might need updating to a newer Android version

If the version from the Play Store does not work, we suggest that you install the Google Chrome browser onto your device, and [use the PWA Version of Zip Captions](/getting-started/installing-the-zip-captions-app#android).&#x20;


# Persistent Captions Extension

The Zip Captions Chrome Extension is a powerful Chrome extension designed to display the captions from Zip Captions in a convenient, always-accessible overlay.  Our extension ensures your captions are visible across all your Chrome tabs or even in a separate, floating window that stays with you.

<figure><img src="/files/jAG7SdqfZcPwyyrOlW6z" alt=""><figcaption><p>The Zip Captions Chrome Extension showing captions in a pop-up window positioned underneath the main browser window</p></figcaption></figure>

The extension allows you to multitask effectively without losing track of spoken content. Customize the overlay's appearance to perfectly match your viewing comfort with adjustable background opacity and text size. Choose to have captions displayed discreetly at the bottom of your pages or "pop out" the overlay into its own resizable window for maximum flexibility. Stay informed, stay productive, and never miss a word, no matter where you browse!

**1. Installation:**

* Install the extension from the [Chrome Web Store](https://chromewebstore.google.com/detail/zipcaptions-persistent-ca/ibkgpkncdmagdcbmnnekjikiaijfioma?authuser=0\&hl=en-GB)&#x20;
* Once installed, you'll see its icon in your Chrome toolbar.

**2. Setting up the Caption Source:**

* For the extension to capture and display captions, you must have the Zip Captions page open and actively producing captions.

**3. Using the Extension Popup (Clicking the Toolbar Icon):** Click the  icon in your Chrome toolbar to open the control popup. Here you'll find:

<div align="center"><figure><img src="/files/1DMXqVgjA4nijEyLlH0y" alt="" width="244"><figcaption><p>The extension with the menu option</p></figcaption></figure></div>

* **Global Overlay Control:**
  * **Status Text:** Shows if the overlay is currently "Enabled" or "Disabled."
  * **Enable/Disable Overlay Globally Button:** This is the main switch for the extension.
    * If it says "Disable Overlay Globally," captions are active. Clicking it will turn off all caption overlays (both in-page and the pop-out if it's open) and change the button text to "Enable Overlay Globally."
    * If it says "Enable Overlay Globally," captions are inactive. Clicking it will turn the feature on, and overlays will attempt to appear based on your settings.
* **Pop-out / Dock Control:**
  * **"Pop-out Overlay" Button:** Click this to move the caption display from the in-page overlays into a separate, floating window. The in-page overlays on all tabs will then hide.
  * **"Focus Pop-out Window" Button:** If the pop-out window is already open, this button's text will change. Clicking it will attempt to bring the existing pop-out window to the front.
* **Style Options:**
  * **Background Opacity Slider:** Drag the slider to adjust the transparency of the overlay's background (both for the in-page overlay and the pop-out window). The value (e.g., 0.10 to 1.00) is displayed next to the label. Changes are applied live.
  * **Text Size (px) Input:** Enter a number (e.g., between 10 and 48) or use the small arrows to set your preferred font size for the captions. This also applies to both in-page and pop-out overlays live.

**4. The In-Page Overlay:**

* When the extension is **Enabled** and the display mode is set to **"in-page"** (this is the default mode, or after docking the pop-out):
  * A persistent overlay panel will appear at the bottom of all your open Chrome tabs (that match the extension's permissions, typically all standard web pages).
  * **On the Source Tab:** The overlay will display the live captions being generated directly from that page.
  * **On Other Tabs:** The overlay will display the same live captions being broadcast from your active Source Tab. If no Source Tab is active or sending captions, it will typically display "Waiting for captions..." or a similar message.
* This in-page overlay will use the opacity and text size you've set in the popup.

**5. The Pop-out Window Overlay:**

* **Activating:** Click the "Pop-out Overlay" button in the extension's main popup.
* **Behaviour:** A new, small, separate window will appear, dedicated to showing the live captions.
  * It will float and can be moved around your screen. While it tries to stay on top of other Chrome windows, operating system behaviour or full-screen apps might sometimes cover it.
  * The in-page overlays on your other tabs will automatically hide while the pop-out is active.
  * The pop-out window will display live captions from your Source Tab and will use the opacity and text size settings from the main popup.
* **"Dock to Page" Icon/Button:** Inside the pop-out window (usually in a corner), you'll find an icon button.
  * Clicking this "Dock" button will close the pop-out window.
  * The extension will automatically switch back to "in-page" overlay mode, and the in-page overlays will reappear on your browser tabs, displaying the live captions.
* **Closing the Pop-out:** If you close the pop-out window using its standard OS window close button (the 'X'), it will also automatically switch the extension back to "in-page" overlay mode.

**6. Multi-Tasking with Captions:**

* With either the in-page overlay or the pop-out window active, you can browse other tabs or work in other applications (though the pop-out's ability to stay on top of non-Chrome apps is limited) while still seeing the live captions from your source tab.

**Troubleshooting & Tips:**

* **Ensure a Source Tab is Active:** For captions to appear anywhere, you need at least one tab open that the extension recognizes as a caption source and that tab must be actively producing captions.
* **Check the Global Toggle:** If no overlays are appearing, first check the main "Enable/Disable Overlay Globally" button in the extension popup.
* **One Primary Source:** While the extension tries to be smart, for the most consistent cross-tab captioning experience, it's best to have only one primary tab actively generating captions that you intend to be the source.
* **Reload if Needed:** If you change settings or encounter an issue, sometimes reloading the extension from `chrome://extensions` and then reloading your web pages can help.


# vMix Support Extension

You can enable vMix support for Zip Captions by installing this extension from the Chrome Web Store. The setup process is a little more involved than for other platforms.&#x20;

{% hint style="warning" %}
You must ensure that the Web Controller function is enabled in vMix.

The extension can only talk to a vMix instance which is installed on the same computer.&#x20;
{% endhint %}

1. Install the extension using [this link](https://chromewebstore.google.com/detail/zip-captions-vmix-caption/lbmofcdefajmlgdkccabpofoonmdfjao).
2. Install vMix from the [vMix site](https://www.vmix.com/).
3. Open vMix and add a title to your editor, this can be technically any title that you want.
4. Open the Options page in the chrome extension by right clicking on the icon and choosing options, or via the extensions page in Chrome: **⋮ > Extensions > Manage Extensions**<br>

   <figure><img src="/files/ijxl13baIUSrJzzf2SkX" alt=""><figcaption><p>vMix Settings in the Chrome Extension (these match the settings in the window below)</p></figcaption></figure>
5. In the vMix input box, you will put the name of the title (or rename your title in vMix to match the one you choose here).
6. In vMix, right click in the title box at the bottom of the screen, and choose the title editor, find the title property name, in the left hand box of the editor window, and enter this name into the fourth box (**Text Field Name**) in the chrome extension.<br>

   <figure><img src="/files/y9ozSIxS6ci4vohnTbhw" alt=""><figcaption><p>Here you can see that the Text Field Name is <strong>Heading</strong></p></figcaption></figure>
7. Save your Chrome Options, and then close the title editor.
8. Refresh your Zip Captions window, and your captions should now start to appear in vMix.&#x20;


# Companion Add-On

Zip Captions now supports being controlled via Bitfocus Companion.&#x20;

You can control the following functions:

* Start / Stop Captioning
* Play / Pause Captioning

You can also get feedback from the extension:

* Captioning Running / Stopped
* The currently captioned word

You get the add-on working, you must:

1. Install the Chrome Extension from the [Google Web Store](https://chromewebstore.google.com/detail/zip-captions-companion-ad/chcflkiceakimokommplmfpcpodabdcg).
2. Install the Companion Module within Companion.

{% embed url="<https://youtu.be/xMFm8ToDeU4>" %}


# Captioning with OBS (Browser Source)

**Using Zip Captions with the Browser Source in OBS to provide Open Captions for a Live Stream, or a Live Event.**&#x20;

**T**o get started you will need OBS and Zip Captions open with an [active broadcast stream](/streaming-captions/broadcasting-your-captions-to-others).

1. In the sources window in OBS, click on the + and choose Browser

<figure><img src="/files/gdT5BEEEt1HZs2krRxuc" alt="" width="563"><figcaption></figcaption></figure>

2. Click OK to the prompt to create a new Browser

<figure><img src="/files/9FzV7C4pv7E1qd7hEouq" alt="" width="563"><figcaption></figcaption></figure>

3. In the URL box enter the following URL, replacing the placeholders with the information from your stream:&#x20;

```
https://zipcaptions.app/stream/[SESSIONID]?joinCode=[JOINCODE]
```

Example:

```
https://zipcaptions.app/stream/9q4r-j2jk?joinCode=ewqe
```

In the height and width, choose a reasonable width for you needs and a height of around 400

Click on **OK**

<figure><img src="/files/Z0WvNXqFU4MPoFbUVr3A" alt="" width="563"><figcaption></figcaption></figure>

4. Click on the **Interact** button. \
   *If you are using Streamlabs OBS you will need to right click and choose Interact*

<figure><img src="/files/uluFZv9kjHcNNTIoPqeQ" alt="" width="563"><figcaption></figcaption></figure>

5. Now you can use the quick access settings in Zip Captions to set the **On Screen Results** to either 0 or 1, this reduces the lines of captions shown to 1 or 2 lines.&#x20;

<figure><img src="/files/fmwSaj2AnJQBlBbsvQO6" alt="" width="563"><figcaption></figcaption></figure>

6. Finally here, click on the **Fullscreen** button to remove the header and the footer. \
   Click the arrow to hide the quick access settings.

<figure><img src="/files/9I1vi5ZKqXil2LwxNkE2" alt="" width="563"><figcaption></figcaption></figure>

You now have a panel which will show live captions being pulled from your Zip Captions session.&#x20;


# Captioning with OBS (Application Source)

Using OBS you can capture the Zip Captions window using the Source capture and then Chromakey your captions. This method will result in overlayed open captions, which can then be combined with the [**Simple Method**](/example-use-cases/live-event-captioning) to provide captions in your stream as well.&#x20;

1. Open OBS
2. Open the Zip Captions PWA ([Instructions on installing the PWA](/getting-started/installing-the-zip-captions-app))
3. Add a **Window Capture** to the **Sources** by clicking on the + underneath the sources window.

<figure><img src="/files/ePwxa4gTafqvFuhQUbVz" alt=""><figcaption><p>The Sources panel. This is what you should end up with. </p></figcaption></figure>

4. Choose the **Window Capture** method, and choose **Zip Captions** PWA from the window drop down.

<figure><img src="/files/iTjjRyu10OAcJtKMwLqJ" alt=""><figcaption><p>Choosing the Window Capture and the Zip Captions Window</p></figcaption></figure>

5. Click **OK**&#x20;
6. Now click on the + again, and this time choose the **Colour Source** option.&#x20;
7. Click on the **Filters** button which shows above the sources.

<figure><img src="/files/98PuKAsMs2t80bNH009C" alt=""><figcaption><p>Choose Filters for the Colour Source</p></figcaption></figure>

8. We are now going to add a Chroma Key filter to the colour source.&#x20;
9. Click on the + and choose **Chroma Key**, in the 'Key Colour Type' choose **Blue**, and make sure that it matches the settings below.&#x20;

<figure><img src="/files/EKxp18gqrunbye9IfvpL" alt=""><figcaption><p>Add a Chroma Key Filter</p></figcaption></figure>

10. Click Close
11. Resize your window source so that the captions are shown to your needs.&#x20;
12. Go to your Zip Captions PWA window, and in the settings menu, set your theme to **Aqua**.&#x20;

<figure><img src="/files/whI4GrRQdbJxhA0G2pnx" alt=""><figcaption><p>Change the Zip Captions theme to Aqua</p></figcaption></figure>

13. Open the Preview window in OBS, right click on the preview window, and then select "FullScreen Projector (Preview)" or "Windowed Projector (Preview)". You can then place this onto a second output.


# Captioning with a Blackmagic Design ATEM Mini

**The ATEM Mini series of video switchers are an affordable option to live video switching and editing. This article discusses the ability to use the Downstream Keyer in the ATEM Control Software along with a rectangle placed into the Media Library.**&#x20;

Prerequisites:

* A Blackmagic Design ATEM Mini, Mini Pro, Mini Pro ISO, Mini Extreme or Mini Extreme ISO

{% hint style="info" %}
We have not tested this with other models of the ATEM Switcher, however, while this should work on the whole ATEM family, you may wish to use the super source on the switchers which support this feature.&#x20;
{% endhint %}

* A computer running Zip Captions connected to the ATEM via HDMI ([see below](#considerations-for-setting-up-zip-captions) for instructions for setting up Zip Captions)
* A computer with the Blackmagic Design [ATEM Control Software](https://www.blackmagicdesign.com/ca/support/family/atem-live-production-switchers) installed and running, connected directly to the ATEM via USB-C or on the same network as the ATEM.&#x20;

In this example, we have the computer running the captions plugged into HDMI 1 on the ATEM, and we have an additional computer input plugged into HDMI 2 displaying a web browser. The HDMI output is set to PGM.

<figure><img src="/files/e6AHGBpBbF1AzuA3QSH3" alt=""><figcaption></figcaption></figure>

All of the setup for this is going to happen in the ATEM Control Software.&#x20;

1. Open the ATEM Control Software and connect to your switcher
2. Click on the Media tab at the bottom of the screen.
3. Download [this rectangle](https://drive.google.com/file/d/1HPiQXxeMhWSwYlH929aqhd5EP1zw8Dnr/view?usp=drive_link) (links to Google Drive) or [this one ](https://drive.google.com/file/d/1MM34bsLWoN8vXv2MrjIb5-fEV-wY0PPw/view?usp=drive_link)which is opaque.
4. On the left side of the media panel, navigate to where you downloaded your rectangle.
5. Drag and drop the rectangle to one of the empty media library locations.
6. Drag the rectangle in the media library, to the media box on the right hand side of the screen.

<div data-full-width="false"><figure><img src="/files/I3i2tI7xXWZ2pa5VzpXR" alt="" width="563"><figcaption><p>Drag and drop the rectangle from your media library to the active media location</p></figcaption></figure></div>

7. Click on the Switcher tab at the bottom of the screen
8. On the right hand side click on Palettes

<figure><img src="/files/I8lg4C8OZx9kP6BzstrN" alt=""><figcaption></figcaption></figure>

7. Scroll down to the Downstream Key section

<figure><img src="/files/SmCEWBgtjGQisjZLePEV" alt="" width="363"><figcaption></figcaption></figure>

7. Set the following settings:
   * **Fill Source** choose your **HDMI 1** input
   * **Key Source** choose the **Media Player 1 Key**

{% hint style="warning" %}
You should not be showing Input 1 on the switcher, the red live indicator should now be on Inputs 2, 3 or 4.&#x20;
{% endhint %}

7. In the main window find the section titled **DSK 1** and click on the **ON AIR** button

<figure><img src="/files/ZrMokBBupfjuLlbawLBR" alt="" width="563"><figcaption></figcaption></figure>

7. You should now find that your captions appear in a rectangle at the bottom of the screen

<figure><img src="/files/C789DCBHdLfwclB96glU" alt=""><figcaption><p>Captions appearing in a rectangle drawn over the main image. </p></figcaption></figure>

***

#### Considerations for setting up Zip Captions

* The theme should be set to Zip Dark to work with this rectangle, if you wish to use it with another theme, you would need to change the rectangle to match the colour of the theme.
* The **On Screen Results** setting should be set to 1 or 2 lines to prevent the text from creeping outside the rectangle.
* Zip Captions should be set to full screen to remove the header and footer

{% hint style="info" %}
You can always choose to view HDMI 1 to get Zip Captions set up properly, or you can choose to view the Multi View in order to access the settings.
{% endhint %}


# Use Computer Audio in Zip Captions

Sometimes it is necessary to be able to feed your computers audio to generate captions. For example, if you want to play a video, and caption this on your device during a presentation. This is possible using specialised software which can run on your computer.

Depending on the operating system that you are using we would recommend using the following free software to achieve this.

#### Windows

Voicemeeter: <https://vb-audio.com/Voicemeeter/index.htm>

#### Mac OS

Black-Hole: <https://github.com/ExistentialAudio/BlackHole>

{% hint style="danger" %}
We would advise that you read all of the help documentation, and fully understand how to use these tools before you dive in. Changing some of these settings, and using some of these tools can prevent your regular sound settings from working on your device.&#x20;
{% endhint %}


# Live Event Captioning

By using the software OBS, you can caption your live event using Zip Captions so that the captions are overlayed on your projections and on video shown on your screen.&#x20;

There are a few ways to set this up.&#x20;

{% tabs %}
{% tab title="Simple Method" %}
Install the PWA version of Zip Captions using these instructions.&#x20;

Please make sure that your browser supports installation of PWA's by [visiting this page](/getting-started/supported-browsers).

1. Open the PWA on your computer from the Applications Menu
2. Minimise the toolbar by clicking the arrow

<figure><img src="/files/cmNzp4wPOkU9KrNmLPF3" alt=""><figcaption><p>Minimise the toolbar</p></figcaption></figure>

3. Resize the window and adjust the number of lines to reduce the number of results shown.

<figure><img src="/files/JGPRJodprtZk6kaiPoh1" alt=""><figcaption><p>Adjusting the number of on screen results</p></figcaption></figure>

4. You can now place other applications over the top of your captioning window.&#x20;

<figure><img src="/files/3LVi7VGDSWCXfvlEJfYT" alt=""><figcaption><p>Captioning window placed underneath another window</p></figcaption></figure>
{% endtab %}

{% tab title="Simple Method OBS" %}
Using Websockets in OBS you can simply connect Zip Captions and OBS together. You can then livestream this to Twitch or to YouTube Live and turn on the captions on your feed. This is the same method that can be used for&#x20;

{% embed url="<https://zip-captions.gitbook.io/zip-captions/streaming-captions/captioning-with-obs>" %}
{% endtab %}

{% tab title="OBS Complex" %}
You can use the OBS Browser Source to capture a broadcast stream.&#x20;

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>OBS Application Source</strong></td><td>This allows you to capture a window on your desktop and chromakey it.</td><td></td><td><a href="/pages/cbuepqptagpKkwtXc4aU">/pages/cbuepqptagpKkwtXc4aU</a></td></tr><tr><td><strong>OBS Browser Source</strong></td><td>This allows you to capture captions from an inbuilt browser window in OBS.</td><td></td><td><a href="/pages/vWU1eXzxvHIwS2soGcdQ">/pages/vWU1eXzxvHIwS2soGcdQ</a></td></tr></tbody></table>
{% endtab %}
{% endtabs %}

For all live event captioning, you can always choose to broadcast your captions to attendees by following the instructions on the [Broadcasting Your Captions to Others](/streaming-captions/broadcasting-your-captions-to-others) page.&#x20;


# In the Classroom

Zip Captions was designed for the classroom, and was created by a pair of Educators.&#x20;

The accuracy of your captions can improved by following these instructions.&#x20;

There are a number of ways to use Zip Captions in the classroom:

{% tabs %}
{% tab title="Centrally on a Screen" %}
Captions can be shown on the main screen of the class by opening up the Zip Captions site and following the instructions in the [**Getting Started**](/getting-started/starting-captioning-with-zip-captions) section of this site. Installing the [**Progressive Web App**](/getting-started/installing-the-zip-captions-app) will give you more flexibility in your layout.&#x20;

If you want to use Zip Captions with a presentation tool, then you can do so by opening your Zip Captions window and placing it behind the presentation, reduce the number of on screen display items to 0.&#x20;

<figure><img src="/files/mJ4ik3SuKBorpFfNCsUo" alt=""><figcaption></figcaption></figure>

In Google Slides the slides can be set to present mode by changing the end of the URL to /present&#x20;

<figure><img src="/files/hNILoeSoJylYtV3v0bYN" alt=""><figcaption><p>Changing the Google Slides URL</p></figcaption></figure>
{% endtab %}

{% tab title="Sent to Student devices" %}
Sometimes we don't want to take up the screen that is being used to teach the class, or provide a visual. In this case, you can choose to broadcast the captions to your students personal devices, whether this be their phone, tablet or laptop/chromebook. You can follow t[hese instructions](/streaming-captions/broadcasting-your-captions-to-others) to learn more about how to do this.&#x20;
{% endtab %}

{% tab title="Integrating with Phonak Equipment" %}
If you have a student in your class with hearing loss, they may well already be using a remote microphone. Most school systems make use of the Phonak Roger systems.&#x20;

There are a number of options to collect audio from a Roger network and use it for captioning.&#x20;

* Use the Roger MyLink

These are simpler options, but are expensive, see step 5 below

* Use the Roger Neckloop (connect straight to the computer via USB C)
* Use the Roger Digimaster X (connect to the computer via 3.5mm cable)

The Roger MyLink can be connected as follows:

1. Plug an external sound card (USB or other) into the computer.
2. Plug a TTRS to TTS splitter into the sound card.&#x20;
3. Plug a cable into the microphone input of the TRRS splitter&#x20;
4. Plug the other end of this cable into the MyLink.

<figure><img src="/files/N3F73H6dogbbkx6pHotf" alt="" width="188"><figcaption></figcaption></figure>

5. You now need to set the Microphone settings correctly, so that the sound card input is the input from the MyLink (or the other devices)

<figure><img src="/files/4gKJosaZ7hNkZ0gsFW9x" alt="" width="375"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

***

#### There are a number of benefits to Open Captions in the Classroom

Open captions, like those provided by Zip Captions, offer numerous advantages for educational settings:

1. **Accessibility**: They ensure all students, especially those who are deaf or hard of hearing, can access the audio content of videos, presentations, or live instruction.
2. **Comprehension**: Open captions can aid in the comprehension of difficult vocabulary or complex information by providing a visual reinforcement of spoken words.
3. **Language Learning**: They are an effective tool for language learners, allowing them to see the spelling and structure of new words and phrases as they hear them.
4. **Attention and Engagement**: Captions can help keep students' attention on the content being presented and engage different learning styles.
5. **Flexibility**: Provides the ability to learn in noise-sensitive environments like libraries or in areas where audio cannot be used.


# Places of Worship

Places of Worship provide unique challenges, with aging populations, young children, and often large echoing spaces. We have seen many places of worship make use of Zip Captions. Most places of worship are making use of captions in two ways:

1. By broadcasting captions for users to connect to on their own devices
2. By leveraging OBS and the [instructions that can be found on this page](/streaming-captions/captioning-with-obs-for-live-streams).&#x20;


# Zip Captions Online & PWA Changelog

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Build 2024-09-03T13:32</strong>          </td><td><p></p><p>Release on 03/09/2024<br>Release 2024-09-03T13:32  includes the following new features:</p><ul><li><p>Transcriptions</p><ul><li>Create a transcript    </li><li>Edit a transcript title or description</li><li>Edit the text in a transcription  </li></ul></li></ul></td><td></td><td></td><td><a href="/pages/KI87oO9KLjPnDfj6E55L">/pages/KI87oO9KLjPnDfj6E55L</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Build 2024-08-07T17:16</strong></td><td><p>Release on 07/08/2024<br>Release 2024-08-07T17:16 includes the following new features:</p><ul><li>Connect your Patreon account</li><li>Ability to delete your account</li><li>More accurate results on mobile</li><li>Reduced the amount of information that we request from you and store</li></ul><p><br><br><br><br><br><br><br></p></td><td><p></p><p><br></p></td><td></td><td><a href="/pages/Xq7qsQtNRn6vZJIgNQsk">/pages/Xq7qsQtNRn6vZJIgNQsk</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Build 2024-05-13T23:57</strong></td><td><p></p><p>Released on 13/05/2024</p><p>Release 2024-05-13T23:57</p><p>includes the following new features:</p><ul><li>A new settings menu</li><li>Static Broadcast IDs </li><li>Anonymous Broadcasts</li><li>Much more...</li></ul><p></p><p><br></p></td><td></td><td></td><td><a href="/pages/znJFyd2nqH8Tc7HDtNTc">/pages/znJFyd2nqH8Tc7HDtNTc</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Build 2024-03-18T20:56</strong></td><td></td><td><p>Released on: 18/03/2024</p><p>Release 2024-03-18T20:56 includes the following updates/new features:</p><ul><li>The ability to log in to Zip Captions using your Google or Microsoft account</li><li>The ability to sync settings to and from the Zip Captions Cloud Server</li></ul></td><td></td><td><a href="/pages/tEVInlbMIH7WwtqIMYd9">/pages/tEVInlbMIH7WwtqIMYd9</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Build 2024-02-12T22:48</strong></td><td></td><td><p>Released on: 12/02/2024</p><p>Release 2024-02-12T22:48 introduces language support for:</p><ul><li>Ukrainian with a community translation</li></ul></td><td></td><td><a href="/pages/MQtbdxEC01Lj64wjpscT">/pages/MQtbdxEC01Lj64wjpscT</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Version 0.0.14</strong></td><td></td><td><p>Released on: 18/01/2024</p><p>The following new features can be found in version 0.0.14:</p><p>Addition of two languages:</p><ul><li>Portuguese</li><li>Polish</li></ul></td><td></td><td><a href="/pages/iUd85QQkumgdy1JYCWYq">/pages/iUd85QQkumgdy1JYCWYq</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Version 0.0.12</strong></td><td></td><td><p>Released on: 04/10/2023</p><p>The following new features can be found in version 0.0.12:</p><ul><li>Users can now choose from a selection of 7 fonts</li><li>Access to our new forum is now possible from the menu</li></ul></td><td></td><td><a href="/pages/B78geVHDrztg1s5uhh8M">/pages/B78geVHDrztg1s5uhh8M</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><strong>Version 0.0.11</strong></td><td><p></p><p>Released on: 28/09/23</p><p>The following new features can be found in version 0.0.11:</p><ul><li>On-screen results setting</li><li>Improvements to OBS Studio websocket integration can now be operated simultaneously with recognition/broadcast</li></ul></td><td></td><td></td><td><a href="/pages/MZyrWY5lJO32vnAluEkM">/pages/MZyrWY5lJO32vnAluEkM</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr><tr><td><p><strong>Version 0.0.9</strong></p><p></p><p>Released on: 16/09/23</p><p>The following new features can be found in version 0.0.9:</p><ul><li>OBS WebSocket Support</li><li>Donate with Patreon button</li><li>Ability to install the app as a web app</li><li>Link added to the help site</li></ul></td><td></td><td></td><td></td><td><a href="/pages/MZyrWY5lJO32vnAluEkM">/pages/MZyrWY5lJO32vnAluEkM</a></td><td><a href="/files/bhQuKmbogZbMzMfpoMMd">/files/bhQuKmbogZbMzMfpoMMd</a></td></tr></tbody></table>


# Version 0.0.9

Released on: 16/09/23

The following new features can be found in version 0.0.9:

* OBS WebSocket Support
* Donate with Patreon button
* Ability to install the app as a web app
* Link added to the help site

## OBS WebSocket Support

Open Broadcasting Software Studio will now accept captioning from ZipCaptions using the WebSocket interface. You can set up WebSocket Captions using the instructions which can be found here:

.

## Donate with Patreon

Patreon is a platform to allow you to support creators online. As part of your Patreon pledge of either $1 or $5 at this time you will get access to different perks. You can learn more on our Patreon page [here.](https://patreon.com/ZipCaptions)

## Ability to install the app as a Web App

You can now install ZipCaptions onto your device so that you can find it more easily. You should be prompted to install it, but in case you do not, you can do this manually from the menu. Click on the menu in the browser, then choose **Install ZipCaptions** from the menu.

## Link to Help Site

You can now access our help pages from the app more easily. Click on the menu in ZipCaptions, and find the help pages in the Support Section.


# Version 0.0.11

Released on: 28/09/23

The following new features can be found in version 0.0.11:

* On-screen results setting
* Improvements to OBS Studio websocket integration can now be operated simultaneously with recognition/broadcast

Bug Fixes

* Modification to segmentation logic, should avoid cutting off recognition results
* Moved settings action buttons, added confirm unsaved changes on navigation
* Adjustments to CSS to include previously-unthemed elements (sidebar controls, nav menu)


# Version 0.0.12

Released on: 04/10/2023

The following new features can be found in version 0.0.12:

* Users can now choose from a selection of 7 fonts
* Access to our new forum is now possible from the menu

Bug Fixes

* Issues with loading the site on iOS and Safari has been fixed


# Version 0.0.14

Released on: 18/01/2024

The following new features can be found in version 0.0.14:

Addition of two languages:

* Portuguese
* Polish

Bug Fixes

* In a previous version we fixed the font delivery system causing potential outages


# Build 2024-02-12T22:48

Released on: 12/02/2024

Release 2024-02-12T22:48 introduces language support for:

* Ukrainian with a community translation

Release 2024-02-12T22:48 includes the following updates/new features:

* A bug fix for a bug which was affecting network time out events. The app will now attempt to reconnect for up to 3 seconds before erroring out, so it should be able to re-establish a connection to the recognition server. Depending on how much time that takes, you may notice it drops a word or two during the period of disconnection.
* The logo has been updated.
* A fix for an overflowing app update notification.


# Build 2024-03-18T20:56

Released on: 18/03/2024

Release 2024-03-18T20:56 includes the following updates/new features:

* The ability to log in to Zip Captions using your Google or Microsoft account
* The ability to sync settings to and from the Zip Captions Cloud Server


# Build 2024-05-13T23:57

Released on: 13/05/2024

Release Build 2024-05-13T23:57 includes the following updates/new features:

* The ability to generate static broadcast session IDs
* The ability to generate a brodcast with or without a join code
* A new settings interface
* A new OBS interface
* A new Broadcast interface
* A new My Account layout
* Generation of a URL to share a broadcast with others


# Build 2024-08-08T17:16

Released on: 08/08/2024

Release Build 2024-08-08T17:16 includes the following updates/new features:

* I**ntegration with Patreon to determine your support level** - this will allow us to provide you with unique to Patreon features in the future, and to display your name as a supporter if you give us permission to do so (upcoming).
* **Ability to delete accounts** - if you wish to delete your account, you can now do so via the accounts page.&#x20;
* **More accurate results on Mobile** - you will notice that the red warning has disappeared on mobile, this is because we can now provide you with more accurate results. We have also fixed a bug with Safari.&#x20;
* **Reduced Personally Identifiable Information** - we have reduced the amount of information that we collect from you. We now capture just your email address in order to provide you with your services if you choose to login with one of our sign in partners.&#x20;


# Build 2024-09-03T13:32

Released on: 03/009/2024

Release Build 2024-09-03T13:32 includes the following updates/new features:

* Transcriptions
  * Create a transcript   &#x20;
  * Edit a transcript title or description
  * Edit the text in a transcription &#x20;


# Our Policies

Your Privacy is important to us, that is why we collect as little of your data as possible to offer our services. &#x20;

{% hint style="success" %}
**If you do not login**, then we do not store any data, and we do not use any analytics services. We do store cookies on your device, to allow us to save your settings for the next time that you visit. This cookie does not store any PII (Personally Identifiable Information).
{% endhint %}

{% hint style="danger" %}
**If you create an account and login with one of our sign in partners,** we do store certain limited PII, which is essential to providing you with these advanced services and to be able to authenticate you.
{% endhint %}

### FERPA & COPPA Compliance for Schools

Establishing whether our services are FERPA and COPPA compliant is the responsibility of the user, however there are some important points to bear in mind:

* Our services are COPPA and FERPA compliant **if the user does not create an account**, as no PII is stored, or shared.&#x20;
* Users under the age of 13, may not create an account for Zip Captions. If you are aware of a user who has create an account and is aged under 13, please contact us at <apps@zipcaptions.app>.&#x20;
* Users who create an account will have certain PII stored.&#x20;