VoiceModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Interfaces/VoiceCapture.h"
#include "Interfaces/VoiceCodec.h"
#include "Net/VoiceConfig.h"
 
#define DEFAULT_VOICE_SAMPLE_RATE 16000
#define VOICE_SAMPLE_RATE DEFAULT_VOICE_SAMPLE_RATE
 
class IVoiceCapture;
class IVoiceEncoder;
class IVoiceDecoder;
 
VOICE_API DECLARE_LOG_CATEGORY_EXTERN(LogVoice, Display, All);
VOICE_API DECLARE_LOG_CATEGORY_EXTERN(LogVoiceEncode, Display, All);
VOICE_API DECLARE_LOG_CATEGORY_EXTERN(LogVoiceDecode, Display, All);
 
DECLARE_LOG_CATEGORY_EXTERN(LogVoiceCapture, Warning, All);
 
class FVoiceModule : 
    public IModuleInterface
{
 
public:
 
    static inline FVoiceModule& Get()
    {
        return FModuleManager::LoadModuleChecked<FVoiceModule>("Voice");
    }
 
    static inline bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded("Voice");
    }
 
    virtual TSharedPtr<IVoiceCapture> CreateVoiceCapture(const FString& DeviceName, int32 SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels = UVOIPStatics::GetVoiceNumChannels());
 
    virtual TSharedPtr<IVoiceEncoder> CreateVoiceEncoder(int32 SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels = UVOIPStatics::GetVoiceNumChannels(), EAudioEncodeHint EncodeHint = UVOIPStatics::GetAudioEncodingHint());
 
    virtual TSharedPtr<IVoiceDecoder> CreateVoiceDecoder(int32 SampleRate = UVOIPStatics::GetVoiceSampleRate(), int32 NumChannels = UVOIPStatics::GetVoiceNumChannels());
 
    virtual bool DoesPlatformSupportVoiceCapture();
 
    inline bool IsVoiceEnabled() const
    {
        return bEnabled;
    }
 
private:
 
    IVoiceEncoder* CreateVoiceEncoderObject(int32 SampleRate, int32 NumChannels, EAudioEncodeHint EncodeHint);
    IVoiceDecoder* CreateVoiceDecoderObject(int32 SampleRate, int32 NumChannels);
 
    // IModuleInterface
 
    virtual void StartupModule() override;
    
    virtual void ShutdownModule() override;
 
    bool bEnabled;
};