Skip to content

Latest commit

 

History

History
 
 
page_type description products languages extensions urlFragment
sample
This sample application demonstrates how to use CART links to send live captions in Microsoft Teams meeting tabs.
office-teams
office
office-365
nodejs
javascript
contentType createdDate
samples
06/24/2022 12:00:00 AM
officedev-microsoft-teams-samples-meetings-live-caption-nodejs

Meeting side panel application uses CART link to send caption in live meeting.

This sample application illustrates how to implement live captioning in Microsoft Teams meetings using CART links. With functionalities including a meeting side panel, chat integration, and the ability to configure captions during meetings, this app significantly improves accessibility for participants.

Enable CART Captions

Once the meeting is scheduled. Follow this doc to enable CART Captions. Copy the CART link it will used while configuring tab for meeting.

Enable CART-1

Enable CART-2

Included Features

  • Meeting Chat
  • Meeting Details
  • Meeting SidePanel
  • Cart API

Key features

Key Features

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

To try this sample

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call the tab.

1. Clone and start your sample sample

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  2. In a terminal, navigate to samples/meetings-live-caption/nodejs

  3. Install modules

    npm install
  4. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous
  5. Run your app

    npm start

2. Manually update the manifest.json

  1. Manually update the manifest.json
    • Edit the manifest.json contained in the appManifest/ folder to replace the <<AppId>> with any guid value and <<APP-DOMAIN>> with with base Url domain. E.g. if you are using ngrok it would be 1234.ngrok.com and if you are using dev tunnels then your domain will be 12345.devtunnels.ms.
    • Zip up the contents of the appManifest/ folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the left-bottom Apps view, click "Manage your apps -> Upload an app -> Upload a custom app")

NOTE: If you are unable to send caption, try configuring tab again.

Features of the sample.

Install App

Add TO Meeting

Configurable Tab

Configurable Tab

  1. Schedule the meeting and add Meeting Caption Tab in that particular scheduled meeting. Add Tab
  2. Once meeting started, turn on live caption. Enable Live Caption
  3. Once the live caption has started, you can use the app to send live caption. Send live caption
  4. After clicking on Submit button, you will see the caption in the meeting. Caption in meeting