Class: RemotePeer
Represents a RemotePeer, which extends functionality from the Peer class. A RemotePeer is associated with audio outputs as well as data and messages exchanged in the room. It provides utilities to manage playback volume, user data, and message communication with the remote peer.
Extends
Constructors
new RemotePeer()
new RemotePeer(
_peerData
,room
):RemotePeer
Parameters
• _peerData
• _peerData.id: number
• _peerData.medias: object
[]
• _peerData.user_data: Uint8Array
• _peerData.user_id: string
• room: Room
Returns
Overrides
Defined in
ari/lib/api/peer/remote-peer.d.ts:59
Properties
_peerData
protected
_peerData:object
id
id:
number
medias
medias:
object
[]
user_data
user_data:
Uint8Array
user_id
user_id:
string
Overrides
Defined in
ari/lib/api/peer/remote-peer.d.ts:14
audioActivityHandler()
readonly
audioActivityHandler: (event
) =>void
This method is for SDK internal usage and might get removed.
Parameters
• event: OdinEvent
<AudioActivityPayload
>
The audio activity event containing relevant payload data.
Returns
void
Deprecated
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:30
id
readonly
id:number
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:12
isRemote
readonly
isRemote:true
=true
Defined in
ari/lib/api/peer/remote-peer.d.ts:16
onAudioActivity()?
optional
onAudioActivity: (payload
) =>void
A callback function that is invoked when audio activity occurs and voice activity detection (VAD) was set to true.
Parameters
• payload: AudioActivityPayload
An object containing the AudioMedia.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:36
onAudioInputStarted()?
optional
onAudioInputStarted: (payload
) =>void
A callback function that gets invoked when an AudioInput was started.
Parameters
• payload: AudioInputPayload
An object containing the AudioInput that was started.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:62
onAudioInputStopped()?
optional
onAudioInputStopped: (payload
) =>void
A callback function that gets invoked when an AudioInput was stopped.
Parameters
• payload: AudioInputPayload
An object containing the AudioInput that was stopped.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:80
onAudioOutputStarted()?
optional
onAudioOutputStarted: (payload
) =>void
A callback function that gets invoked when an AudioOutput was started.
Parameters
• payload: AudioOutputPayload
An object containing the AudioOutput that was started.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:86
onAudioOutputStopped()?
optional
onAudioOutputStopped: (payload
) =>void
A callback function that gets invoked when an AudioOutput was stopped.
Parameters
• payload: AudioOutputPayload
An object containing the AudioOutput that was stopped.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:92
onMediaStarted()?
optional
onMediaStarted: (payload
) =>void
A callback function that gets invoked when a new audio or video media was started.
Parameters
• payload: MediaPayload
An object containing the media that was started.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:50
onMediaStopped()?
optional
onMediaStopped: (payload
) =>void
A callback function that gets invoked when an audio or video media was stopped.
Parameters
• payload: MediaPayload
An object containing the media that was stopped.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:56
onPowerLevel()?
optional
onPowerLevel: (payload
) =>void
A callback function invoked when there is an update to the audio power level in rmsDBFS. This function can be used to handle or process audio activity, such as monitoring sound levels or visualizing audio input.
Parameters
• payload: AudioActivityPayload
An object containing the AudioMedia.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:44
onUserDataChanged()?
optional
onUserDataChanged: (payload
) =>void
A callback function invoked when user data is changed.
Parameters
• payload: UserDataChangedPayload
An object containing the peer and the room.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:110
onVideoInputStarted()?
optional
onVideoInputStarted: (payload
) =>void
A callback function that gets invoked when a VideoInput was started.
Parameters
• payload: VideoInputPayload
An object containing the VideoInput that was started.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:68
onVideoInputStopped()?
optional
onVideoInputStopped: (payload
) =>void
A callback function that gets invoked when a VideoInput was stopped.
Parameters
• payload: VideoInputPayload
An object containing the VideoInput that was stopped.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:74
onVideoOutputStarted()?
optional
onVideoOutputStarted: (payload
) =>void
A callback function that gets invoked when a VideoOutput was started.
Parameters
• payload: VideoOutputPayload
An object containing the VideoOutput that was started.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:98
onVideoOutputStopped()?
optional
onVideoOutputStopped: (payload
) =>void
A callback function that gets invoked when a VideoOutput was stopped.
Parameters
• payload: VideoOutputPayload
An object containing the VideoOutput that was stopped.
Returns
void
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:104
rmsDBFSHandler()
readonly
rmsDBFSHandler: (event
) =>void
This method is for SDK internal usage and might get removed.
Parameters
• event: OdinEvent
<AudioActivityPayload
>
The audio event containing the payload with RMS power level information.
Returns
void
Deprecated
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:23
room
readonly
room:Room
Overrides
Defined in
ari/lib/api/peer/remote-peer.d.ts:15
userId
readonly
userId:string
The userId that was provided by the token when joining the room.
Inherited from
Defined in
ari/lib/api/peer/index.d.ts:16
Accessors
audioOutputs
get
audioOutputs():AudioOutput
[]
Retrieves the list of audio output devices associated with this Peer.
Returns
An array of AudioOutput objects related to this Peer.
Defined in
ari/lib/api/peer/remote-peer.d.ts:52
data
get
data():Uint8Array
The arbitrary user data of the peer.
set
data(data
):void
Set updated user data for the peer.
Parameters
• data: Uint8Array
Returns
Uint8Array
The appropriate Uint8Array data based on the context.
Defined in
ari/lib/api/peer/remote-peer.d.ts:28
isActive
get
isActive():boolean
Determines if any of the audio outputs related to this peer are currently active.
Returns
boolean
True if at least one of the related audio outputs is active, otherwise false.
Defined in
ari/lib/api/peer/remote-peer.d.ts:34
powerLevel
get
powerLevel():number
Retrieves the highest power level from the related audio outputs.
Returns
number
The highest power level among all audio outputs.
Defined in
ari/lib/api/peer/remote-peer.d.ts:40
videoOutputs
get
videoOutputs():VideoOutput
[]
Retrieves the list of VideoOutput objects associated with this Peer.
Returns
An array of VideoOutput objects. Returns an empty array if no video outputs are associated.
Defined in
ari/lib/api/peer/remote-peer.d.ts:58
volume
get
volume():OutputVolume
Gets the current volume of the LocalPeer.
Returns
The current volume.
Defined in
ari/lib/api/peer/remote-peer.d.ts:46
Methods
addEventListener()
addEventListener<
OdinEventType
>(eventName
,handler
,options
?):void
Type Parameters
• OdinEventType extends keyof PeerEvents
Parameters
• eventName: OdinEventType
• handler: PeerEvents
[OdinEventType
]
• options?: boolean
| AddEventListenerOptions
Returns
void
Inherited from
Defined in
ari/lib/utils/odin-event-target.d.ts:26
dispatchEvent()
dispatchEvent<
T
>(event
):void
Type Parameters
• T extends OdinEvent
<any
>
Parameters
• event: T
Returns
void
Inherited from
Defined in
ari/lib/utils/odin-event-target.d.ts:27
removeEventListener()
removeEventListener<
OdinEventType
>(type
,callback
):void
Type Parameters
• OdinEventType extends keyof PeerEvents
Parameters
• type: string
| OdinEventType
• callback: EventListenerOrEventListenerObject
| PeerEvents
[OdinEventType
]
Returns
void
Inherited from
Defined in
ari/lib/utils/odin-event-target.d.ts:28
sendMessage()
sendMessage(
message
):Promise
<void
>
Sends a message with arbitrary data to this peer.
Parameters
• message: Uint8Array
The message to be sent as a byte array.
Returns
Promise
<void
>
A promise that resolves when the message is sent successfully.
Defined in
ari/lib/api/peer/remote-peer.d.ts:72
setVolume()
setVolume(
value
):void
Sets the volume for the playback.
Parameters
• value: number
| OutputVolume
The desired volume level. It can be a number or left and right channel [number, number].
Returns
void
Defined in
ari/lib/api/peer/remote-peer.d.ts:65