Preparing search index...
The search index is not available
@100mslive/react-native-hms
@100mslive/react-native-hms
HMSRemotePeer
Class HMSRemotePeer
Hierarchy
HMSPeer
HMSRemotePeer
Index
Constructors
constructor
Properties
name
peerID
Accessors
audio
Track
auxiliary
Tracks
customer
UserID
is
Hand
Raised
is
Local
metadata
network
Quality
role
type
video
Track
Methods
remote
Audio
Track
remote
Video
Track
Constructors
constructor
new HMSRemote
Peer
(
params
)
:
HMSRemotePeer
Parameters
params
:
{
name
:
string
;
peerID
:
string
;
remoteAudioTrackData
?:
{
id
:
string
;
isMute
?:
boolean
;
playbackAllowed
?:
boolean
;
source
?:
HMSTrackSource
;
trackDescription
?:
string
;
trackId
:
string
;
}
;
remoteVideoTrackData
?:
{
id
:
string
;
isMute
?:
boolean
;
playbackAllowed
?:
boolean
;
source
?:
HMSTrackSource
;
trackDescription
?:
string
;
trackId
:
string
;
}
;
}
name
:
string
peerID
:
string
Optional
remote
Audio
Track
Data
?:
{
id
:
string
;
isMute
?:
boolean
;
playbackAllowed
?:
boolean
;
source
?:
HMSTrackSource
;
trackDescription
?:
string
;
trackId
:
string
;
}
id
:
string
Optional
is
Mute
?:
boolean
Optional
playback
Allowed
?:
boolean
Optional
source
?:
HMSTrackSource
Optional
track
Description
?:
string
track
Id
:
string
Optional
remote
Video
Track
Data
?:
{
id
:
string
;
isMute
?:
boolean
;
playbackAllowed
?:
boolean
;
source
?:
HMSTrackSource
;
trackDescription
?:
string
;
trackId
:
string
;
}
id
:
string
Optional
is
Mute
?:
boolean
Optional
playback
Allowed
?:
boolean
Optional
source
?:
HMSTrackSource
Optional
track
Description
?:
string
track
Id
:
string
Returns
HMSRemotePeer
Properties
name
name
:
string
peerID
peerID
:
string
Accessors
audio
Track
get
audioTrack
(
)
:
undefined
|
HMSAudioTrack
Returns
undefined
|
HMSAudioTrack
auxiliary
Tracks
get
auxiliaryTracks
(
)
:
undefined
|
HMSTrack
[]
Returns
undefined
|
HMSTrack
[]
customer
UserID
get
customerUserID
(
)
:
undefined
|
string
Returns
undefined
|
string
is
Hand
Raised
get
isHandRaised
(
)
:
boolean
Returns
boolean
is
Local
get
isLocal
(
)
:
undefined
|
boolean
Returns
undefined
|
boolean
metadata
get
metadata
(
)
:
undefined
|
string
Returns
undefined
|
string
network
Quality
get
networkQuality
(
)
:
undefined
|
HMSNetworkQuality
Returns
undefined
|
HMSNetworkQuality
role
get
role
(
)
:
undefined
|
HMSRole
Returns
undefined
|
HMSRole
type
get
type
(
)
:
HMSPeerType
Returns
HMSPeerType
video
Track
get
videoTrack
(
)
:
undefined
|
HMSVideoTrack
Returns
undefined
|
HMSVideoTrack
Methods
remote
Audio
Track
remote
Audio
Track
(
)
:
undefined
|
HMSRemoteAudioTrack
Returns
undefined
|
HMSRemoteAudioTrack
remote
Video
Track
remote
Video
Track
(
)
:
undefined
|
HMSRemoteVideoTrack
Returns
undefined
|
HMSRemoteVideoTrack
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
name
peerID
audio
Track
auxiliary
Tracks
customer
UserID
is
Hand
Raised
is
Local
metadata
network
Quality
role
type
video
Track
remote
Audio
Track
remote
Video
Track
@100mslive/react-
native-
hms
default
HMSAudio
Codec
HMSAudio
Device
HMSAudio
Mixing
Mode
HMSAudio
Mode
HMSCamera
Facing
HMSHLSPlayer
Playback
Event
Types
HMSHLSPlayer
Playback
State
HMSHLSPlayer
Stats
Event
Types
HMSIOSAudio
Mode
HMSLayer
HMSLog
Alarm
Manager
HMSLog
Level
HMSMessage
Recipient
Type
HMSNoise
Cancellation
Initial
State
HMSNoise
Cancellation
Models
HMSPIPListener
Actions
HMSPeer
Type
HMSPeer
Update
HMSPoll
Question
Type
HMSPoll
State
HMSPoll
Type
HMSPoll
Update
Type
HMSPoll
User
Tracking
Mode
HMSQuality
Limitation
Reason
HMSRecording
State
HMSRoom
Update
HMSStreaming
State
HMSTrack
Settings
Init
State
HMSTrack
Source
HMSTrack
Type
HMSTrack
Update
HMSUpdate
Listener
Actions
HMSVideo
Codec
HMSVideo
View
Mode
Soft
Input
Modes
HMSAudio
File
Player
Node
HMSAudio
Mixer
Source
HMSAudio
Node
HMSAudio
Settings
HMSAudio
Track
HMSAudio
Track
Settings
HMSBrowser
Recording
State
HMSCamera
Control
HMSChange
Track
State
Request
HMSConfig
HMSEncoder
HMSException
HMSHLSConfig
HMSHLSMeetingURLVariant
HMSHLSRecording
Config
HMSHLSRecording
State
HMSHLSStreaming
State
HMSHLSVariant
HMSHelper
HMSLocal
Audio
Stats
HMSLocal
Audio
Track
HMSLocal
Peer
HMSLocal
Video
Stats
HMSLocal
Video
Track
HMSLog
Settings
HMSLogger
HMSMessage
HMSMessage
Recipient
HMSMic
Node
HMSNetwork
Quality
HMSNoise
Cancellation
Plugin
HMSPeer
HMSPermissions
HMSPublish
Settings
HMSQuality
Limitation
Reasons
HMSRTCStats
HMSRTCStats
Report
HMSRTMPConfig
HMSRemote
Audio
Stats
HMSRemote
Audio
Track
HMSRemote
Peer
HMSRemote
Video
Stats
HMSRemote
Video
Track
HMSRole
HMSRole
Change
Request
HMSRoom
HMSRtmp
Streaming
State
HMSRtmp
Video
Resolution
HMSSDK
HMSScreen
Broadcast
Audio
Receiver
Node
HMSServer
Recording
State
HMSSession
Store
HMSSimulcast
Layer
Definition
HMSSimulcast
Layer
Settings
HMSSimulcast
Settings
HMSSpeaker
HMSSubscribe
Settings
HMSTrack
HMSTrack
Settings
HMSVideo
Resolution
HMSVideo
Settings
HMSVideo
Track
HMSVideo
Track
Settings
Window
Controller
HMSHLSPlayer
Playback
Cue
HMSHLSPlayer
Playback
Slice
HMSHLSPlayer
Props
HMSHLSPlayer
Ref
Properties
HMSHLSPlayer
Stats
Slice
HMSPIPConfig
HMSPoll
HMSPoll
Leaderboard
Entry
HMSPoll
Leaderboard
Summary
HMSPoll
Question
HMSPoll
Question
Answer
HMSPoll
Question
Option
HMSPoll
Question
Response
HMSView
Props
HMSViews
Slice
Poll
Leaderboard
Response
HMSHLSPlayer
Cue
HMSHLSPlayer
Playback
Cue
Event
Data
HMSHLSPlayer
Playback
Error
HMSHLSPlayer
Playback
Event
HMSHLSPlayer
Playback
Failure
Event
Data
HMSHLSPlayer
Playback
Resolution
Change
Event
Data
HMSHLSPlayer
Playback
State
Change
Event
Data
HMSHLSPlayer
Resolution
HMSHLSPlayer
Stats
HMSHLSPlayer
Stats
Error
HMSHLSPlayer
Stats
Error
Event
Data
HMSHLSPlayer
Stats
Event
HMSHLSPlayer
Stats
Store
HMSHLSPlayer
Stats
Update
Event
Data
HMSInteractivity
Store
HMSPolls
Slice
HMSStore
Json
Array
Json
Map
Json
Primitive
Json
Value
Notification
Result
Resolution
Track
Id
HMSManager
Module
HMSPeer
Type
Ordinals
HMSPeer
Update
Ordinals
logger
HMSHLSPlayer
HMSView
check
Notifications
get
Logger
get
Soft
Input
Mode
set
Logger
set
Soft
Input
Mode
useHMSHLSPlayer
Cue
useHMSHLSPlayer
Playback
Error
useHMSHLSPlayer
Playback
State
useHMSHLSPlayer
Resolution
useHMSHLSPlayer
Stat
useHMSHLSPlayer
Stats
useHMSHLSPlayer
Stats
Error
useHMSPeer
Updates
use
Hms
Views
Resolutions
State
Generated using
TypeDoc