1. Epic GamesDeveloper
  3. IAudioFormat

IAudioFormat

Interface for audio formats.

API > API/Developer > API/Developer/TargetPlatform

Interface for audio formats.

   
Name IAudioFormat
Type class
Header File /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h
Include Path #include "Interfaces/IAudioFormat.h"

Syntax

class IAudioFormat : public IModularFeature

Constructors

Name Remarks Include Path Unreal Specifiers

IAudioFormat()

 Self Registering Constructor Interfaces/IAudioFormat.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAudioFormat()

 Self Registering Virtual destructor. Interfaces/IAudioFormat.h  

Structs

Name Remarks
FSeekTable  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AllowParallelBuild()

 Checks whether parallel audio cooking is allowed.Note: This method is not currently used yet. Interfaces/IAudioFormat.h  

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

 Cooks the source data for the platform and stores the cooked data internally. Interfaces/IAudioFormat.h  

bool CookSurround ( FName Format,
const TArray< TArray< uint8 > >& SrcBuffers,
FSoundQualityInfo& QualityInfo,
TArray< uint8 >& OutBuffer
) const

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

virtual bool ExtractSeekTableForStreaming ( TArray< uint8 >& InOutBuffer,
FSeekTable& OutSeektable
) const

 Extracts the embedded seek-table, removing it, and outputting it separately. Interfaces/IAudioFormat.h  

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

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

virtual TConstArrayView< int32 > GetSupportedChannelCounts()

 Returns the list of supported channel counts NOTE: An empty list implies all counts are supported. Interfaces/IAudioFormat.h  

void GetSupportedFormats ( TArray< FName >& OutFormats
) const

 Gets the list of supported formats. Interfaces/IAudioFormat.h  

virtual TConstArrayView< int32 > GetSupportedSampleRates()

 Returns the list of supported sample rates NOTE: An empty list implies all rates are supported. Interfaces/IAudioFormat.h  

uint16 GetVersion ( FName Format
) const

 Gets the current version of the specified audio format. Interfaces/IAudioFormat.h  

bool IsChannelCountSupported ( const int32 InChannelCount
) const

 Returns true if the sample rate is supported by this codec. Interfaces/IAudioFormat.h  

virtual bool IsHardwareFormat()

 Returns true if this format/codec requires hardware. Interfaces/IAudioFormat.h  

virtual bool IsPlatformSupported ( const FName InPlatformName
) const

 Returns true if the target platform name is supported Interfaces/IAudioFormat.h  

bool IsSampleRateSupported ( const int32 InSampleRate
) const

 Returns true if the sample rate is supported by this codec. Interfaces/IAudioFormat.h  

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

 Re-compresses raw PCM to the the platform dependent format, and then back to PCM. Interfaces/IAudioFormat.h  

virtual bool RequiresStreamingSeekTable()

   Interfaces/IAudioFormat.h  

virtual bool SplitDataForStreaming ( const TArray< uint8 >& SrcBuffer,
TArray< TArray< uint8 > >& OutBuffers,
const int32 FirstChunkMaxSize,
const int32 MaxChunkSize
) const

 Splits compressed data into chunks suitable for streaming audio. Interfaces/IAudioFormat.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetModularFeatureName()

 Returns the name of the modular feature. Interfaces/IAudioFormat.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page