Extend RequestAppAudioHandling to support for audio device selection sync

[bingliang-zh]

Description

This is a continuous PR of the original PR by shilcare. There is another outdated PR from a fork here, change to this branch PR because of security issues.

Purpose

Give Teams apps the ability to use Teams' audio devices settings, like play audio on the device that user selected in Teams.

Details

Add a callback method to RequestAppAudioHandling.

• When App first call RequestAppAudioHandling with this callback, the callback will be called immediately with Teams' current audio device labels. The app can use this info to initialize and select the corresponding audio devices.
• This callback will also be called when user changes audio devices in Teams, app can update its audio devices accordingly.

Main changes in the PR:

1. add optional audioDeviceSelectionChangedCallback to RequestAppAudioHandlingParams which is used in meeting.requestAppAudioHandling
2. register event handler in startAppAudioHandling
3. unregister event handler in stopAppAudioHandling

Validation

Validation performed:

To make this work properly, we also need code changes in some internal repos. We have built a Teams container with those changes.

1. Use Teams 2.1 with the custom container
2. Create a test Teams app, add some test code like

  meeting.requestAppAudioHandling(
    {
      //...
      audioDeviceSelectionChangedCallback: (selectedDevices) => {
        console.log('audioDeviceSelectionChangedCallback');
        console.log(selectedDevices);
        return Promise.resolve();
      },
    },
   //...
  );

3. Replace an existing meeting app, redirect to the local test app
4. Open the modified meeting app.
5. The callback will be called after meeting.requestAppAudioHandling is called. And also get called after device is changed in Teams settings. The payload is correct too.

Unit Tests added:

Yes

End-to-end tests added:

requestAppAudioHandling API Call - register audioDeviceSelectionChanged Handler

Additional Requirements

Change file added:

No. pnpm changefile says No change files are needed.

Related PRs:

• Extend RequestAppAudioHandling to support for audio device selection sync #1931
• Extend RequestAppAudioHandling to support for audio device selection sync #2008

Next/remaining steps:

Close original PR because duplicated and outdated.
Close fork PR because duplicated and outdated.

[shrshindeMSFT]

LGTM just two minor comments.

[AE-MS]

🕐

[AE-MS]

Approved pending tests being fixed/passing

[shrshindeMSFT]

Will approve once the tests are passing

[bingliang-zh]

@shrshindeMSFT @KangxuanYe The PR for meta-os has been merged. All checks have passed. Mind take a look at this again? Thanks!

[shrshindeMSFT]

LGTM!