HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/change-role for more info
HMSSDK
HMSSDK
Cancel the Previewing for Role invocation.
If a [previewForRole] call was performed previously then calling this method clears the tracks created anticipating a Change of Role
checkout https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role for more info
HMSSDK
changeMetadata changes a specific field in localPeer which is [metadata] it is a string that can be used for various functionalities like raiseHand, beRightBack and many more that explains the current status of the peer.
it is advised to use a json object in string format to store multiple dataPoints in metadata.
checkout https://www.100ms.live/docs/react-native/v2/advanced-features/change-metadata for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/change-name for more info
HMSSDK
This function has been deprecated in favor of #Function changeRoleOfPeer
This function can be used in a situation when we want to change role hence manipulate their access and rights in the current room, it takes the peer HMSPeer whom role we want to change, role HMSRole which will be the new role for that peer and weather to forcefully change the role or ask the to accept the role change request using a boolean force.
if we change the role forcefully the peer's role will be updated without asking the peer otherwise the user will get the roleChangeRequest in roleChangeRequest listener. for more information on this checkout onRoleChangeRequestListener
checkout https://www.100ms.live/docs/react-native/v2/features/change-role for more info
HMSSDK
This function can be used in a situation when we want to change role hence manipulate their access and rights in the current room, it takes the peer HMSPeer whom role we want to change, role HMSRole which will be the new role for that peer and weather to forcefully change the role or ask the to accept the role change request using a boolean force.
if we change the role forcefully the peer's role will be updated without asking the peer otherwise the user will get the roleChangeRequest in roleChangeRequest listener. for more information on this checkout onRoleChangeRequestListener
checkout https://www.100ms.live/docs/react-native/v2/features/change-role for more info
HMSSDK
This function can be used in a situation when we want to change role of multiple peers by specifying their roles. Hence manipulate their access and rights in the current room. It takes the list of roles HMSRole whom role we want to change and role HMSRole which will be the new role for peers.
Note that role will be updated without asking the peers. Meaning, Peers will not get the roleChangeRequest in roleChangeRequest listener.
checkout https://www.100ms.live/docs/react-native/v2/features/change-role for more info
HMSSDK
HMSSDK
Optional
type: HMSTrackTypeOptional
source: stringdetermines the source of the track ex. video, audio etc.
Optional
roles: HMSRole[]HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/end-room for more info
HMSSDK
Optional
data: HMSPIPConfigcheckout https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-list-of-audio-device for more info
HMSAudioDevice[]
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-current-focussed-device for more info
HMSAudioDevice
HMSSDK
checkout https://www.100ms.live/docs/concepts/v2/concepts/rooms/room-codes/room-codes for more info
Optional
userId: stringOptional
endpoint: stringHMSSDK
Promise
HMSSDK
getPeerListIterator
method returns an instance of HMSPeerListIterator
class
Optional
options: HMSPeerListIteratorOptionsoptions for configuring iterator
instance of HMSPeerListIterator class
Example usage:
const peerListIterator = hmsInstance.getPeerListIterator();
OR
const peerListIterator = hmsInstance.getPeerListIterator({
limit: 10,
byRoleName: 'viewer-realtime',
});
Promise<HMSRemotePeer[]>
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/join#get-room for more info
Promise
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-get-audio-share-status for more info.
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/screenshare for more info
HMSSDK
takes an instance of [HMSConfig]HMSConfig and joins the room. after joining the room user will start receiving the events and updates of the room.
checkout https://www.100ms.live/docs/react-native/v2/features/join for more info
HMSSDK
Calls leave function of native sdk and session of current user is invalidated.
checkout https://www.100ms.live/docs/react-native/v2/features/leave for more info
HMSSDK
Below are all the listeners that are connected to native side.
All of the are connected when build function is called, we can connect them to the app by calling addEventListener with corresponding event type.
Before passing the data to the eventListener of the app these listeners encode the data in ts classes for a proper structuring of the data.
Even When event listeners of the app are disconnected using removeEventListener or removeAllListeners or not even connected in first place, these functions still run to maintain the current state of the instance of HMSSDK.
checkout https://www.100ms.live/docs/react-native/v2/features/preview for more info
HMSSDK
-Preview for a specific Role before changing it.
By previewing before doing a Role Change, users can see their expected Audio & Video tracks which will be visible to other Peers in Room post changing the Role.
checkout https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/remove-peer for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/chat for more info
the message that is to be sent
the default type is set to CHAT. You can pass a custom type here for sending events like Emoji Reactions, Notifications, etc
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/chat for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/chat for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#adding-a-listener for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-change-mode for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-mode-change for more info
HMSSDK
Optional
hmsLogger: HMSLoggerHMSSDK
Optional
data: HMSPIPConfigcheckout https://www.100ms.live/docs/react-native/v2/features/playback-allowed for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/advanced-features/set-volume for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stream-device-audio-from-the-app for more info.
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/hls-streaming for more info
Optional
data: HMSHLSConfigHMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/recording for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/screenshare for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stop-audio-sharing for more info.
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/hls-streaming for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/recording for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/screenshare for more info
HMSSDK
checkout https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#switch-audio-focus-to-another-device for more info
HMSSDK
Static
buildRegular Usage:
const hmsInstance = await HMSSDK.build();
For Advanced Use-Cases:
Optional
params: { Optional
appOptional
isOptional
logOptional
preferredOptional
trackHMSSDK
Static
getGenerated using TypeDoc
checkout https://www.100ms.live/docs/react-native/v2/features/render-video for more info