AudioMixerTypes.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#include "CoreMinimal.h"
 
namespace Audio {
 
    namespace EAudioMixerStreamDataFormat
    {
        enum Type
        {
            Unknown,
            Float,
            Int16,
            Unsupported
        };
    }
 
    namespace EAudioOutputStreamState
    {
        enum Type
        {
            /* The audio stream is shutdown or not uninitialized. */
            Closed,
        
            /* The audio stream is open but not running. */
            Open,
 
            Stopped,
        
            Stopping,
 
            Running,
 
            SwappingDevice,
        };
    }
 
    // Indicates a platform-specific format
    inline FName NAME_PLATFORM_SPECIFIC(TEXT("PLATFORM_SPECIFIC"));
    inline FName NAME_PROJECT_DEFINED(TEXT("PROJECT_DEFINED"));
 
    // Supported on all platforms:
    inline FName NAME_BINKA(TEXT("BINKA"));
    inline FName NAME_ADPCM(TEXT("ADPCM"));
    inline FName NAME_PCM(TEXT("PCM"));
    inline FName NAME_OPUS(TEXT("OPUS"));
    inline FName NAME_RADA(TEXT("RADA"));
 
    // Not yet supported on all platforms as a selectable option so is included under "platform specific" enumeration for now. 
    inline FName NAME_OGG(TEXT("OGG"));
}
 
struct FAudioPlatformSettings
{
    int32 SampleRate;
 
    int32 CallbackBufferFrameSize;
 
    int32 NumBuffers;
 
    int32 MaxChannels;
 
    int32 NumSourceWorkers;
 
    static AUDIOMIXERCORE_API FAudioPlatformSettings GetPlatformSettings(const TCHAR* PlatformSettingsConfigFile);
 
    FAudioPlatformSettings()
        : SampleRate(48000)
        , CallbackBufferFrameSize(1024)
        , NumBuffers(2)
        , MaxChannels(0) // This needs to be 0 to indicate it's not overridden from the audio settings object, which is the default used on all platforms
        , NumSourceWorkers(0)
    {
    }
};