UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVoicePacket Class Referenceabstract

#include <VoiceDataCommon.h>

Public Member Functions

 FVoicePacket ()
 
virtual ~FVoicePacket ()
 
 FVoicePacket (const FVoicePacket &Other)
 
virtual uint16 GetTotalPacketSize ()=0
 
virtual uint16 GetBufferSize ()=0
 
virtual FUniqueNetIdPtr GetSender ()=0
 
virtual bool IsReliable ()=0
 
virtual void Serialize (class FArchive &Ar)=0
 
virtual uint64 GetSampleCounter () const
 

Detailed Description

Defines the data involved in a voice packet

Constructor & Destructor Documentation

◆ FVoicePacket() [1/2]

FVoicePacket::FVoicePacket ( )
inline

Zeros members and validates the assumptions

◆ ~FVoicePacket()

virtual FVoicePacket::~FVoicePacket ( )
inlinevirtual

Should only be used by TSharedPtr and FVoiceData

◆ FVoicePacket() [2/2]

FVoicePacket::FVoicePacket ( const FVoicePacket Other)
inline

Copies another packet and inits the ref count

Parameters
Otherpacket to copy
InRefCountthe starting ref count to use

Member Function Documentation

◆ GetBufferSize()

virtual uint16 FVoicePacket::GetBufferSize ( )
pure virtual
Returns
the amount of space used by the internal voice buffer

◆ GetSampleCounter()

virtual uint64 FVoicePacket::GetSampleCounter ( ) const
inlinevirtual

Return the index of the first sample of this packet in the audio stream.

◆ GetSender()

virtual FUniqueNetIdPtr FVoicePacket::GetSender ( )
pure virtual
Returns
the sender of this voice packet

◆ GetTotalPacketSize()

virtual uint16 FVoicePacket::GetTotalPacketSize ( )
pure virtual
Returns
the amount of space this packet will consume in a buffer

◆ IsReliable()

virtual bool FVoicePacket::IsReliable ( )
pure virtual
Returns
true if this packet should be sent reliably

◆ Serialize()

virtual void FVoicePacket::Serialize ( class FArchive Ar)
pure virtual

Serialize the voice packet data to a buffer

Parameters
Arbuffer to write into

The documentation for this class was generated from the following file: