UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
binka_ue_encode.h File Reference
#include <stdint.h>

Go to the source code of this file.

Macros

#define BINKA_COMPRESS_SUCCESS   0
 
#define BINKA_COMPRESS_ERROR_CHANS   1
 
#define BINKA_COMPRESS_ERROR_SAMPLES   2
 
#define BINKA_COMPRESS_ERROR_RATE   3
 
#define BINKA_COMPRESS_ERROR_QUALITY   4
 
#define BINKA_COMPRESS_ERROR_ALLOCATORS   5
 
#define BINKA_COMPRESS_ERROR_OUTPUT   6
 
#define BINKA_COMPRESS_ERROR_SEEKTABLE   7
 
#define BINKA_COMPRESS_ERROR_SIZE   8
 
#define BINKA_MAX_CHANS_STR   TEXT("16")
 
#define BINKA_MIN_RATE_STR   TEXT("2 khz")
 
#define BINKA_MAX_RATE_STR   TEXT("256 khz")
 

Typedefs

typedef voidBAUECompressAllocFnType(uintptr_t ByteCount)
 
typedef void BAUECompressFreeFnType(void *Ptr)
 

Functions

uint8_t UECompressBinkAudio (void *PcmData, uint32_t PcmDataLen, uint32_t PcmRate, uint8_t PcmChannels, uint8_t Quality, uint8_t GenerateSeekTable, uint16_t SeekTableMaxEntries, BAUECompressAllocFnType *MemAlloc, BAUECompressFreeFnType *MemFree, void **OutData, uint32_t *OutDataLen)
 

Macro Definition Documentation

◆ BINKA_COMPRESS_ERROR_ALLOCATORS

#define BINKA_COMPRESS_ERROR_ALLOCATORS   5

◆ BINKA_COMPRESS_ERROR_CHANS

#define BINKA_COMPRESS_ERROR_CHANS   1

◆ BINKA_COMPRESS_ERROR_OUTPUT

#define BINKA_COMPRESS_ERROR_OUTPUT   6

◆ BINKA_COMPRESS_ERROR_QUALITY

#define BINKA_COMPRESS_ERROR_QUALITY   4

◆ BINKA_COMPRESS_ERROR_RATE

#define BINKA_COMPRESS_ERROR_RATE   3

◆ BINKA_COMPRESS_ERROR_SAMPLES

#define BINKA_COMPRESS_ERROR_SAMPLES   2

◆ BINKA_COMPRESS_ERROR_SEEKTABLE

#define BINKA_COMPRESS_ERROR_SEEKTABLE   7

◆ BINKA_COMPRESS_ERROR_SIZE

#define BINKA_COMPRESS_ERROR_SIZE   8

◆ BINKA_COMPRESS_SUCCESS

#define BINKA_COMPRESS_SUCCESS   0

◆ BINKA_MAX_CHANS_STR

#define BINKA_MAX_CHANS_STR   TEXT("16")

◆ BINKA_MAX_RATE_STR

#define BINKA_MAX_RATE_STR   TEXT("256 khz")

◆ BINKA_MIN_RATE_STR

#define BINKA_MIN_RATE_STR   TEXT("2 khz")

Typedef Documentation

◆ BAUECompressAllocFnType

typedef void * BAUECompressAllocFnType(uintptr_t ByteCount)

◆ BAUECompressFreeFnType

typedef void BAUECompressFreeFnType(void *Ptr)

Function Documentation

◆ UECompressBinkAudio()

uint8_t UECompressBinkAudio ( void PcmData,
uint32_t  PcmDataLen,
uint32_t  PcmRate,
uint8_t  PcmChannels,
uint8_t  Quality,
uint8_t  GenerateSeekTable,
uint16_t  SeekTableMaxEntries,
BAUECompressAllocFnType MemAlloc,
BAUECompressFreeFnType MemFree,
void **  OutData,
uint32_t OutDataLen 
)