Navigation
API > API/Developer > API/Developer/TargetPlatform > API/Developer/TargetPlatform/Interfaces
Inheritance Hierarchy
- IModularFeature
- IAudioFormat
References
| Module | TargetPlatform |
| Header | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h |
| Include | #include "Interfaces/IAudioFormat.h" |
Syntax
class IAudioFormat : public IModularFeature
Remarks
Interface for audio formats.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
IAudioFormat () |
Self Registering Constructor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Self Registering Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | Checks whether parallel audio cooking is allowed.Note: This method is not currently used yet. | |
  |
bool | Cook
(
FName Format, |
Cooks the source data for the platform and stores the cooked data internally. |
  |
bool | CookSurround
(
FName Format, |
Cooks up to 8 mono files into a multi-stream file (e.g. 5.1). |
   |
bool | ExtractSeekTableForStreaming
(
TArray< uint8 >& InOutBuffer, |
Extracts the embedded seek-table, removing it, and outputting it separately. |
   |
int32 | GetMinimumSizeForInitialChunk
(
FName Format, |
Given the encoded buffer, returns the minimum number of bytes required to perform ICompressedAudioInfo::ReadCompressedInfo() or IStreamedCompressedInfo::ParseHeader() for this file. |
  |
FName | Returns the name of the modular feature. | |
   |
TConstArrayView< int32 > | Returns the list of supported channel counts NOTE: An empty list implies all counts are supported. | |
  |
void | GetSupportedFormats
(
TArray< FName >& OutFormats |
Gets the list of supported formats. |
   |
TConstArrayView< int32 > | Returns the list of supported sample rates NOTE: An empty list implies all rates are supported. | |
  |
uint16 | GetVersion
(
FName Format |
Gets the current version of the specified audio format. |
  |
bool | IsChannelCountSupported
(
const int32 InChannelCount |
Returns true if the sample rate is supported by this codec. |
   |
bool | Returns true if this format/codec requires hardware. | |
   |
bool | IsPlatformSupported
(
const FName InPlatformName |
Returns true if the target platform name is supported |
  |
bool | IsSampleRateSupported
(
const int32 InSampleRate |
Returns true if the sample rate is supported by this codec. |
  |
int32 | Recompress
(
FName Format, |
Re-compresses raw PCM to the the platform dependent format, and then back to PCM. |
   |
bool | ||
   |
bool | SplitDataForStreaming
(
const TArray< uint8 >& SrcBuffer, |
Splits compressed data into chunks suitable for streaming audio. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FSeekTable |