lib/live.hms.video.sdk.models/HMSPeer

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

getAllTracks

fun getAllTracks(): Array<HMSTrack>

getTrackById

fun getTrackById(trackId: String): HMSTrack?

toString

open override fun toString(): String

Properties

audioTrack

abstract val audioTrack: HMSAudioTrack?

This contains the audio track of this peer

auxiliaryTracks

var auxiliaryTracks: MutableList<HMSTrack>

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

customerUserID

val customerUserID: String?

The CustomerUserID of this peer which is given the app

hmsRole

var hmsRole: HMSRole

isHandRaised

var isHandRaised: Boolean = false

isLocal

val isLocal: Boolean

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

var joinedAt: Long

var metadata: String

var name: String

var networkQuality: HMSNetworkQuality? = null

peerID

val peerID: String

The peerID of this peer which is generated by the SDK

type

val type: HMSPeerType

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

videoTrack

abstract val videoTrack: HMSVideoTrack?

This contains the video track of this peer

Inheritors

HMSLocalPeer

HMSRemotePeer