IAudioFormat

Interface for audio formats.

Windows
MacOS
Linux

References

Module

TargetPlatform

Header

/Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h

Include

#include "Interfaces/IAudioFormat.h"

Syntax

class IAudioFormat

Remarks

Interface for audio formats.

Destructors

Name Description

Public function Virtual

~IAudioFormat()

Virtual destructor.

Functions

Name Description

Public function Virtual Const

bool

 

AllowParallelBuild()

Checks whether parallel audio cooking is allowed.

This method is not currently used yet.

Public function Const

bool

 

Cook

(
    FName Format,
    const TArray< uint8 >& SrcBuffer,
    FSoundQualityInfo& QualityInfo,
    TArray< uint8 >& OutBuffer
)

Cooks the source data for the platform and stores the cooked data internally.

Public function Const

bool

 

CookSurround

(
    FName Format,
    const TArray< TArray< uint8 > >& S...,
    FSoundQualityInfo& QualityInfo,
    TArray< uint8 >& OutBuffer
)

Cooks up to 8 mono files into a multi-stream file (e.g. 5.1).

Public function Virtual Const

int32

 

GetMinimumSizeForInitialChunk

(
    FName Format,
    const TArray< uint8 >& SrcBuffer
)

Given the encoded buffer, returns the minimum number of bytes required to perform ICompressedAudioInfo::ReadCompressedInfo() or IStreamedCompressedInfo::ParseHeader() for this file.

Public function Const

void

 

GetSupportedFormats

(
    TArray< FName >& OutFormats
)

Gets the list of supported formats.

Public function Const

uint16

 

GetVersion

(
    FName Format
)

Gets the current version of the specified audio format.

Public function Const

int32

 

Recompress

(
    FName Format,
    const TArray< uint8 >& SrcBuffer,
    FSoundQualityInfo& QualityInfo,
    TArray< uint8 >& OutBuffer
)

Re-compresses raw PCM to the the platform dependent format, and then back to PCM.

Public function Virtual Const

bool

 

SplitDataForStreaming

(
    const TArray< uint8 >& SrcBuffer,
    TArray< TArray< uint8 >>& OutBuffe...,
    const int32 FirstChunkMaxSize,
    const int32 MaxChunkSize
)

Splits compressed data into chunks suitable for streaming audio.