Merge branch 'qa' into prod-us7-ipaddress

100mslive · Nov 12, 2024 · a8bda8c · a8bda8c
2 parents beb6192 + 698fb6d
commit a8bda8c
Show file tree

Hide file tree

Showing 117 changed files with 308 additions and 136 deletions.
diff --git a/docs/api-reference/javascript/v2/classes/EventBus.md b/docs/api-reference/javascript/v2/classes/EventBus.md
@@ -71,6 +71,12 @@ nav: '3.2'
 
 ---
 
+### localAudioUnmutedNatively
+
+• `Readonly` **localAudioUnmutedNatively**: `HMSInternalEvent`<`unknown`\>
+
+---
+
 ### localRoleUpdate
 
 • `Readonly` **localRoleUpdate**: `HMSInternalEvent`<{ `newRole`: [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole) ; `oldRole`: [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole) }\>

diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioDeviceCategory.md b/docs/api-reference/javascript/v2/enums/HMSAudioDeviceCategory.md
@@ -0,0 +1,28 @@
+---
+title: HMSAudioDeviceCategory
+nav: '2.6'
+---
+
+## Enumeration Members
+
+### BLUETOOTH
+
+• **BLUETOOTH** = `"BLUETOOTH"`
+
+---
+
+### EARPIECE
+
+• **EARPIECE** = `"EARPIECE"`
+
+---
+
+### SPEAKERPHONE
+
+• **SPEAKERPHONE** = `"SPEAKERPHONE"`
+
+---
+
+### WIRED
+
+• **WIRED** = `"WIRED"`
diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioMode.md b/docs/api-reference/javascript/v2/enums/HMSAudioMode.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioMode
-nav: '2.6'
+nav: '2.7'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioPluginType.md b/docs/api-reference/javascript/v2/enums/HMSAudioPluginType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioPluginType
-nav: '2.7'
+nav: '2.8'
 ---
 
 Specifies the type of the plugin a transforming plugin will get an output audio node to give the resulting

diff --git a/docs/api-reference/javascript/v2/enums/HMSLogLevel.md b/docs/api-reference/javascript/v2/enums/HMSLogLevel.md
@@ -1,6 +1,6 @@
 ---
 title: HMSLogLevel
-nav: '2.8'
+nav: '2.9'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSNotificationSeverity.md b/docs/api-reference/javascript/v2/enums/HMSNotificationSeverity.md
@@ -1,6 +1,6 @@
 ---
 title: HMSNotificationSeverity
-nav: '2.9'
+nav: '2.10'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSNotificationTypes.md b/docs/api-reference/javascript/v2/enums/HMSNotificationTypes.md
@@ -1,6 +1,6 @@
 ---
 title: HMSNotificationTypes
-nav: '2.10'
+nav: '2.11'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPeerType.md b/docs/api-reference/javascript/v2/enums/HMSPeerType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPeerType
-nav: '2.11'
+nav: '2.12'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPlaylistType.md b/docs/api-reference/javascript/v2/enums/HMSPlaylistType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPlaylistType
-nav: '2.12'
+nav: '2.13'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPluginUnsupportedTypes.md b/docs/api-reference/javascript/v2/enums/HMSPluginUnsupportedTypes.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPluginUnsupportedTypes
-nav: '2.13'
+nav: '2.14'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPollQuestionType.md b/docs/api-reference/javascript/v2/enums/HMSPollQuestionType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPollQuestionType
-nav: '2.14'
+nav: '2.15'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPollStates.md b/docs/api-reference/javascript/v2/enums/HMSPollStates.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPollStates
-nav: '2.15'
+nav: '2.16'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSRecordingState.md b/docs/api-reference/javascript/v2/enums/HMSRecordingState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSRecordingState
-nav: '2.16'
+nav: '2.17'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSRoomState.md b/docs/api-reference/javascript/v2/enums/HMSRoomState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSRoomState
-nav: '2.17'
+nav: '2.18'
 ---
 
 Check out internal-docs/RoomStateFlow.tldr for flow of room state

diff --git a/docs/api-reference/javascript/v2/enums/HMSSimulcastLayer.md b/docs/api-reference/javascript/v2/enums/HMSSimulcastLayer.md
@@ -1,6 +1,6 @@
 ---
 title: HMSSimulcastLayer
