UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
radaudio_encoder.h File Reference
#include "egttypes.h"
#include <stddef.h>

Go to the source code of this file.

Classes

struct  radaudio_encoder
 
struct  radaudio_encode_info
 

Macros

#define RADAUDIOENC_AT_EOF   0
 
#define RADAUDIOENC_INSUFFICIENT_BUFFER   -1
 
#define RADAUDIOENC_INTERNAL_ERROR   -2
 
#define RADAUDIOENC_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK   1024
 
#define RADAUDIO_ENC_LIBRARY_VERSION   1
 
#define RR_STRING_JOIN3(arg1, arg2, arg3)   RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)
 
#define RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)   RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)
 
#define RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)   arg1 ## arg2 ## arg3
 
#define RADAUDIO_ENC_NAME(name)   RR_STRING_JOIN( name##_, RADAUDIO_ENC_LIBRARY_VERSION )
 
#define radaudio_encode_create   RADAUDIO_ENC_NAME(radaudio_encode_create)
 
#define radaudio_encode_block   RADAUDIO_ENC_NAME(radaudio_encode_block)
 
#define radaudio_encode_create_internal   RADAUDIO_ENC_NAME(radaudio_encode_create_internal)
 
#define RadAudioCompressGetProfileData   RADAUDIO_ENC_NAME(RadAudioCompressGetProfileData)
 
#define radaudio_determine_preferred_next_block_length   RADAUDIO_ENC_NAME(radaudio_determine_preferred_next_block_length)
 
#define radaudio_determine_preferred_first_block_length   RADAUDIO_ENC_NAME(radaudio_determine_preferred_first_block_length)
 
#define radaudio_encode_block_ext   RADAUDIO_ENC_NAME(radaudio_encode_block_ext)
 
#define RADAUDIO_STREAM_HEADER_MAX   128
 
#define RADAUDIO_ENC_FLAG_improve_seamless_loop   1
 
#define MAX_ENCODED_BLOCK_SIZE   5000
 

Enumerations

enum  radaudio_blocktype { RADAUDIO_BLOCKTYPE_short = 1 , RADAUDIO_BLOCKTYPE_long = 2 , RADAUDIO_BLOCKTYPE_default = 0 }
 

Functions

RADDEFFUNC size_t radaudio_encode_create (radaudio_encoder *rae, U8 header[RADAUDIO_STREAM_HEADER_MAX], int num_channels, int sample_rate, int quality, U32 flags)
 
RADDEFFUNC int radaudio_encode_block (radaudio_encoder *es, float *input, size_t input_len, size_t *offset, unsigned char *encode_buffer, size_t encode_buffer_size)
 
RADDEFFUNC int radaudio_encode_block_ext (radaudio_encoder *es, float *input, size_t input_len, size_t *offset, unsigned char *encode_buffer, size_t encode_buffer_size, radaudio_encode_info *info)
 
RADDEFFUNC radaudio_blocktype radaudio_determine_preferred_first_block_length (radaudio_encoder *rae, F32 *input, size_t input_len)
 
RADDEFFUNC int radaudio_determine_preferred_next_block_length (radaudio_encoder *rae, radaudio_blocktype firsttype, F32 *input, size_t input_len, size_t offset)
 

Macro Definition Documentation

◆ MAX_ENCODED_BLOCK_SIZE

#define MAX_ENCODED_BLOCK_SIZE   5000

◆ radaudio_determine_preferred_first_block_length

#define radaudio_determine_preferred_first_block_length   RADAUDIO_ENC_NAME(radaudio_determine_preferred_first_block_length)

◆ radaudio_determine_preferred_next_block_length

#define radaudio_determine_preferred_next_block_length   RADAUDIO_ENC_NAME(radaudio_determine_preferred_next_block_length)

◆ RADAUDIO_ENC_FLAG_improve_seamless_loop

#define RADAUDIO_ENC_FLAG_improve_seamless_loop   1

