Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystemUtils > FVoiceEngineImpl > ReadLocalVoiceData > FVoiceEngineImpl::ReadLocalVoiceData

Light Theme

Dark Theme

FVoiceEngineImpl::ReadLocalVoiceData

Reads local voice data for the specified local talker.

Windows

MacOS

Linux

Override Hierarchy

IVoiceEngine::ReadLocalVoiceData()

FVoiceEngineImpl::ReadLocalVoiceData()

References

Module	OnlineSubsystemUtils
Header	/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/VoiceEngineImpl.h
Include	#include "VoiceEngineImpl.h"

Syntax

virtual uint32 ReadLocalVoiceData
(
    uint32 LocalUserNum,
    uint8 * Data,
    uint32 * Size
)

Remarks

Reads local voice data for the specified local talker. The size field contains the buffer size on the way in and contains the amount read on the way out

Returns

0 upon success, an error code otherwise

Parameters

Parameter	Description
UserIndex	the local talker that is having their data read
Data	the buffer to copy the voice data into
Size	in: the size of the buffer, out: the amount of data copied
OutSampleCount	Optional parameter for the starting sample of this voice data. Used for sorting packets received out of order.

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

Take our survey

Dismiss