@microsoft/teams-js 2.17.1-beta.2 → 2.18.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.17.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.18.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.17.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-xp55t/129OsN192JZYLP0rGhzjCF9aYtjY0LVtXvolkDrBe4Jchylp56NrUYJ4S2"
+  src="https://res.cdn.office.net/teams-js/2.18.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-g8DoRkiR0ECQ9rwKIgY8GjQ5h0d2jp1347CmU/IRlyUHPjJZiFWEOYc+hFtT9MGL"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.17.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.18.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -3690,6 +3690,7 @@ export interface SdkError {
          */
         message?: string;
 }
+export function isSdkError(err: unknown): err is SdkError;
 /** Error codes used to identify different types of errors that can occur while developing apps. */
 export enum ErrorCode {
         /**
@@ -6484,6 +6485,51 @@ export namespace meeting {
                     * @returns A promise with the updated microphone state
                     */
                 micMuteStateChangedCallback: (micState: MicState) => Promise<MicState>;
+                /**
+                    * Callback for the host to tell the app to change its speaker selection
+                    */
+                audioDeviceSelectionChangedCallback?: (selectedDevices: AudioDeviceSelection | SdkError) => void;
+        }
+        /**
+            * Interface for AudioDeviceSelection from host selection.
+            * If the speaker or the microphone is undefined or don't have a device label, you can try to find the default devices
+            * by using
+            * ```ts
+            * const devices = await navigator.mediaDevices.enumerateDevices();
+            * const defaultSpeaker = devices.find((d) => d.deviceId === 'default' && d.kind === 'audiooutput');
+            * const defaultMic = devices.find((d) => d.deviceId === 'default' && d.kind === 'audioinput');
+            * ```
+            *
+            * @hidden
+            * Hide from docs.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @beta
+            */
+        interface AudioDeviceSelection {
+                speaker?: AudioDeviceInfo;
+                microphone?: AudioDeviceInfo;
+        }
+        /**
+            * Interface for AudioDeviceInfo, includes a device label with the same format as {@link MediaDeviceInfo.label}
+            *
+            * Hosted app can use this label to compare it with the device info fetched from {@link navigator.mediaDevices.enumerateDevices()}.
+            * {@link MediaDeviceInfo} has  {@link MediaDeviceInfo.deviceId} as an unique identifier, but that id is also unique to the origin
+            * of the calling application, so {@link MediaDeviceInfo.deviceId} cannot be used here as an identifier. Notice there are some cases
+            * that devices may have the same device label, but we don't have a better way to solve this, keep this as a known limitation for now.
+            *
+            * @hidden
+            * Hide from docs.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @beta
+            */
+        interface AudioDeviceInfo {
+                deviceLabel: string;
         }
         /**
             * Different types of meeting reactions that can be sent/received

package/dist/MicrosoftTeams.js

@@ -1371,6 +1371,9 @@ var SecondaryM365ContentIdName;
     /** User ID */
     SecondaryM365ContentIdName["UserId"] = "userId";
 })(SecondaryM365ContentIdName || (SecondaryM365ContentIdName = {}));
+function isSdkError(err) {
+    return (err === null || err === void 0 ? void 0 : err.errorCode) !== undefined;
+}
 /** Error codes used to identify different types of errors that can occur while developing apps. */
 var ErrorCode;
 (function (ErrorCode) {
@@ -2428,7 +2431,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.17.1-beta.2";
+var version = "2.18.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -8362,6 +8365,11 @@ var meeting;
                 });
             }); };
             registerHandler('meeting.micStateChanged', micStateChangedCallback);
+            var audioDeviceSelectionChangedCallback = function (selectedDevicesInHost) {
+                var _a;
+                (_a = requestAppAudioHandlingParams.audioDeviceSelectionChangedCallback) === null || _a === void 0 ? void 0 : _a.call(requestAppAudioHandlingParams, selectedDevicesInHost);
+            };
+            registerHandler('meeting.audioDeviceSelectionChanged', audioDeviceSelectionChangedCallback);
             callback(isHostAudioless);
         };
         sendMessageToParent('meeting.requestAppAudioHandling', [requestAppAudioHandlingParams.isAppHandlingAudio], callbackInternalRequest);
@@ -8380,6 +8388,9 @@ var meeting;
             if (doesHandlerExist('meeting.micStateChanged')) {
                 removeHandler('meeting.micStateChanged');
             }
+            if (doesHandlerExist('meeting.audioDeviceSelectionChanged')) {
+                removeHandler('meeting.audioDeviceSelectionChanged');
+            }
             callback(isHostAudioless);
         };
         sendMessageToParent('meeting.requestAppAudioHandling', [requestAppAudioHandlingParams.isAppHandlingAudio], callbackInternalStop);