Our new developer documentation is now available. Please check it out!
OdinEvents
On this page
export interface OdinEvents
Defines available Odin events
Properties
Name | Type | Description |
---|---|---|
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. |
ConnectionStateChanged | OdinConnectionStateChangedEvent | Fired when the connection state of the room changed. |
Joined | OdinJoinedEvent | Fired when the local user connected to the room (successfully joined). |
Left | OdinLeftEvent | Fired when the local user disconnected from the room (left). |
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. |
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 |
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 |
MessageReceived | OdinMessageReceivedEvent | Fired when a remote peer sent a message to the room. |
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. |
PeerLeft | OdinPeerLeftEvent | Fired when a remote peer left the room. |
PeerUserDataChanged | OdinPeerUserDataChangedEvent | Fired when the user data of a remote peer changed. |
RoomUserDataChanged | OdinRoomUserDataChangedEvent | Fired when the user data of the room changed. |