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. |
|
|
|
officedev-microsoft-teams-samples-meetings-live-caption-nodejs |
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.
Once the meeting is scheduled. Follow this doc to enable CART Captions. Copy the CART link it will used while configuring tab for meeting.
- Meeting Chat
- Meeting Details
- Meeting SidePanel
- Cart API
- Microsoft Teams is installed and you have an account (not a guest account)
- NodeJS
- dev tunnel or ngrok latest version or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
- Teams Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- In the browser that launches, select the Add button to install the app to Teams.
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.
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/meetings-live-caption/nodejs
-
Install modules
npm install
-
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
-
Run your app
npm start
- Manually update the manifest.json
- Edit the
manifest.json
contained in theappManifest/
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 be1234.ngrok.com
and if you are using dev tunnels then your domain will be12345.devtunnels.ms
. - Zip up the contents of the
appManifest/
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Manage your apps -> Upload an app -> Upload a custom app")
- Edit the
NOTE: If you are unable to send caption, try configuring tab again.