Skip to main content
Version: 0.11.x

Interface: OdinEvents

Defines available Odin events

Properties​

AudioDataReceived​

AudioDataReceived: OdinAudioDataReceivedEvent

Fired when audio data is available for media streams. Audio comes in 16 bit and 32 bit float samples and are available individually for each peer. You can use the samples to record audio or send them to an AI for transcription.

Defined in​

odin.room.d.ts:67

ConnectionStateChanged​

ConnectionStateChanged: OdinConnectionStateChangedEvent

Fired when the connection state of the room changed.

Defined in​

odin.room.d.ts:46

Joined​

Joined: OdinJoinedEvent

Fired when the local user connected to the room (successfully joined).

Defined in​

odin.room.d.ts:11

Left​

Left: OdinLeftEvent

Fired when the local user disconnected from the room (left).

Defined in​

odin.room.d.ts:16

MediaActivity​

MediaActivity: OdinMediaActivityEvent

Fired when a media stream was activated or deactivated. The active flag is true if the user started to talk and false if the user stopped talking.

Defined in​

odin.room.d.ts:61

MediaAdded​

MediaAdded: OdinMediaAddedEvent

Fired when a media stream was added to a peer. This happens for example if a peer adds a microphone to the room

Defined in​

odin.room.d.ts:51

MediaRemoved​

MediaRemoved: OdinMediaRemovedEvent

Fired when a media stream was removed from a peer. This happens for example if a peer removes a microphone from the room

Defined in​

odin.room.d.ts:56

MessageReceived​

MessageReceived: OdinMessageReceivedEvent

Fired when a remote peer sent a message to the room.

Defined in​

odin.room.d.ts:31

PeerJoined​

PeerJoined: OdinPeerJoinedEvent

Fired when a remote peer joined the room. This event is fired for all existing peers in the room before the Joined event is fired.

Defined in​

odin.room.d.ts:21

PeerLeft​

PeerLeft: OdinPeerLeftEvent

Fired when a remote peer left the room.

Defined in​

odin.room.d.ts:26

PeerTagsChanged​

PeerTagsChanged: OdinPeerTagsChangedEvent

Fired when the tags of a remote peer changed.

Defined in​

odin.room.d.ts:72

PeerUserDataChanged​

PeerUserDataChanged: OdinPeerUserDataChangedEvent

Fired when the user data of a remote peer changed.

Defined in​

odin.room.d.ts:36

RoomUserDataChanged​

RoomUserDataChanged: OdinRoomUserDataChangedEvent

Fired when the user data of the room changed.

Defined in​

odin.room.d.ts:41