Package live.hms.video.sdk.models
Class HMSPeer
-
- All Implemented Interfaces:
public abstract class HMSPeerHMSPeer is the object returned by 100ms SDKs that contains all information about a user.
-
-
Field Summary
Fields Modifier and Type Field Description private final HMSVideoTrackvideoTrackprivate final HMSAudioTrackaudioTrackprivate final List<HMSTrack>auxiliaryTracksprivate final HMSRolehmsRoleprivate final Stringnameprivate final Stringmetadataprivate final HMSNetworkQualitynetworkQualityprivate final LongjoinedAtprivate final BooleanisHandRaisedprivate final StringpeerIDprivate final StringcustomerUserIDprivate final BooleanisLocalprivate final HMSPeerTypetype
-
Method Summary
Modifier and Type Method Description abstract HMSVideoTrackgetVideoTrack()This contains the video track of this peer abstract HMSAudioTrackgetAudioTrack()This contains the audio track of this peer final List<HMSTrack>getAuxiliaryTracks()Any other tracks like screen share track or plugins are mentioned here final HMSRolegetHmsRole()final StringgetName()final StringgetMetadata()final HMSNetworkQualitygetNetworkQuality()final LonggetJoinedAt()final BooleanisHandRaised()final StringgetPeerID()The peerID of this peer which is generated by the SDK final StringgetCustomerUserID()The CustomerUserID of this peer which is given the app final BooleanisLocal()Specifies if this peer is a HMSLocalPeer or a HMSRemotePeer True if local, otherwise false final HMSPeerTypegetType()SIP if it's an SIP peer, REGULAR otherwise. StringtoString()final HMSTrackgetTrackById(String trackId)final Array<HMSTrack>getAllTracks()-
-
Method Detail
-
getVideoTrack
abstract HMSVideoTrack getVideoTrack()
This contains the video track of this peer
-
getAudioTrack
abstract HMSAudioTrack getAudioTrack()
This contains the audio track of this peer
-
getAuxiliaryTracks
final List<HMSTrack> getAuxiliaryTracks()
Any other tracks like screen share track or plugins are mentioned here
-
getHmsRole
final HMSRole getHmsRole()
-
getMetadata
final String getMetadata()
-
getNetworkQuality
final HMSNetworkQuality getNetworkQuality()
-
getJoinedAt
final Long getJoinedAt()
-
isHandRaised
final Boolean isHandRaised()
-
getCustomerUserID
final String getCustomerUserID()
The CustomerUserID of this peer which is given the app
-
isLocal
final Boolean isLocal()
Specifies if this peer is a HMSLocalPeer or a HMSRemotePeer True if local, otherwise false
-
getType
final HMSPeerType getType()
SIP if it's an SIP peer, REGULAR otherwise.
-
getTrackById
final HMSTrack getTrackById(String trackId)
-
getAllTracks
final Array<HMSTrack> getAllTracks()
- Returns:
A list of HMSTrack that this peer contains
-
-
-
-