ClientVoiceProcessor Class Reference

Abstract base class for processing client voice data from a broadcaster. More...

Inheritance diagram for ClientVoiceProcessor:

Public Types
enum	ClientServerModeFlags { None = 0 , Server = 1 , Client = 2 }
	Flags describing which channels a voice will be broadcast to. More...

Public Member Functions
void	OnClientDataReceived (float[] data)
	Called when client data is received.
void	OnJoinVoiceChannel ()
	Called when joining a voice channel.
void	OnLeaveVoiceChannel ()
	Called when leaving a voice channel.
void	OnSampleRateChanged (int sampleRate)
	Called when the sample rate changes.

Properties
ClientServerModeFlags	ClientServerMode [get]
	Gets the client-server mode flags.
ClientVoiceBroadcaster	ClientVoiceBroadcaster [get, set]
	The client broadcaster instance this processor is processing data from.

Detailed Description

Abstract base class for processing client voice data from a broadcaster.

Member Enumeration Documentation

ClientServerModeFlags

enum ClientVoiceProcessor.ClientServerModeFlags

Flags describing which channels a voice will be broadcast to.

Enumerator
None
Server
Client

Member Function Documentation

OnClientDataReceived()

void ClientVoiceProcessor.OnClientDataReceived ( float[] data )

abstract

Called when client data is received.

Parameters

data	The received voice data.

OnJoinVoiceChannel()

void ClientVoiceProcessor.OnJoinVoiceChannel ( )

abstract

Called when joining a voice channel.

OnLeaveVoiceChannel()

void ClientVoiceProcessor.OnLeaveVoiceChannel ( )

abstract

Called when leaving a voice channel.

OnSampleRateChanged()

void ClientVoiceProcessor.OnSampleRateChanged ( int sampleRate )

abstract

Called when the sample rate changes.

Parameters

sampleRate

The new sample rate.

Property Documentation

ClientServerMode

ClientServerModeFlags ClientVoiceProcessor.ClientServerMode

get

Gets the client-server mode flags.

ClientVoiceBroadcaster

ClientVoiceBroadcaster ClientVoiceProcessor.ClientVoiceBroadcaster

getset

The client broadcaster instance this processor is processing data from.

---

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

• /github/workspace/Packages/FMAR/Comms/Voice/Runtime/Scripts/ClientVoiceProcessor.cs