-nav: '2.18'
+nav: '2.19'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSTrackExceptionTrackType.md b/docs/api-reference/javascript/v2/enums/HMSTrackExceptionTrackType.md
@@ -0,0 +1,28 @@
+---
+title: HMSTrackExceptionTrackType
+nav: '2.20'
+---
+
+## Enumeration Members
+
+### AUDIO
+
+• **AUDIO** = `"audio"`
+
+---
+
+### AUDIO_VIDEO
+
+• **AUDIO_VIDEO** = `"audio, video"`
+
+---
+
+### SCREEN
+
+• **SCREEN** = `"screen"`
+
+---
+
+### VIDEO
+
+• **VIDEO** = `"video"`
diff --git a/docs/api-reference/javascript/v2/enums/HMSTranscriptionMode.md b/docs/api-reference/javascript/v2/enums/HMSTranscriptionMode.md
@@ -1,6 +1,6 @@
 ---
 title: HMSTranscriptionMode
-nav: '2.19'
+nav: '2.21'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSTranscriptionState.md b/docs/api-reference/javascript/v2/enums/HMSTranscriptionState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSTranscriptionState
-nav: '2.20'
+nav: '2.22'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType.md b/docs/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSVideoPluginCanvasContextType
-nav: '2.21'
+nav: '2.23'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSVideoPluginType.md b/docs/api-reference/javascript/v2/enums/HMSVideoPluginType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSVideoPluginType
-nav: '2.22'
+nav: '2.24'
 ---
 
 Specifies the type of the plugin a transforming plugin will get an output canvas to give the resulting

diff --git a/docs/api-reference/javascript/v2/home/content.md b/docs/api-reference/javascript/v2/home/content.md
@@ -10,6 +10,7 @@ nav: '1.1'
 - [DomainCategory](/api-reference/javascript/v2/enums/DomainCategory)
 - [HLSPlaylistType](/api-reference/javascript/v2/enums/HLSPlaylistType)
 - [HLSStreamType](/api-reference/javascript/v2/enums/HLSStreamType)
+- [HMSAudioDeviceCategory](/api-reference/javascript/v2/enums/HMSAudioDeviceCategory)
 - [HMSAudioMode](/api-reference/javascript/v2/enums/HMSAudioMode)
 - [HMSAudioPluginType](/api-reference/javascript/v2/enums/HMSAudioPluginType)
 - [HMSLogLevel](/api-reference/javascript/v2/enums/HMSLogLevel)
@@ -23,6 +24,7 @@ nav: '1.1'
 - [HMSRecordingState](/api-reference/javascript/v2/enums/HMSRecordingState)
 - [HMSRoomState](/api-reference/javascript/v2/enums/HMSRoomState)
 - [HMSSimulcastLayer](/api-reference/javascript/v2/enums/HMSSimulcastLayer)
+- [HMSTrackExceptionTrackType](/api-reference/javascript/v2/enums/HMSTrackExceptionTrackType)
 - [HMSTranscriptionMode](/api-reference/javascript/v2/enums/HMSTranscriptionMode)
 - [HMSTranscriptionState](/api-reference/javascript/v2/enums/HMSTranscriptionState)
 - [HMSVideoPluginCanvasContextType](/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType)
@@ -43,6 +45,7 @@ nav: '1.1'
 ## Other Interfaces
 
 - [ConnectivityCheckResult](/api-reference/javascript/v2/interfaces/ConnectivityCheckResult)
+- [DebugInfo](/api-reference/javascript/v2/interfaces/DebugInfo)
 - [DeviceMap](/api-reference/javascript/v2/interfaces/DeviceMap)
 - [DiagnosticsRTCStats](/api-reference/javascript/v2/interfaces/DiagnosticsRTCStats)
 - [DiagnosticsRTCStatsReport](/api-reference/javascript/v2/interfaces/DiagnosticsRTCStatsReport)
@@ -116,6 +119,7 @@ nav: '1.1'
 - [HMSStatsStore](/api-reference/javascript/v2/interfaces/HMSStatsStore)
 - [HMSStatsStoreWrapper](/api-reference/javascript/v2/interfaces/HMSStatsStoreWrapper)
 - [HMSStore](/api-reference/javascript/v2/interfaces/HMSStore)
+- [HMSTrackException](/api-reference/javascript/v2/interfaces/HMSTrackException)
 - [HMSTrackNotification](/api-reference/javascript/v2/interfaces/HMSTrackNotification)
 - [HMSTrackStats](/api-reference/javascript/v2/interfaces/HMSTrackStats)
 - [HMSTranscriptionInfo](/api-reference/javascript/v2/interfaces/HMSTranscriptionInfo)
@@ -396,17 +400,17 @@ selfBrowser - the current browser tab is being shared
 
 ### getAudioDeviceCategory
 
-▸ **getAudioDeviceCategory**(`deviceLabel`): `"bluetooth"` \| `"speakerhone"` \| `"wired"` \| `"earpiece"` \| `"speakerphone"`
+▸ **getAudioDeviceCategory**(`deviceLabel?`): `HMSAudioDeviceCategory`
 
 #### Parameters
 
