FMAR.Comms.Voice.VoiceChannel Struct Reference

Represents a voice channel for communication. Channels are used to selectively communicate with a subset of other clients on the network. More...

Inheritance diagram for FMAR.Comms.Voice.VoiceChannel:

Public Member Functions
	VoiceChannel (string name)
	Initializes a new instance of the VoiceChannel struct.
void	NetworkSerialize< T > (BufferSerializer< T > serializer)
	Serializes or deserializes the voice channel data for network transmission.
void	AddClient (ulong clientId)
	Adds a client to the voice channel.
void	RemoveClient (ulong clientId)
	Removes a client from the voice channel.
void	AddTranscription (Transcription transcription)
	Adds or updates a transcription in the voice channel.

Public Attributes
string	name
byte	id
ulong[]	clients
Transcription[]	netTranscriptions

Detailed Description

Represents a voice channel for communication. Channels are used to selectively communicate with a subset of other clients on the network.

Constructor & Destructor Documentation

VoiceChannel()

FMAR.Comms.Voice.VoiceChannel.VoiceChannel ( string name )

inline

Initializes a new instance of the VoiceChannel struct.

Parameters

name	The name of the voice channel.

Member Function Documentation

AddClient()

void FMAR.Comms.Voice.VoiceChannel.AddClient ( ulong clientId )

inline

Adds a client to the voice channel.

Parameters

clientId

The ID of the client to add.

AddTranscription()

void FMAR.Comms.Voice.VoiceChannel.AddTranscription ( Transcription transcription )

inline

Adds or updates a transcription in the voice channel.

Parameters

transcription

The transcription to add or update.

NetworkSerialize< T >()

void FMAR.Comms.Voice.VoiceChannel.NetworkSerialize< T > ( BufferSerializer< T > serializer )

inline

Serializes or deserializes the voice channel data for network transmission.

Template Parameters

T	The type of the serializer.

Parameters

serializer

The serializer instance.

Type Constraints

T

:

IReaderWriter

RemoveClient()

void FMAR.Comms.Voice.VoiceChannel.RemoveClient ( ulong clientId )

inline

Removes a client from the voice channel.

Parameters

clientId

The ID of the client to remove.

Member Data Documentation

clients

ulong [] FMAR.Comms.Voice.VoiceChannel.clients

id

byte FMAR.Comms.Voice.VoiceChannel.id

name

string FMAR.Comms.Voice.VoiceChannel.name

netTranscriptions

Transcription [] FMAR.Comms.Voice.VoiceChannel.netTranscriptions

---

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

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