Skip to content

Latest commit

 

History

History

nodejs

Readme.md

page_type description products languages extensions urlFragment
sample
This sample tab application demonstrates how to control meeting audio in Microsoft Teams by muting and unmuting using the Incoming Client Audio API.
office-teams
office
office-365
js
contentType createdDate
samples
08-08-2022 10:00:01
officedev-microsoft-teams-samples-meeting-audio-state-nodejs

Meeting Audio State Sample

This sample tab application showcases how to manage audio states in Microsoft Teams meetings by muting and unmuting using the Incoming Client Audio API. With features like meeting side panel integration, support for Teams themes, and RSC permissions, it provides a streamlined experience for controlling audio directly from the app.

Included Features

  • Meeting SidePanel
  • RSC Permissions
  • Teams Themes handler

Interaction with Tab

mute-unmute

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.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Setup

Note these instructions are for running the sample on your local machine.

  1. 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

  2. Setup for Bot

Register your application with Azure AD

  • Register a new application in the Microsoft Entra ID – App Registrations portal.

  • On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.

  • Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the .env file.

  • In Azure portal, create a Azure Bot resource.

  • Ensure that you've enabled the Teams Channel

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  2. In the folder where repository is cloned navigate to samples/meetings-audio-state/nodejs

  3. Install node modules

    Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.

    npm install

  4. Update the .env with PORT=3978

  5. Run your app

    npm start

  6. This step is specific to Teams.

  • Edit the manifest.json contained in the appManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)

  • Edit the manifest.json for <<DOMAIN-NAME>> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.

  • Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

  • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)

  • Add the app to personal/team/groupChat scope (Supported scopes).

Note: RSC has been enabled post 1.11 hence this feature will not work below 1.12 (Manifest Version).

Running the sample

You can interact with Teams Tab meeting sidepanel.

  1. Select your app Install

Add your application to the meetings as its display as below. AddToMeeting

Configure

  1. Toggle To Mute Toggle button to mute state its looks like below. Stage 2

  2. Toggle To Unmute Toggle button to Unmute state it will unmute client audio. Stage 3

  3. Dark Theme App theme changes to dark when Teams theme switch to dark . Dark

  4. Light Theme App theme changes to light when Teams theme switch to light . Light

  5. Contrast Theme App theme changes to contrast when Teams theme switch to contrast . Contrast

Further reading