100mslive/hms-video-store

Enumerations

Classes

Core Interfaces

Other Interfaces

Type aliases

DeviceMap

Ƭ DeviceMap: Omit<HMSDeviceManager, "outputDevice">


HMSMessageID

Ƭ HMSMessageID: string


HMSPeerID

Ƭ HMSPeerID: string


HMSRoleName

Ƭ HMSRoleName: string


HMSRoomID

Ƭ HMSRoomID: string


HMSTrackID

Ƭ HMSTrackID: string


HMSTrackSource

Ƭ HMSTrackSource: "regular" | "screen" | "plugin"


HMSTrackType

Ƭ HMSTrackType: "audio" | "video"

Variables

selectAvailableRoleNames

Const selectAvailableRoleNames: OutputSelector<HMSStore, string[], fn> Select an array of names of available roles in the room.


selectBroadcastMessages

Const selectBroadcastMessages: OutputSelector<HMSStore, HMSMessage[], fn>


selectBroadcastMessagesUnreadCount

Const selectBroadcastMessagesUnreadCount: OutputSelector<HMSStore, number, fn>


selectDegradedTracks

Const selectDegradedTracks: OutputSelector<HMSStore, HMSTrack[], fn> 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, null | HMSPeer, fn> Select the peer who's speaking the loudest at the moment


selectHMSMessages

Const selectHMSMessages: OutputSelector<HMSStore, HMSMessage[], fn> Select an array of messages in the room(sent and received).


selectHMSMessagesCount

Const selectHMSMessagesCount: OutputSelector<HMSStore, number, fn> Select the number of messages(sent and received).


selectIsAllowedToPublish

Const selectIsAllowedToPublish: OutputSelector<HMSStore, HMSPublishAllowed, fn> Select what streams is the local peer allowed to publish from video, audio and screenshare.


selectIsAllowedToSubscribe

Const selectIsAllowedToSubscribe: OutputSelector<HMSStore, boolean, fn> Select a boolean denoting whether if your local peer is allowed to subscribe to any other role.


selectIsConnectedToRoom

Const selectIsConnectedToRoom: OutputSelector<HMSStore, undefined | boolean, fn> 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, boolean, fn> Select a boolean denoting whether the room is in Preview state.


selectLocalAudioTrackID

Const selectLocalAudioTrackID: OutputSelector<HMSStore, undefined | string, fn> Select the track ID of your local peer's primary audio track


selectLocalPeer

Const selectLocalPeer: OutputSelector<HMSStore, HMSPeer, fn> Select the local peer object object assigned to you.


selectLocalPeerID

Const selectLocalPeerID: OutputSelector<HMSStore, string, fn> Select the peer ID of your local peer.


selectLocalPeerRole

Const selectLocalPeerRole: OutputSelector<HMSStore, null | HMSRole, fn> Select the HMSRole object of your local peer.


selectLocalTrackIDs

Const selectLocalTrackIDs: OutputSelector<HMSStore, string[], fn> Select an array of track IDs of all your local peer's tracks


selectLocalVideoTrackID

Const selectLocalVideoTrackID: OutputSelector<HMSStore, undefined | string, fn> Select the track ID of your local peer's primary video track


selectPeers

Const selectPeers: OutputSelector<HMSStore, HMSPeer[], fn> Select an array of peers(remote peers and your local peer) present in the room.


selectPeersWithAudioStatus

Const selectPeersWithAudioStatus: OutputSelector<HMSStore, HMSPeerWithMuteStatus[], fn>


selectPermissions

Const selectPermissions: OutputSelector<HMSStore, undefined | { changeRole: boolean ; endRoom: boolean ; mute: boolean ; muteAll: boolean ; removeOthers: boolean ; stopPresentation: boolean ; unmute: boolean }, fn> Select the permissions which determine what actions the local peer can do.


selectRemotePeers