-| Name          | Type     |
-| :------------ | :------- |
-| `deviceLabel` | `string` |
+| Name           | Type     |
+| :------------- | :------- |
+| `deviceLabel?` | `string` |
 
 #### Returns
 
-`"bluetooth"` \| `"speakerhone"` \| `"wired"` \| `"earpiece"` \| `"speakerphone"`
+`HMSAudioDeviceCategory`
 
 ---
 

diff --git a/docs/api-reference/javascript/v2/interfaces/DebugInfo.md b/docs/api-reference/javascript/v2/interfaces/DebugInfo.md
@@ -0,0 +1,22 @@
+---
+title: DebugInfo
+nav: '4.2'
+---
+
+## Properties
+
+### enabledFlags
+
+• `Optional` **enabledFlags**: `string`[]
+
+---
+
+### initEndpoint
+
+• `Optional` **initEndpoint**: `string`
+
+---
+
+### websocketURL
+
+• `Optional` **websocketURL**: `string`
diff --git a/docs/api-reference/javascript/v2/interfaces/DeviceMap.md b/docs/api-reference/javascript/v2/interfaces/DeviceMap.md
@@ -1,6 +1,6 @@
 ---
 title: DeviceMap
-nav: '4.2'
+nav: '4.3'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/DiagnosticsRTCStats.md b/docs/api-reference/javascript/v2/interfaces/DiagnosticsRTCStats.md
@@ -1,6 +1,6 @@
 ---
 title: DiagnosticsRTCStats
-nav: '4.3'
+nav: '4.4'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/DiagnosticsRTCStatsReport.md b/docs/api-reference/javascript/v2/interfaces/DiagnosticsRTCStatsReport.md
@@ -1,6 +1,6 @@
 ---
 title: DiagnosticsRTCStatsReport
-nav: '4.4'
+nav: '4.5'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HLSConfig.md b/docs/api-reference/javascript/v2/interfaces/HLSConfig.md
@@ -1,6 +1,6 @@
 ---
 title: HLSConfig
-nav: '4.5'
+nav: '4.6'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HLSMeetingURLVariant.md b/docs/api-reference/javascript/v2/interfaces/HLSMeetingURLVariant.md
@@ -1,6 +1,6 @@
 ---
 title: HLSMeetingURLVariant
-nav: '4.6'
+nav: '4.7'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HLSVariant.md b/docs/api-reference/javascript/v2/interfaces/HLSVariant.md
@@ -1,6 +1,6 @@
 ---
 title: HLSVariant
-nav: '4.7'
+nav: '4.8'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSActions.md b/docs/api-reference/javascript/v2/interfaces/HMSActions.md
@@ -1,6 +1,6 @@
 ---
 title: HMSActions<T>
-nav: '4.8'
+nav: '4.9'
 ---
 
 The below interface defines our SDK API Surface for taking room related actions.

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSAudioPlugin.md b/docs/api-reference/javascript/v2/interfaces/HMSAudioPlugin.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioPlugin
-nav: '4.9'
+nav: '4.10'
 ---
 
 A plugin implementing this interface can be registered with HMSLocalAudioTrack to transform, process or

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSAudioTrack.md b/docs/api-reference/javascript/v2/interfaces/HMSAudioTrack.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioTrack
-nav: '4.10'
+nav: '4.11'
 ---
 
 ## Hierarchy

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSAudioTrackSettings.md b/docs/api-reference/javascript/v2/interfaces/HMSAudioTrackSettings.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioTrackSettings
-nav: '4.11'
+nav: '4.12'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateParams.md b/docs/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateParams.md
@@ -1,6 +1,6 @@
 ---
 title: HMSChangeMultiTrackStateParams
-nav: '4.12'
+nav: '4.13'
 ---
 
 ## Properties

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateRequest.md b/docs/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateRequest.md
@@ -1,6 +1,6 @@
 ---
 title: HMSChangeMultiTrackStateRequest
-nav: '4.13'
+nav: '4.14'
 ---
 
 ## Properties

diff --git a/...ference/javascript/v2/interfaces/HMSChangeMultiTrackStateRequestNotification.md b/...ference/javascript/v2/interfaces/HMSChangeMultiTrackStateRequestNotification.md
@@ -1,6 +1,6 @@
 ---
 title: HMSChangeMultiTrackStateRequestNotification
-nav: '4.14'
+nav: '4.15'
 ---
 
 ## Hierarchy

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSChangeTrackStateRequest.md b/docs/api-reference/javascript/v2/interfaces/HMSChangeTrackStateRequest.md
@@ -1,6 +1,6 @@
 ---
 title: HMSChangeTrackStateRequest
-nav: '4.15'
+nav: '4.16'
 ---
 
 ## Properties