Skip to main content
Version: 2.x

Encoders

Nodes to create encoders, which turn captured audio into voice packets for one or more rooms.

Functions​

NodeTypeDescription
Clear Encoder PositionCallable functionRemoves the position entry associated with the given channel mask, which also stops the encoder from transmitting on that channel entirely
Construct EncoderCallable functionCreates a new ODIN Encoder.
Construct Encoder (Advanced)Callable functionCreates a new ODIN Encoder with advanced configuration options.
Create EncoderCallable functionCreates a new ODIN encoder instance with default settings used to encode audio captured from local sources, such as a microphone using the given sample rate and channel layout.
Create Encoder (Advanced)Callable functionCreates a new ODIN encoder instance with extended codec configuration parameters.
Create Odin Encoder from GeneratorCallable functionCreates encoder with the samplerate and channel count from the generator.
Free EncoderCallable functionReleases the native encoder.
Get Linked RoomsPure functionReturns all rooms this encoder currently sends audio to (see Link Encoder to Room).
Get Or Create Encoder PipelineCallable functionRetrieves the Audio Pipeline associated with this encoder.
Get Or Create PipelineCallable functionReturns the audio pipeline of the encoder and creates it on first use.
Get Silent Flag (Encoder)Pure functionReturns true if the encoder is currently detecting silence (based on the VAD settings).
Link Encoder to RoomCallable functionLinks an encoder to a room.
Pop DatagramCallable functionRuns the audio pipeline on the pushed samples and returns the next encoded voice packet (datagram).
Push SamplesCallable functionPushes raw audio samples (32-bit float, interleaved if stereo) into the encoder.
Register AudioEvent Handler (Encoder)Callable functionRegisters a callback for audio events.
Set Audio GeneratorCallable functionFeeds the encoder from an audio generator, such as an Odin Audio Capture.
Set Echo Cancellation Processing DelayCallable functionThe delay parameter is used to align the reverse stream processing with the forward (capture) stream.
Set Encoder PositionCallable functionSets the 3D position of the encoder for the given channels.
Set Encoder PositionsCallable functionConvenience wrapper to assign a position to several channel masks at once to update position for a spatialized proximity channel alongside fixed/unused position one
Unlink Encoder from RoomCallable functionUnlinks an encoder from a room.

Events​

EventRaised byDescription
On Audio Event (Encoder)Odin EncoderEvent triggered for audio events like 'IsSilent' changes on the encoder.

Properties​

Variables that Blueprints can read (Get) and, where noted, write (Set) directly on an object of the class.

PropertyClassTypeAccessDescription
Audio GeneratorOdin EncoderAudio GeneratorGetThe audio generator the encoder reads from, if any.
Peer IdOdin EncoderInteger64GetThe peer ID the encoder was created with.
Sample RateOdin EncoderIntegerGetSample rate of the audio the encoder expects.
StereoOdin EncoderBooleanGetTrue if the encoder expects interleaved stereo audio.