Navigation
API > API/Runtime > API/Runtime/Voice
Interface for encoding raw voice for transmission over the wire
| Name | IVoiceEncoder |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/Voice/Public/Interfaces/VoiceCodec.h |
| Include Path | #include "Interfaces/VoiceCodec.h" |
Syntax
class IVoiceEncoder : public TSharedFromThis< IVoiceEncoder >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IVoiceEncoder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IVoiceEncoder() |
Interfaces/VoiceCodec.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IVoiceEncoder() |
Interfaces/VoiceCodec.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Destroy() |
Cleanup the encoder | Interfaces/VoiceCodec.h | |
void DumpState() |
Output the state of the encoder | Interfaces/VoiceCodec.h | |
int32 Encode
(
const uint8* RawPCMData, |
Encode a raw audio stream (expects 16bit PCM audio) | Interfaces/VoiceCodec.h | |
bool Init
(
int32 SampleRate, |
Initialize the encoder | Interfaces/VoiceCodec.h | |
void Reset() |
Reset the encoder back to its initial state | Interfaces/VoiceCodec.h | |
bool SetBitrate
(
int32 InBitRate |
Adjust the encoding bitrate | Interfaces/VoiceCodec.h | |
bool SetComplexity
(
int32 InComplexity |
Adjust the encoding complexity (platform specific) | Interfaces/VoiceCodec.h | |
bool SetVBR
(
bool bEnableVBR |
Set the encoding to variable bitrate | Interfaces/VoiceCodec.h |