UVoipListenerSynthComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

OnlineSubsystemUtils

Header

/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoipListenerSynthComponent.h

Include

#include "VoipListenerSynthComponent.h"

Syntax

UCLASS()
class UVoipListenerSynthComponent : public USynthComponent

Destructors

Functions

Name Description

Public function

void

 

ClosePacketStream()

Close an open packet stream and start outputting silence.

Public function

void

 

ConnectToSplitter

(
    Audio::FPatchMixerSplitter& InSpli...
)

Optionally connect this VOIP Synth Component to a splitter.

Public function

uint64

 

GetSampleCounter()

This function returns the more recent sample counter of the packet currently getting played.

Public function UFunction BlueprintCallable, Category

bool

 

IsIdling()

Thread safe way to get whether this synth component still has buffered packets of audio to play back.

Public function

void

 

OpenPacketStream

(
    uint64 BeginningSampleCount,
    int32 BufferSize,
    float JitterDelay
)

Start accepting packets with a given delay for buffering.

Public function

void

 

ResetBuffer

(
    int32 InStartSample,
    float JitterDelay
)

Reset the packet stream buffer if it's already open. Using this call prevents memory churn.

Public function

void

 

SubmitPacket

(
    void* InBuffer,
    int32 NumBytes,
    int64 InStartSample,
    EVoipStreamDataFormat DataFormat
)

Submit a packet to be enqueued for playback.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.