IVoiceEncoder

Interface for encoding raw voice for transmission over the wire

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

IVoiceEncoder

References

Module

Voice

Header

/Engine/Source/Runtime/Online/Voice/Public/Interfaces/VoiceCodec.h

Include

#include "Interfaces/VoiceCodec.h"

Syntax

class IVoiceEncoder : public TSharedFromThis< IVoiceEncoder >

Remarks

Interface for encoding raw voice for transmission over the wire

Constructors

Name Description

Protected function

IVoiceEncoder()

Destructors

Name Description

Public function Virtual

~IVoiceEncoder()

Functions

Name Description

Public function

void

 

Destroy()

Cleanup the encoder

Public function Const

void

 

DumpState()

Output the state of the encoder

Public function

int32

 

Encode

(
    const uint8* RawPCMData,
    uint32 RawDataSize,
    uint8* OutCompressedData,
    uint32& OutCompressedDataSize
)

Encode a raw audio stream (expects 16bit PCM audio)

Public function

bool

 

Init

(
    int32 SampleRate,
    int32 NumChannels,
    EAudioEncodeHint EncodeHint
)

Initialize the encoder

Public function

void

 

Reset()

Reset the encoder back to its initial state

Public function

bool

 

SetBitrate

(
    int32 InBitRate
)

Adjust the encoding bitrate

Public function

bool

 

SetComplexity

(
    int32 InComplexity
)

Adjust the encoding complexity (platform specific)

Public function

bool

 

SetVBR

(
    bool bEnableVBR
)

Set the encoding to variable bitrate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss