Skip to main content
Version: 2.x

Decoders

Nodes to create decoders, which turn the voice packets of a remote peer back into audio.

Functions​

NodeTypeDescription
Construct DecoderCallable functionCreates a new ODIN Decoder.
Create DecoderCallable functionInternally Creates a new instance of an ODIN decoder with default settings used to process the remote media stream.
Free DecoderCallable functionReleases the native decoder.
Get Active ChannelMaskPure functionReturns the channel mask of the most recently received audio packet.
Get Decoder PipelineCallable functionAccesses the audio pipeline for this decoder.
Get PipelineCallable functionReturns an object to the pointer of the internal ODIN audio pipeline instance used by the given decoder.
Get Positions (Decoder)Pure functionRetrieves the last known 3D position(s) sent by the remote peer.
Get Silent Flag (Decoder)Pure functionReturns true if the decoder is currently outputting silence (i.e., the remote peer is not transmitting, or VAD has filtered it out).
Pop SamplesPure functionRetrieves a block of processed audio samples from the decoder's buffer.
Push DatagramPure functionPushes an incoming datagram to the specified decoder for processing.
Register AudioEvent Handler (Decoder)Callable functionRegisters a callback to receive decoder audio events.

Events​

EventRaised byDescription
On Audio Event (Decoder)Odin DecoderEvent triggered for audio events like 'IsSilent' changes on the decoder.

Properties​

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

PropertyClassTypeAccessDescription
PipelineOdin DecoderOdin PipelineGetThe audio pipeline of the decoder, once it was created.
Channel MaskOdin DecoderOdin Channel MaskGet/SetThe channels this decoder plays back. Applied when the decoder is registered to a peer; voice packets on other channels are not routed to it.
Sample RateOdin DecoderIntegerGetSample rate of the audio the decoder produces.
StereoOdin DecoderBooleanGetTrue if the decoder produces interleaved stereo audio.