HMSPeer

abstract class HMSPeer

HMSPeer is the object returned by 100ms SDKs that contains all information about a user.

Parameters

peerID

id of this peer which is generated by the SDK.

customerUserID

client provided identifier, provided by implementing apps.

name

client provided name of the peer.

isLocal

whether the peer is a HMSLocalPeer or a HMSRemotePeer. True if local, false otherwise.

hmsRole

role of the peer.

joinedAt

the time at which the peer joined.

metadata

client specified persistent extra data.

videoTrack

video track of the peer.

audioTrack

audio track of the peer.

auxiliaryTracks

other tracks like screen share track or plugins are mentioned here.

Functions

Link copied to clipboard
Link copied to clipboard
fun getTrackById(trackId: String): HMSTrack?
Link copied to clipboard
open override fun toString(): String

Properties

Link copied to clipboard
abstract val audioTrack: HMSAudioTrack?

This contains the audio track of this peer

Link copied to clipboard

Any other tracks like screen share track or plugins are mentioned here

Link copied to clipboard

The CustomerUserID of this peer which is given the app

Link copied to clipboard
Link copied to clipboard
var isHandRaised: Boolean = false
Link copied to clipboard

Specifies if this peer is a HMSLocalPeer or a HMSRemotePeer True if local, otherwise false

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The peerID of this peer which is generated by the SDK

Link copied to clipboard

SIP if it's an SIP peer, REGULAR otherwise.

Link copied to clipboard
abstract val videoTrack: HMSVideoTrack?

This contains the video track of this peer

Inheritors

Link copied to clipboard
Link copied to clipboard