UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LibRtc Namespace Reference

Typedefs

using FAudioChannelSample = int16_t
 
using FAudioByteBuffer = TArrayView< const uint8_t >
 
using OnAudioEncodeCallback = TFunction< void(const FAudioSampleBuffer &, const FAudioByteBuffer &AudioBytes)>
 
using OnAudioDecodeCallback = TFunction< void(const FAudioByteBuffer &AudioBytes, const FAudioSampleBuffer &)>
 

Functions

struct UE_DEPRECATED (5.4, "AVEncoder has been deprecated. Please use the AVCodecs plugin family instead.") FAudioStreamFormat
 

Typedef Documentation

◆ FAudioByteBuffer

Describes the byte buffer of the audio stream

One sample - one sample byte * NumberBytesPerSample One frame - one sample * NumberChannels One second - one frame * SampleRate The number of samples per seconds - one sample byte * NumberBytesPerSample * NumberChannels * SampleRate

◆ FAudioChannelSample

There is the declaration of the single audio sample

◆ OnAudioDecodeCallback

The callback is called to decode the byte-by-byte buffer to the sample buffer format.

The undecoded audio byte buffer is not guaranteed to be available after callback finishes. The pointer of the decoded audio sample buffer should be valid until the next decode call will happen.

Parameters
AudioUndecodedByteBuffer- The byte buffer which is being decoded.
[out]OutDecodedAudioSampleBuffer- The client side pointer of the sample buffer with decoded information.

◆ OnAudioEncodeCallback

The callback is called to encode the sample buffer to the byte-by-byte format.

The unencoded audio sample buffer is not guaranteed to be available after callback finishes. The pointer of the encoded audio byte buffer should be valid until the next encode call will happen.

Parameters
AudioUnencodedSampleBuffer- The sample buffer which is being encoded.
[out]OutEncodedAudioByteBuffer- The client side pointer of the byte buffer with encoded information.

Function Documentation

◆ UE_DEPRECATED()

struct LibRtc::UE_DEPRECATED ( 5.  4,
"AVEncoder has been deprecated. Please use the AVCodecs plugin family instead."   
)
strong

Describes the data format of the audio stream

Describes the sample buffer of the audio stream

One frame - one sample * NumberChannels One second - one frame * SampleRate The number of samples per seconds - one sample byte * NumberBytesPerSample * NumberChannels * SampleRate

Information which is used to initialize the incoming audio channel

Information which is used to initialize the outgoing audio channel

The number of samples per seconds

The number of channels in the stream

The sequence of audio samples

The format of audio samples

Initial muted state of the audio channel

The sequence of audio samples

The format of audio samples

Initial muted state of the audio channel