FVoiceRunnerThread Logic that runs on a background-thread and will trigger the AudioCaptureHandler repeatedly on a fixed timeinterval to ensure it will send whatever was captured in the timestep to be sent to VoxtaServer microphone input socket. More...

#include <VoiceRunnerThread.h>

Inheritance diagram for FVoiceRunnerThread:

Public Member Functions
	FVoiceRunnerThread (AudioCaptureHandler *voiceComponent, float sleepTime)
	Register values for the runner but does not start it yet.

void	Start ()
	Create & start a new background thread, triggering 'CaptureAndSendVoiceData' on the provided voice component repeatedly, given the provided timestep.

virtual	~FVoiceRunnerThread () override
	Virtual destructor.

virtual void	Stop () override
	Stops the runnable object.

uint32	Run () override
	Runs the runnable object.

Detailed Description

FVoiceRunnerThread Logic that runs on a background-thread and will trigger the AudioCaptureHandler repeatedly on a fixed timeinterval to ensure it will send whatever was captured in the timestep to be sent to VoxtaServer microphone input socket.

Note: keep in mind to double check locks when using/changing anything this touches

Constructor & Destructor Documentation

◆ FVoiceRunnerThread()

FVoiceRunnerThread::FVoiceRunnerThread	(	AudioCaptureHandler *	voiceComponent,
		float	sleepTime )

Register values for the runner but does not start it yet.

Parameters

voiceComponent	The component that will receive the 'CaptureAndSendVoiceData' signal.
sleepTime	The time (in seconds) that should be waited between triggers.

◆ ~FVoiceRunnerThread()

FVoiceRunnerThread::~FVoiceRunnerThread ( )

overridevirtual

Virtual destructor.

Member Function Documentation

◆ Run()

uint32 FVoiceRunnerThread::Run ( )

override

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns: The exit code of the runnable object

See also: Init, Stop, Exit

◆ Start()

void FVoiceRunnerThread::Start ( )

Create & start a new background thread, triggering 'CaptureAndSendVoiceData' on the provided voice component repeatedly, given the provided timestep.

◆ Stop()

void FVoiceRunnerThread::Stop ( )

overridevirtual

Stops the runnable object.

This is called if a thread is requested to terminate early.

See also: Init, Run, Exit

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

Public Member Functions