## Enumerations - [HMSAudioPluginType](/api-reference/javascript/v2/enums/HMSAudioPluginType) - [HMSLogLevel](/api-reference/javascript/v2/enums/HMSLogLevel) - [HMSNotificationSeverity](/api-reference/javascript/v2/enums/HMSNotificationSeverity) - [HMSNotificationTypes](/api-reference/javascript/v2/enums/HMSNotificationTypes) - [HMSPlaylistType](/api-reference/javascript/v2/enums/HMSPlaylistType) - [HMSRoomState](/api-reference/javascript/v2/enums/HMSRoomState) - [HMSSimulcastLayer](/api-reference/javascript/v2/enums/HMSSimulcastLayer) - [HMSVideoPluginCanvasContextType](/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType) - [HMSVideoPluginType](/api-reference/javascript/v2/enums/HMSVideoPluginType) ## Classes - [HMSReactiveStore](/api-reference/javascript/v2/classes/HMSReactiveStore) ## Core Interfaces - [HMSActions](/api-reference/javascript/v2/interfaces/HMSActions) - [HMSNotifications](/api-reference/javascript/v2/interfaces/HMSNotifications) - [HMSStoreWrapper](/api-reference/javascript/v2/interfaces/HMSStoreWrapper) ## Other Interfaces - [DeviceMap](/api-reference/javascript/v2/interfaces/DeviceMap) - [HLSConfig](/api-reference/javascript/v2/interfaces/HLSConfig) - [HLSMeetingURLVariant](/api-reference/javascript/v2/interfaces/HLSMeetingURLVariant) - [HMSAudioTrackSettings](/api-reference/javascript/v2/interfaces/HMSAudioTrackSettings) - [HMSChangeMultiTrackStateParams](/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateParams) - [HMSChangeMultiTrackStateRequest](/api-reference/javascript/v2/interfaces/HMSChangeMultiTrackStateRequest) - [HMSChangeTrackStateRequest](/api-reference/javascript/v2/interfaces/HMSChangeTrackStateRequest) - [HMSConfig](/api-reference/javascript/v2/interfaces/HMSConfig) - [HMSConfigInitialSettings](/api-reference/javascript/v2/interfaces/HMSConfigInitialSettings) - [HMSDeviceChangeEvent](/api-reference/javascript/v2/interfaces/HMSDeviceChangeEvent) - [HMSException](/api-reference/javascript/v2/interfaces/HMSException) - [HMSLeaveRoomRequest](/api-reference/javascript/v2/interfaces/HMSLeaveRoomRequest) - [HMSLocalTrackStats](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats) - [HMSMediaSettings](/api-reference/javascript/v2/interfaces/HMSMediaSettings) - [HMSMessage](/api-reference/javascript/v2/interfaces/HMSMessage) - [HMSNotification](/api-reference/javascript/v2/interfaces/HMSNotification) - [HMSPeer](/api-reference/javascript/v2/interfaces/HMSPeer) - [HMSPeerStats](/api-reference/javascript/v2/interfaces/HMSPeerStats) - [HMSPeerWithMuteStatus](/api-reference/javascript/v2/interfaces/HMSPeerWithMuteStatus) - [HMSPlaylist](/api-reference/javascript/v2/interfaces/HMSPlaylist) - [HMSPlaylistItem](/api-reference/javascript/v2/interfaces/HMSPlaylistItem) - [HMSPlaylistSelection](/api-reference/javascript/v2/interfaces/HMSPlaylistSelection) - [HMSPlaylistSelector](/api-reference/javascript/v2/interfaces/HMSPlaylistSelector) - [HMSPublishAllowed](/api-reference/javascript/v2/interfaces/HMSPublishAllowed) - [HMSRTMP](/api-reference/javascript/v2/interfaces/HMSRTMP) - [HMSRecording](/api-reference/javascript/v2/interfaces/HMSRecording) - [HMSRemoteTrackStats](/api-reference/javascript/v2/interfaces/HMSRemoteTrackStats) - [HMSRole](/api-reference/javascript/v2/interfaces/HMSRole) - [HMSRoleChangeRequest](/api-reference/javascript/v2/interfaces/HMSRoleChangeRequest) - [HMSRoleChangeStoreRequest](/api-reference/javascript/v2/interfaces/HMSRoleChangeStoreRequest) - [HMSRoom](/api-reference/javascript/v2/interfaces/HMSRoom) - [HMSSpeaker](/api-reference/javascript/v2/interfaces/HMSSpeaker) - [HMSStatsStore](/api-reference/javascript/v2/interfaces/HMSStatsStore) - [HMSStatsStoreWrapper](/api-reference/javascript/v2/interfaces/HMSStatsStoreWrapper) - [HMSStore](/api-reference/javascript/v2/interfaces/HMSStore) - [HMSTrack](/api-reference/javascript/v2/interfaces/HMSTrack) - [HMSTrackStats](/api-reference/javascript/v2/interfaces/HMSTrackStats) - [HMSVideoTrackSettings](/api-reference/javascript/v2/interfaces/HMSVideoTrackSettings) - [IHMSPlaylistActions](/api-reference/javascript/v2/interfaces/IHMSPlaylistActions) - [IHMSStatsStore](/api-reference/javascript/v2/interfaces/IHMSStatsStore) - [IHMSStore](/api-reference/javascript/v2/interfaces/IHMSStore) - [RTMPRecordingConfig](/api-reference/javascript/v2/interfaces/RTMPRecordingConfig) - [SimulcastLayerDefinition](/api-reference/javascript/v2/interfaces/SimulcastLayerDefinition) ## Type aliases ### HMSMessageID Ƭ **HMSMessageID**: `string` --- ### HMSNotificationCallback Ƭ **HMSNotificationCallback**: (`notification`: [`HMSNotification`](/api-reference/javascript/v2/interfaces/HMSNotification)) => `void` #### Type declaration ▸ (`notification`): `void` ##### Parameters | Name | Type | | :------------- | :--------------------------------------------------------------------------- | | `notification` | [`HMSNotification`](/api-reference/javascript/v2/interfaces/HMSNotification) | ##### Returns `void` --- ### HMSPeerID Ƭ **HMSPeerID**: `string` --- ### HMSRoleName Ƭ **HMSRoleName**: `string` --- ### HMSRoomID Ƭ **HMSRoomID**: `string` --- ### HMSTrackDisplaySurface Ƭ **HMSTrackDisplaySurface**: `"application"` \| `"browser"` \| `"monitor"` \| `"window"` --- ### HMSTrackID Ƭ **HMSTrackID**: `string` --- ### HMSTrackSource Ƭ **HMSTrackSource**: `"regular"` \| `"screen"` \| `"plugin"` \| `"audioplaylist"` \| `"videoplaylist"` \| `string` --- ### HMSTrackType Ƭ **HMSTrackType**: `"audio"` \| `"video"` ## Variables ### parsedUserAgent • `Const` **parsedUserAgent**: `UAParserInstance` --- ### selectAudioPlaylist • `Const` **selectAudioPlaylist**: [`HMSPlaylistSelector`](/api-reference/javascript/v2/interfaces/HMSPlaylistSelector) --- ### selectAvailableRoleNames • `Const` **selectAvailableRoleNames**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`[], (`res`: `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\>) => `string`[]\> Select an array of names of available roles in the room. --- ### selectBroadcastMessages • `Const` **selectBroadcastMessages**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[], (`res`: [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]) => [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> --- ### selectBroadcastMessagesUnreadCount • `Const` **selectBroadcastMessagesUnreadCount**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`, (`res`: [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]) => `number`\> --- ### selectDegradedTracks • `Const` **selectDegradedTracks**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)[], (`res`: [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)[]) => [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)[]\> Select an array of tracks that have been degraded(receiving lower video quality/no video) due to bad network locally. --- ### selectDominantSpeaker • `Const` **selectDominantSpeaker**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSSpeaker`](/api-reference/javascript/v2/interfaces/HMSSpeaker)\>) => `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Select the peer who's speaking the loudest at the moment --- ### selectHLSState • `Const` **selectHLSState**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `HMSHLS`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `HMSHLS`\> --- ### selectHMSMessages • `Const` **selectHMSMessages**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[], (`res1`: `string`[], `res2`: `Record`<`string`, [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)\>) => [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> Select an array of messages in the room(sent and received). --- ### selectHMSMessagesCount • `Const` **selectHMSMessagesCount**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`, (`res`: `string`[]) => `number`\> Select the number of messages(sent and received). --- ### selectHMSStats • `Const` **selectHMSStats**: `Object` #### Type declaration | Name | Type | | :--------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `availablePublishBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `availableSubscribeBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `bitrateByTrackID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`\> | | `bytesReceivedByTrackID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`\> | | `framerateByTrackID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`\> | | `jitter` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `jitterByTrackID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`\> | | `localAudioTrackBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `number`\> | | `localAudioTrackBytesSent` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `number`\> | | `localAudioTrackStats` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats), (`res1`: `Record`<`string`, `undefined` \| [`HMSTrackStats`](/api-reference/javascript/v2/interfaces/HMSTrackStats)\>, `res2`: `undefined` \| `string`) => `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)\> | | `localPeerStats` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats), (`res1`: `Record`<`string`, `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)\>, `res2`: `string`) => `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)\> | | `localVideoTrackBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `number`\> | | `localVideoTrackBytesSent` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `number`\> | | `localVideoTrackFramerate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `number`\> | | `localVideoTrackQualityLimitationReason` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `string`, (`res`: `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)) => `undefined` \| `string`\> | | `localVideoTrackStats` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats), (`res1`: `Record`<`string`, `undefined` \| [`HMSTrackStats`](/api-reference/javascript/v2/interfaces/HMSTrackStats)\>, `res2`: `undefined` \| `string`) => `undefined` \| [`HMSLocalTrackStats`](/api-reference/javascript/v2/interfaces/HMSLocalTrackStats)\> | | `packetsLost` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `packetsLostByTrackID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`\> | | `peerStatsByID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)\> | | `publishBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `subscribeBitrate` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `totalBytesReceived` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `totalBytesSent` | `OutputSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| `number`, (`res`: `undefined` \| [`HMSPeerStats`](/api-reference/javascript/v2/interfaces/HMSPeerStats)) => `undefined` \| `number`\> | | `trackStatsByID` | (`id?`: `string`) => `StoreSelector`<[`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore), `undefined` \| [`HMSTrackStats`](/api-reference/javascript/v2/interfaces/HMSTrackStats)\> | --- ### selectIsAllowedToPublish • `Const` **selectIsAllowedToPublish**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPublishAllowed`](/api-reference/javascript/v2/interfaces/HMSPublishAllowed), (`res`: `null` \| [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)) => [`HMSPublishAllowed`](/api-reference/javascript/v2/interfaces/HMSPublishAllowed)\> Select what streams is the local peer allowed to publish from video, audio and screenshare. --- ### selectIsAllowedToSubscribe • `Const` **selectIsAllowedToSubscribe**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `null` \| [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)) => `boolean`\> Select a boolean denoting whether if your local peer is allowed to subscribe to any other role. --- ### selectIsConnectedToRoom • `Const` **selectIsConnectedToRoom**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `undefined` \| `boolean`\> Select a boolean flag denoting whether you've joined a room. NOTE: Returns true only after join, returns false during preview. --- ### selectIsInPreview • `Const` **selectIsInPreview**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: [`HMSRoomState`](/api-reference/javascript/v2/enums/HMSRoomState)) => `boolean`\> Select a boolean denoting whether the room is in Preview state. --- ### selectIsLocalScreenShared • `Const` **selectIsLocalScreenShared**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res1`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => `boolean`\> Select a boolean denoting whether your screen is shared to remote peers in the room. --- ### selectIsSomeoneScreenSharing • `Const` **selectIsSomeoneScreenSharing**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `boolean`\> Select a boolean denoting whether someone is sharing screen in the room. --- ### selectLocalAudioTrackID • `Const` **selectLocalAudioTrackID**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`, (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `undefined` \| `string`\> Select the track ID of your local peer's primary audio track --- ### selectLocalPeer • `Const` **selectLocalPeer**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom), `res2`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Select the local peer object object assigned to you. --- ### selectLocalPeerID • `Const` **selectLocalPeerID**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `string`\> Select the peer ID of your local peer. --- ### selectLocalPeerName • `Const` **selectLocalPeerName**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`, (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `string`\> Select the peer name of your local peer. --- ### selectLocalPeerRole • `Const` **selectLocalPeerRole**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole), (`res1`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), `res2`: `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\>) => `null` \| [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\> Select the [HMSRole](/api-reference/javascript/v2/interfaces/HMSRole) object of your local peer. --- ### selectLocalPeerRoleName • `Const` **selectLocalPeerRoleName**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`, (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `undefined` \| `string`\> Select the role name of your local peer. --- ### selectLocalTrackIDs • `Const` **selectLocalTrackIDs**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`[], (`res1`: `undefined` \| `string`, `res2`: `undefined` \| `string`, `res3`: `string`[]) => `string`[]\> Select an array of track IDs of all your local peer's tracks --- ### selectLocalVideoTrackID • `Const` **selectLocalVideoTrackID**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`, (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `undefined` \| `string`\> Select the track ID of your local peer's primary video track --- ### selectPeerCount • `Const` **selectPeerCount**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`, (`res1`: `undefined` \| `boolean`, `res2`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `number`\> selectPeerCount gives the number of peers Inside the room. This doesn't count the local peer if they're still in preview and haven't yet joined the room. Note that this will not necessarily equal the number of peers received through selectPeers, it's possible to know total number of people in the room without having details of everyone depending on dashboard settings. --- ### selectPeerScreenSharing • `Const` **selectPeerScreenSharing**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Select the first peer who is currently sharing their screen. --- ### selectPeerSharingAudio • `Const` **selectPeerSharingAudio**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Select the first peer who is currently sharing their audio only screen --- ### selectPeerSharingAudioPlaylist • `Const` **selectPeerSharingAudioPlaylist**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> --- ### selectPeerSharingVideoPlaylist • `Const` **selectPeerSharingVideoPlaylist**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> --- ### selectPeers • `Const` **selectPeers**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res1`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom), `res2`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> Select an array of peers(remote peers and your local peer) present in the room. --- ### selectPeersScreenSharing • `Const` **selectPeersScreenSharing**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> Select an array of peers who are currently sharing their screen. --- ### selectPeersWithAudioStatus • `Const` **selectPeersWithAudioStatus**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeerWithMuteStatus`](/api-reference/javascript/v2/interfaces/HMSPeerWithMuteStatus)[], (`res1`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res2`: `Record`<`string`, [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>) => [`HMSPeerWithMuteStatus`](/api-reference/javascript/v2/interfaces/HMSPeerWithMuteStatus)[]\> --- ### selectPermissions • `Const` **selectPermissions**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| { `changeRole`: `boolean` ; `endRoom`: `boolean` ; `mute`: `boolean` ; `recording`: `boolean` ; `removeOthers`: `boolean` ; `streaming`: `boolean` ; `unmute`: `boolean` }, (`res`: `null` \| [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)) => `undefined` \| { `changeRole`: `boolean` ; `endRoom`: `boolean` ; `mute`: `boolean` ; `recording`: `boolean` ; `removeOthers`: `boolean` ; `streaming`: `boolean` ; `unmute`: `boolean` }\> Select the permissions which determine what actions the local peer can do. --- ### selectRTMPState • `Const` **selectRTMPState**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSRTMP`](/api-reference/javascript/v2/interfaces/HMSRTMP), (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => [`HMSRTMP`](/api-reference/javascript/v2/interfaces/HMSRTMP)\> --- ### selectRecordingState • `Const` **selectRecordingState**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSRecording`](/api-reference/javascript/v2/interfaces/HMSRecording), (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => [`HMSRecording`](/api-reference/javascript/v2/interfaces/HMSRecording)\> --- ### selectRemotePeers • `Const` **selectRemotePeers**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> Select remote peers(other users you're connected with via the internet) present in the room. --- ### selectRoleChangeRequest • `Const` **selectRoleChangeRequest**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSRoleChangeRequest`](/api-reference/javascript/v2/interfaces/HMSRoleChangeRequest), (`res1`: [`HMSRoleChangeStoreRequest`](/api-reference/javascript/v2/interfaces/HMSRoleChangeStoreRequest), `res2`: `Record`<`string`, [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\>, `res3`: `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\>) => `null` \| [`HMSRoleChangeRequest`](/api-reference/javascript/v2/interfaces/HMSRoleChangeRequest)\> Select the role change request received for your local peer. --- ### selectRoomID • `Const` **selectRoomID**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `string`\> Select the ID of the current room to which you are connected. --- ### selectRoomStartTime • `Const` **selectRoomStartTime**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `Date`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `undefined` \| `Date`\> --- ### selectRoomStarted • `Const` **selectRoomStarted**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `boolean`\> --- ### selectRoomState • `Const` **selectRoomState**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSRoomState`](/api-reference/javascript/v2/enums/HMSRoomState), (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => [`HMSRoomState`](/api-reference/javascript/v2/enums/HMSRoomState)\> Select the current state of the room. --- ### selectSessionId • `Const` **selectSessionId**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `string`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `string`\> --- ### selectUnreadHMSMessagesCount • `Const` **selectUnreadHMSMessagesCount**: `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`, (`res`: `Record`<`string`, [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)\>) => `number`\> Select the number of unread messages. --- ### selectVideoPlaylist • `Const` **selectVideoPlaylist**: [`HMSPlaylistSelector`](/api-reference/javascript/v2/interfaces/HMSPlaylistSelector) ## Functions ### createDefaultStatsStore ▸ **createDefaultStatsStore**(): [`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore) #### Returns [`HMSStatsStore`](/api-reference/javascript/v2/interfaces/HMSStatsStore) --- ### selectAppData ▸ **selectAppData**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `any`\> Select a particular key from ui app data by passed in key. if key is not passed, full data is returned. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `any`\> --- ### selectAudioPlaylistTrackByPeerID ▸ **selectAudioPlaylistTrackByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectAudioTrackByPeerID ▸ **selectAudioTrackByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the primary audio track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectAudioTrackVolume ▸ **selectAudioTrackVolume**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> Select the local audio volume of an audio track given a track ID. NOTE: **Volume** of a track is different from **Audio Level** of a track, - Audio Level measures the audio of a track and it comes from 100ms's servers. - Volume is how loud you hear the audio of a track, this is controlled by you at the client side. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> --- ### selectAudioVolumeByPeerID ▸ **selectAudioVolumeByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> Select the local audio volume of the primary audio track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> --- ### selectAuxiliaryAudioByPeerID ▸ **selectAuxiliaryAudioByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the first auxiliary audio track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectAuxiliaryTracksByPeerID ▸ **selectAuxiliaryTracksByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)[]\> Select an array of auxiliary tracks of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)[]\> --- ### selectCameraStreamByPeerID ▸ **selectCameraStreamByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the camera stream of a peer given a peer ID. This is the primary video track of a peer. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectConnectionQualities ▸ **selectConnectionQualities**(`store`): `Record`<`string`, `HMSConnectionQuality`\> #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `Record`<`string`, `HMSConnectionQuality`\> --- ### selectConnectionQualityByPeerID ▸ **selectConnectionQualityByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `HMSConnectionQuality`\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `HMSConnectionQuality`\> --- ### selectDevices ▸ **selectDevices**(`store`): [`DeviceMap`](/api-reference/javascript/v2/interfaces/DeviceMap) Select the available audio input, audio output and video input devices on your machine. #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns [`DeviceMap`](/api-reference/javascript/v2/interfaces/DeviceMap) An object of array of available audio input, audio output and video input devices. ``` type DeviceMap = { audioInput: InputDeviceInfo[]; audioOutput: MediaDeviceInfo[]; videoInput: InputDeviceInfo[]; } ``` --- ### selectDidIJoinWithin ▸ **selectDidIJoinWithin**(`timeMs`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `undefined` \| `boolean`\> Returns a boolean to indicate if the local peer joined within the past `timeMs` milliseconds. Ex: to know if the local peer joined within the last one second ```js const joinedWithinASecond = useHMSStore(selectDidIJoinWithin(1000)); ``` #### Parameters | Name | Type | | :------- | :------- | | `timeMs` | `number` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`, (`res`: [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom)) => `undefined` \| `boolean`\> --- ### selectIsAudioLocallyMuted ▸ **selectIsAudioLocallyMuted**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> Select a boolean denoting whether you've muted an audio track locally(only for you) given a track ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> --- ### selectIsLocalAudioEnabled ▸ **selectIsLocalAudioEnabled**(`store`): `boolean` Select a boolean denoting whether your local audio is unmuted and the audio from your microphone is shared to remote peers #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `boolean` --- ### selectIsLocalAudioPluginPresent ▸ **selectIsLocalAudioPluginPresent**(`pluginName`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `string`[]) => `boolean`\> #### Parameters | Name | Type | | :----------- | :------- | | `pluginName` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `string`[]) => `boolean`\> --- ### selectIsLocalVideoDisplayEnabled ▸ **selectIsLocalVideoDisplayEnabled**(`store`): `undefined` \| `boolean` Select a boolean denoting whether you've chosen to unmute and share your local video. NOTE: Once you call `hmsActions.setLocalVideoEnabled(true)`to unmute your local video, it takes some time to fetch your video from your video source. This displayEnabled property gives immediate feedback for a more interactive UI, without waiting for the video source #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `undefined` \| `boolean` --- ### selectIsLocalVideoEnabled ▸ **selectIsLocalVideoEnabled**(`store`): `boolean` Select a boolean denoting whether your local video is unmuted and the video from your camera is shared to remote peers #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `boolean` --- ### selectIsLocalVideoPluginPresent ▸ **selectIsLocalVideoPluginPresent**(`pluginName`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `string`[]) => `boolean`\> #### Parameters | Name | Type | | :----------- | :------- | | `pluginName` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`, (`res`: `string`[]) => `boolean`\> --- ### selectIsLocallyMutedByPeerID ▸ **selectIsLocallyMutedByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> Select a boolean denoting whether you've muted the primary audio track of a peer locally(only for you) given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> --- ### selectIsPeerAudioEnabled ▸ **selectIsPeerAudioEnabled**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`\> Select a boolean denoting whether a peer has unmuted audio and sharing it to other peers. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`\> --- ### selectIsPeerVideoEnabled ▸ **selectIsPeerVideoEnabled**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`\> Select a boolean denoting whether a peer has unmuted video and sharing it to other peers. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `boolean`\> --- ### selectIsScreenShareLocallyMutedByPeerID ▸ **selectIsScreenShareLocallyMutedByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> Select a boolean denoting whether you've muted the screen share audio track of a peer locally(only for you) given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `boolean`\> --- ### selectLocalMediaSettings ▸ **selectLocalMediaSettings**(`store`): [`HMSMediaSettings`](/api-reference/javascript/v2/interfaces/HMSMediaSettings) Select your media settings i.e., choosen audio input device, audio output device and video input device. #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns [`HMSMediaSettings`](/api-reference/javascript/v2/interfaces/HMSMediaSettings) --- ### selectMessageIDsInOrder ▸ **selectMessageIDsInOrder**(`store`): `string`[] Select IDs of messages you've sent or received sorted chronologically. #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `string`[] --- ### selectMessagesByPeerID ▸ **selectMessagesByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> --- ### selectMessagesByRole ▸ **selectMessagesByRole**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSMessage`](/api-reference/javascript/v2/interfaces/HMSMessage)[]\> --- ### selectMessagesUnreadCountByPeerID ▸ **selectMessagesUnreadCountByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> --- ### selectMessagesUnreadCountByRole ▸ **selectMessagesUnreadCountByRole**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> --- ### selectPeerAudioByID ▸ **selectPeerAudioByID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> Select audio level of audioTrack of a peer given a peer IDß. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> --- ### selectPeerByCondition ▸ **selectPeerByCondition**(`predicate`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Selects the first peer passing the condition given by the argument predicate function Ex: to select a peer whose metadata has spotlight set to true(assuming peer.metadata is a valid json string), use ```js const spotlightPeer = useHMSStore(selectPeerByCondition(peer => JSON.parse(peer.metadata).spotlight)); ``` #### Parameters | Name | Type | | :---------- | :---------------------------------------------------------------------------------- | | `predicate` | (`peer`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `boolean` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer), (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => `undefined` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> --- ### selectPeerByID ▸ **selectPeerByID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> Select the [HMSPeer](/api-reference/javascript/v2/interfaces/HMSPeer) object given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)\> --- ### selectPeerMetadata ▸ **selectPeerMetadata**(`peerId`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `any`, (`res`: `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `any`\> Selects the peer metadata for the passed in peer and returns it as JSON. If metadata is not present or conversion to JSON gives an error, an empty object is returned. Please directly use peer.metadata in case the metadata is not JSON by design. #### Parameters | Name | Type | | :------- | :------- | | `peerId` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `any`, (`res`: `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `any`\> --- ### selectPeerName ▸ **selectPeerName**(`peerId`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`, (`res`: `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `undefined` \| `string`\> #### Parameters | Name | Type | | :------- | :------- | | `peerId` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`, (`res`: `null` \| [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `undefined` \| `string`\> --- ### selectPeerNameByID ▸ **selectPeerNameByID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`\> Select the name of a [HMSPeer](/api-reference/javascript/v2/interfaces/HMSPeer) given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `string`\> --- ### selectPeersByCondition ▸ **selectPeersByCondition**(`predicate`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> Selects all peers passing the condition given by the argument predicate function Ex: to select peers with isHandRaised set to true in their metadata(assuming peer.metadata is a valid json string), use ```js const handRaisedPeers = useHMSStore(selectPeersByCondition(peer => JSON.parse(peer.metadata).isHandRaised)); ``` #### Parameters | Name | Type | | :---------- | :---------------------------------------------------------------------------------- | | `predicate` | (`peer`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)) => `boolean` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> --- ### selectPeersByRole ▸ **selectPeersByRole**(`role`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> Select an array of peers of a particular role #### Parameters | Name | Type | Description | | :----- | :------- | :---------- | | `role` | `string` | HMSRoleName | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[], (`res`: [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]) => [`HMSPeer`](/api-reference/javascript/v2/interfaces/HMSPeer)[]\> HMSPeer[] --- ### selectRoleByRoleName ▸ **selectRoleByRoleName**(`roleName`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole), (`res`: `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\>) => [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\> #### Parameters | Name | Type | | :--------- | :------- | | `roleName` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole), (`res`: `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\>) => [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\> --- ### selectRolesMap ▸ **selectRolesMap**(`store`): `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\> Select available roles in the room as a map between the role name and [HMSRole](/api-reference/javascript/v2/interfaces/HMSRole) object. #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `Record`<`string`, [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole)\> --- ### selectRoom ▸ **selectRoom**(`store`): [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom) Select the current [HMSRoom](/api-reference/javascript/v2/interfaces/HMSRoom) object to which you are connected. #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns [`HMSRoom`](/api-reference/javascript/v2/interfaces/HMSRoom) --- ### selectScreenShareAudioByPeerID ▸ **selectScreenShareAudioByPeerID**(`id?`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack), (`res`: { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }) => `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the screen share audio track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack), (`res`: { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }) => `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectScreenShareByPeerID ▸ **selectScreenShareByPeerID**(`id?`): `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack), (`res`: { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }) => `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the screen share video track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `OutputSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack), (`res`: { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }) => `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectScreenSharesByPeerId ▸ **selectScreenSharesByPeerId**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), { `audio`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = audioTrack; `video`: `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack) = videoTrack }\> --- ### selectScreenshareAudioVolumeByPeerID ▸ **selectScreenshareAudioVolumeByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> Select the local audio volume of the screen share of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| `number`\> --- ### selectSimulcastLayerByTrack ▸ **selectSimulcastLayerByTrack**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSSimulcastLayer`](/api-reference/javascript/v2/enums/HMSSimulcastLayer)\> Select the current simulcast layer of a track given a track ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSSimulcastLayer`](/api-reference/javascript/v2/enums/HMSSimulcastLayer)\> --- ### selectSpeakers ▸ **selectSpeakers**(`store`): `Record`<`string`, [`HMSSpeaker`](/api-reference/javascript/v2/interfaces/HMSSpeaker)\> #### Parameters | Name | Type | | :------ | :------------------------------------------------------------- | | `store` | [`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore) | #### Returns `Record`<`string`, [`HMSSpeaker`](/api-reference/javascript/v2/interfaces/HMSSpeaker)\> --- ### selectTrackAudioByID ▸ **selectTrackAudioByID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> Select the audio level of a track given a track ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `number`\> --- ### selectTrackByID ▸ **selectTrackByID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the [HMSTrack](/api-reference/javascript/v2/interfaces/HMSTrack) object given a track ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `null` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectVideoPlaylistAudioTrackByPeerID ▸ **selectVideoPlaylistAudioTrackByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectVideoPlaylistVideoTrackByPeerID ▸ **selectVideoPlaylistVideoTrackByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> --- ### selectVideoTrackByPeerID ▸ **selectVideoTrackByPeerID**(`id?`): `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\> Select the primary video track of a peer given a peer ID. #### Parameters | Name | Type | | :---- | :------- | | `id?` | `string` | #### Returns `StoreSelector`<[`HMSStore`](/api-reference/javascript/v2/interfaces/HMSStore), `undefined` \| [`HMSTrack`](/api-reference/javascript/v2/interfaces/HMSTrack)\>

HMSPerformanceStats

Properties

memory

battery

Methods

init

init