Navigation
API > API/Plugins > API/Plugins/OnlineSubsystemUtils
| Name | UVoipListenerSynthComponent |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoipListenerSynthComponent.h |
| Include Path | #include "VoipListenerSynthComponent.h" |
Syntax
UCLASS (MinimalAPI)
class UVoipListenerSynthComponent : public USynthComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → USynthComponent → UVoipListenerSynthComponent
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UVoipListenerSynthComponent() |
VoipListenerSynthComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExternalSend | Audio::FPatchInput | This patch input can optionally be set | VoipListenerSynthComponent.h | |
| JitterDelayInSeconds | float | The amount of audio we keep buffered to reduce underruns. | VoipListenerSynthComponent.h | |
| MySampleRate | float | VoipListenerSynthComponent.h | ||
| PacketBuffer | TUniquePtr< FVoicePacketBuffer > | This is allocated on OpenPacketStream() | VoipListenerSynthComponent.h | |
| PacketBufferCriticalSection | FCriticalSection | VoipListenerSynthComponent.h | ||
| PreDelaySampleCounter | int32 | VoipListenerSynthComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
VoipListenerSynthComponent.h | ||
void ClosePacketStream() |
Close an open packet stream and start outputting silence. | VoipListenerSynthComponent.h | |
void ConnectToSplitter
(
Audio::FPatchMixerSplitter& InSplitter |
Optionally connect this VOIP Synth Component to a splitter. | VoipListenerSynthComponent.h | |
uint64 GetSampleCounter () |
This function returns the more recent sample counter of the packet currently getting played. | VoipListenerSynthComponent.h | |
bool IsIdling () |
Thread safe way to get whether this synth component still has buffered packets of audio to play back. | VoipListenerSynthComponent.h |
|
void OpenPacketStream
(
uint64 BeginningSampleCount, |
Start accepting packets with a given delay for buffering. | VoipListenerSynthComponent.h | |
void ResetBuffer
(
int32 InStartSample, |
Reset the packet stream buffer if it's already open. Using this call prevents memory churn. | VoipListenerSynthComponent.h | |
void SubmitPacket
(
void* InBuffer, |
Submit a packet to be enqueued for playback. | VoipListenerSynthComponent.h |