Const selectRemotePeers: OutputSelector<HMSStore, HMSPeer[], fn> Select remote peers(other users you're connected with via the internet) present in the room.


selectRoleChangeRequest

Const selectRoleChangeRequest: OutputSelector<HMSStore, null | HMSRoleChangeRequest, fn> Select the role change request received for your local peer.


selectRoomStarted

Const selectRoomStarted: OutputSelector<HMSStore, boolean, fn>


selectRoomState

Const selectRoomState: OutputSelector<HMSStore, HMSRoomState, fn> Select the current state of the room.


selectUnreadHMSMessagesCount

Const selectUnreadHMSMessagesCount: OutputSelector<HMSStore, number, fn> Select the number of unread messages.

Functions

selectAudioTrackByPeerID

Const selectAudioTrackByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the primary audio track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>


selectAudioTrackVolume

Const selectAudioTrackVolume(id?): StoreSelector<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

NameType
id?string

Returns

StoreSelector<undefined | number>


selectAudioVolumeByPeerID

Const selectAudioVolumeByPeerID(id?): StoreSelector<undefined | number> Select the local audio volume of the primary audio track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | number>


selectAuxiliaryAudioByPeerID

Const selectAuxiliaryAudioByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the first auxiliary audio track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>


selectAuxiliaryTracksByPeerID

Const selectAuxiliaryTracksByPeerID(id?): StoreSelector<HMSTrack[]> Select an array of auxiliary tracks of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<HMSTrack[]>


selectCameraStreamByPeerID

Const selectCameraStreamByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the camera stream of a peer given a peer ID. This is the primary video track of a peer.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>


selectDevices

Select the available audio input, audio output and video input devices on your machine.

Parameters

NameType
storeHMSStore

Returns

An object of array of available audio input, audio output and video input devices.

type DeviceMap = { audioInput: InputDeviceInfo[]; audioOutput: MediaDeviceInfo[]; videoInput: InputDeviceInfo[]; }

selectIsAudioLocallyMuted

Const selectIsAudioLocallyMuted(id?): StoreSelector<undefined | boolean> Select a boolean denoting whether you've muted an audio track locally(only for you) given a track ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | boolean>


selectIsLocalAudioEnabled

Const 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

NameType
storeHMSStore

Returns

boolean


selectIsLocalScreenShared

Const selectIsLocalScreenShared(store): boolean Select a boolean denoting whether your screen is shared to remote peers in the room.

Parameters

NameType
storeHMSStore

Returns

boolean


selectIsLocalVideoDisplayEnabled

Const 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

NameType
storeHMSStore

Returns

undefined | boolean


selectIsLocalVideoEnabled

Const 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

NameType
storeHMSStore

Returns

boolean


selectIsLocalVideoPluginPresent

Const selectIsLocalVideoPluginPresent(pluginName): OutputSelector<HMSStore, boolean, fn>

Parameters

NameType
pluginNamestring

Returns

OutputSelector<HMSStore, boolean, fn>


selectIsLocallyMutedByPeerID

Const selectIsLocallyMutedByPeerID(id?): StoreSelector<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

NameType
id?string

Returns

StoreSelector<undefined | boolean>


selectIsPeerAudioEnabled

Const selectIsPeerAudioEnabled(id?): StoreSelector<boolean> Select a boolean denoting whether a peer has unmuted audio and sharing it to other peers.

Parameters

NameType
id?string

Returns

StoreSelector<boolean>


selectIsPeerVideoEnabled

Const selectIsPeerVideoEnabled(id?): StoreSelector<boolean> Select a boolean denoting whether a peer has unmuted video and sharing it to other peers.

Parameters

NameType
id?string

Returns

StoreSelector<boolean>


selectIsScreenShareLocallyMutedByPeerID

Const selectIsScreenShareLocallyMutedByPeerID(id?): StoreSelector<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

NameType
id?string

Returns

StoreSelector<undefined | boolean>


selectIsSomeoneScreenSharing

Const selectIsSomeoneScreenSharing(store): boolean Select a boolean denoting whether someone is sharing screen in the room.

Parameters

NameType
storeHMSStore

Returns

boolean


selectLocalMediaSettings

Const selectLocalMediaSettings(store): HMSMediaSettings Select your media settings i.e., choosen audio input device, audio output device and video input device.

Parameters

NameType
storeHMSStore

Returns

HMSMediaSettings


selectMessageIDsInOrder

Const selectMessageIDsInOrder(store): string[] Select IDs of messages you've sent or received sorted chronologically.

Parameters

NameType
storeHMSStore

Returns

string[]


selectMessagesByPeerID

Const selectMessagesByPeerID(id?): StoreSelector<undefined | HMSMessage[]>

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSMessage[]>


selectMessagesByRole

Const selectMessagesByRole(id?): StoreSelector<undefined | HMSMessage[]>

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSMessage[]>


selectMessagesUnreadCountByPeerID

Const selectMessagesUnreadCountByPeerID(id?): StoreSelector<number>

Parameters

NameType
id?string

Returns

StoreSelector<number>


selectMessagesUnreadCountByRole

Const selectMessagesUnreadCountByRole(id?): StoreSelector<number>

Parameters

NameType
id?string

Returns

StoreSelector<number>


selectPeerAudioByID

Const selectPeerAudioByID(id?): StoreSelector<number> Select audio level of audioTrack of a peer given a peer IDß.

Parameters

NameType
id?string

Returns

StoreSelector<number>


selectPeerByID

Const selectPeerByID(id?): StoreSelector<null | HMSPeer> Select the HMSPeer object given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<null | HMSPeer>


selectPeerNameByID

Const selectPeerNameByID(id?): StoreSelector<undefined | string> Select the name of a HMSPeer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | string>


selectPeerScreenSharing

Const selectPeerScreenSharing(store): undefined | HMSPeer Select the first peer who is currently sharing their screen.

Parameters

NameType
storeHMSStore

Returns

undefined | HMSPeer


selectPeersScreenSharing

Const selectPeersScreenSharing(store): HMSPeer[] Select an array of peers who are currently sharing their screen.

Parameters

NameType
storeHMSStore

Returns

HMSPeer[]


selectRoleByRoleName

Const selectRoleByRoleName(roleName): OutputSelector<HMSStore, HMSRole, fn>

Parameters

NameType
roleNamestring

Returns

OutputSelector<HMSStore, HMSRole, fn>


selectRolesMap

Const selectRolesMap(store): Record<string, HMSRole> Select available roles in the room as a map between the role name and HMSRole object.

Parameters

NameType
storeHMSStore

Returns

Record<string, HMSRole>


selectRoom

Const selectRoom(store): HMSRoom Select the current HMSRoom object to which you are connected.

Parameters

NameType
storeHMSStore

Returns

HMSRoom


selectScreenShareAudioByPeerID

Const selectScreenShareAudioByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the screen share audio track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>


selectScreenShareByPeerID

Const selectScreenShareByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the screen share video track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>


selectScreenshareAudioVolumeByPeerID

Const selectScreenshareAudioVolumeByPeerID(id?): StoreSelector<undefined | number> Select the local audio volume of the screen share of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | number>


selectSimulcastLayerByTrack

Const selectSimulcastLayerByTrack(id?): StoreSelector<undefined | HMSSimulcastLayer> Select the current simulcast layer of a track given a track ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSSimulcastLayer>


selectSpeakers

Const selectSpeakers(store): Record<string, HMSSpeaker>

Parameters

NameType
storeHMSStore

Returns

Record<string, HMSSpeaker>


selectTrackAudioByID

Const selectTrackAudioByID(id?): StoreSelector<number> Select the audio level of a track given a track ID.

Parameters

NameType
id?string

Returns

StoreSelector<number>


selectTrackByID

Const selectTrackByID(id?): StoreSelector<null | HMSTrack> Select the HMSTrack object given a track ID.

Parameters

NameType
id?string

Returns

StoreSelector<null | HMSTrack>


selectVideoTrackByPeerID

Const selectVideoTrackByPeerID(id?): StoreSelector<undefined | HMSTrack> Select the primary video track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack> rID

Const selectVideoTrackByPeerID(id?): StoreSelector<undefined | HMSTrack>

Select the primary video track of a peer given a peer ID.

Parameters

NameType
id?string

Returns

StoreSelector<undefined | HMSTrack>