IAudioFormat

Interface for audio formats.

Unreal Engine C++ API Reference > Developer > TargetPlatform > Interfaces

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

Type Name Description
  ~IAudioFormat () Virtual destructor.

Functions

Type Name Description
bool AllowParallelBuild () Checks whether parallel audio cooking is allowed.Note: This method is not currently used yet.
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.
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).
bool ExtractSeekTableForStreaming ( TArray< uint8 >& InOutBuffer, FSeekTable& OutSeektable ) Extracts the embedded seek-table, removing it, and outputting it separately.
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.
void GetSupportedFormats ( TArray< FName >& OutFormats ) Gets the list of supported formats.
uint16 GetVersion ( FName Format ) Gets the current version of the specified audio format.
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.
bool RequiresStreamingSeekTable ()  
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.

Classes

Type Name Description
Public struct FSeekTable  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library