Skip to main content
Version: 2.x

Structs and Enums

Structs and enums used by the ODIN Blueprint nodes.

Structs​

StructDescription
Odin Apm ConfigConfiguration for the Audio Processing Module.
Odin Capture Device InfoRepresents additional information about an audio capture device and makes it available to blueprints.
Odin Change SelfRequest of Send ChangeSelf Rpc: the new user data of the local peer.
Odin Channel MaskA set of audio channels (0-63), stored as a 64-bit mask.
Odin Channel PositionA channel mask together with a position, used by Set Encoder Positions.
Odin Connection StatsConnection statistics of a room, returned by Get Connection Stats.
Odin Error (Struct)Payload of On Room Error.
Odin JoinedStructure containing information about a successful room join.
Odin Message ReceivedStructure containing a received message.
Odin New Reconnect TokenStructure containing a new reconnect token.
Odin Peer ChangedStructure containing information about a peer update.
Odin Peer JoinedStructure containing information about a newly joined peer.
Odin Peer LeftStructure containing information about a peer that left the room.
Odin PositionRepresents a 3D position used for peer proximity calculations.
Odin Room Status ChangedStructure containing room status change info.
Odin Send MessageRequest of Send Message Rpc.
Odin Sensitivity ConfigSettings of one VAD detector (voice activity or volume gate).
Odin Set Channel MasksRequest of Send SetChannelMasks Rpc: the channel masks the local peer listens to, per remote peer.
Odin Socket InfoInformation about a socket, returned by Get Socket Info.
Odin Vad ConfigConfiguration for Voice Activity Detection.
Odin Vi ConfigConfiguration of the Voice Isolation (VI) effect, which uses a deep-learning noise suppression model to separate speech from background sound in the capture signal.

Enums​

EnumDescription
Odin Audio EventsAudio-related events emitted by encoders and decoders.
Odin Crypto Peer StatusEncryption state of a peer, returned by Get Peer Crypto Status.
Odin Effect TypeType of an effect in an audio pipeline.
Odin Error (Enum)Result codes of the native ODIN Core SDK, e.g.
Odin Gain Controller VersionAutomatic gain control (AGC) version of the APM effect.
Odin Mute Effect OptionsMute state of a Mute Effect.
Odin Noise SuppressionNoise suppression level of the APM effect.
Odin Socket KindDelivery mode of a socket.
Odin Token AudienceAudience claim of a room token: whether the token is meant for the gateway or for an SFU directly.
Odin Token SubjectSubject claim of a room token.
OJsonRepresents all the types a Json Value can be.