◆ RADAUDIO_ENC_LIBRARY_VERSION

#define RADAUDIO_ENC_LIBRARY_VERSION   1

◆ RADAUDIO_ENC_NAME

#define RADAUDIO_ENC_NAME (   name)    RR_STRING_JOIN( name##_, RADAUDIO_ENC_LIBRARY_VERSION )

◆ radaudio_encode_block

#define radaudio_encode_block   RADAUDIO_ENC_NAME(radaudio_encode_block)

◆ radaudio_encode_block_ext

#define radaudio_encode_block_ext   RADAUDIO_ENC_NAME(radaudio_encode_block_ext)

◆ radaudio_encode_create

#define radaudio_encode_create   RADAUDIO_ENC_NAME(radaudio_encode_create)

◆ radaudio_encode_create_internal

#define radaudio_encode_create_internal   RADAUDIO_ENC_NAME(radaudio_encode_create_internal)

◆ RADAUDIO_STREAM_HEADER_MAX

#define RADAUDIO_STREAM_HEADER_MAX   128

◆ RadAudioCompressGetProfileData

#define RadAudioCompressGetProfileData   RADAUDIO_ENC_NAME(RadAudioCompressGetProfileData)

◆ RADAUDIOENC_AT_EOF

#define RADAUDIOENC_AT_EOF   0

◆ RADAUDIOENC_INSUFFICIENT_BUFFER

#define RADAUDIOENC_INSUFFICIENT_BUFFER   -1

◆ RADAUDIOENC_INTERNAL_ERROR

#define RADAUDIOENC_INTERNAL_ERROR   -2

◆ RADAUDIOENC_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK

#define RADAUDIOENC_MAX_OUTPUT_SAMPLES_PER_CHANNEL_PER_CHUNK   1024

◆ RR_STRING_JOIN3

#define RR_STRING_JOIN3 (   arg1,
  arg2,
  arg3 
)    RR_STRING_JOIN_DELAY3(arg1, arg2, arg3)

◆ RR_STRING_JOIN_DELAY3

#define RR_STRING_JOIN_DELAY3 (   arg1,
  arg2,
  arg3 
)    RR_STRING_JOIN_IMMEDIATE3(arg1, arg2, arg3)

◆ RR_STRING_JOIN_IMMEDIATE3

#define RR_STRING_JOIN_IMMEDIATE3 (   arg1,
  arg2,
  arg3 
)    arg1 ## arg2 ## arg3

Enumeration Type Documentation

◆ radaudio_blocktype

Enumerator
RADAUDIO_BLOCKTYPE_short 
RADAUDIO_BLOCKTYPE_long 
RADAUDIO_BLOCKTYPE_default 

Function Documentation

◆ radaudio_determine_preferred_first_block_length()

RADDEFFUNC radaudio_blocktype radaudio_determine_preferred_first_block_length ( radaudio_encoder rae,
F32 input,
size_t  input_len 
)

◆ radaudio_determine_preferred_next_block_length()

RADDEFFUNC int radaudio_determine_preferred_next_block_length ( radaudio_encoder rae,
radaudio_blocktype  firsttype,
F32 input,
size_t  input_len,
size_t  offset 
)

◆ radaudio_encode_block()

RADDEFFUNC int radaudio_encode_block ( radaudio_encoder es,
float input,
size_t  input_len,
size_t offset,
unsigned char encode_buffer,
size_t  encode_buffer_size 
)

◆ radaudio_encode_block_ext()

RADDEFFUNC int radaudio_encode_block_ext ( radaudio_encoder es,
float input,
size_t  input_len,
size_t offset,
unsigned char encode_buffer,
size_t  encode_buffer_size,
radaudio_encode_info info 
)

◆ radaudio_encode_create()

RADDEFFUNC size_t radaudio_encode_create ( radaudio_encoder rae,
U8  header[RADAUDIO_STREAM_HEADER_MAX],
int  num_channels,
int  sample_rate,
int  quality,
U32  flags 
)