Class: Peer

Class describing a single peer inside an OdinRoom.

Extends

• OdinEventTarget<PeerEvents>

Extended by

• LocalPeer
• RemotePeer

Constructors

new Peer()

new Peer(_peerData, room): Peer

Creates an instance of the class with the provided peer data, room, and remote status.

Parameters

• _peerData

The peer data object containing information about the peer.

• _peerData.id: number

• _peerData.medias: object[]

• _peerData.user_data: Uint8Array

• _peerData.user_id: string

• room: Room

The room instance associated with the peer.

Returns

Peer

Overrides

OdinEventTarget.constructor

Defined in

ari/lib/api/peer/index.d.ts:117

Properties

_peerData

protected _peerData: object

id

id: number

medias

medias: object[]

user_data

user_data: Uint8Array

user_id

user_id: string

Defined in

ari/lib/api/peer/index.d.ts:10

---

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

Defined in

ari/lib/api/peer/index.d.ts:30

---

id

readonly id: number

Defined in

ari/lib/api/peer/index.d.ts:12

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defined in

ari/lib/api/peer/index.d.ts:23

---

room

readonly room: Room

Defined in

ari/lib/api/peer/index.d.ts:11

---

userId

readonly userId: string

The userId that was provided by the token when joining the room.

Defined in

ari/lib/api/peer/index.d.ts:16

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

OdinEventTarget.addEventListener

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

OdinEventTarget.dispatchEvent

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

OdinEventTarget.removeEventListener

Defined in

ari/lib/utils/odin-event-target.d.ts:28