VoiceService Class Reference

More...

Inheritance diagram for VoiceService:

Public Member Functions
	VoiceService (IUnityVivoxServicesWrapper unityVivoxServicesWrapper, IUnityCoreService unityCoreService, ILocalPlayerInfoService localPlayerInfoService, IPlatformInfoService platformInfoService)
async Task	Initialize ()
	Initializes required dependencies for voice service.
async Task	JoinChannel ()
	Joins current room instance voice channel.Room instance is resolved from ILocalPlayerInfoService
async Task	JoinPositionalChannel ()
	Joins current room instance positional voice channel.Room instance is resolved from ILocalPlayerInfoService
void	Set3DPosition (Vector3 position, Vector3 up, Vector3 forward)
	Sets the participant's 3D position and orientation for positional audio. Parameters position The participant's position in 3D space. up The upward direction of the participant's head. forward The forward direction of the participant's head. Consider limiting how often 3D position is set (recommended every 0.3 seconds or more).
async Task	LeaveChannels ()
	Leave all active voice channels. Returns
void	ToggleMute ()
	Mutes the current user's microphone.

Properties
bool	IsInitialized [get]
	Indicates whether the service has been initialized.
bool	HasJoinedPositionalChannel [get]
	Indicates whether the current player has joined a positional audio channel.
bool	IsMuted [get]
	Indicates if current user is muted.
Properties inherited from IVoiceService

Detailed Description

Member Function Documentation

Initialize()

async Task Initialize ( )

inline

Initializes required dependencies for voice service.

Implements IVoiceService.

JoinChannel()

async Task JoinChannel ( )

inline

Joins current room instance voice channel.Room instance is resolved from ILocalPlayerInfoService

Implements IVoiceService.

JoinPositionalChannel()

async Task JoinPositionalChannel ( )

inline

Joins current room instance positional voice channel.Room instance is resolved from ILocalPlayerInfoService

Implements IVoiceService.

LeaveChannels()

async Task LeaveChannels ( )

inline

Leave all active voice channels.

Returns

Implements IVoiceService.

Set3DPosition()

void Set3DPosition ( Vector3 position, Vector3 up, Vector3 forward )

inline

Sets the participant's 3D position and orientation for positional audio.

Parameters

position	The participant's position in 3D space.
up	The upward direction of the participant's head.
forward	The forward direction of the participant's head.

Consider limiting how often 3D position is set (recommended every 0.3 seconds or more).

Implements IVoiceService.

ToggleMute()

void ToggleMute ( )

inline

Mutes the current user's microphone.

Implements IVoiceService.

Property Documentation

HasJoinedPositionalChannel

bool HasJoinedPositionalChannel

get

Indicates whether the current player has joined a positional audio channel.

Implements IVoiceService.

IsInitialized

bool IsInitialized

get

Indicates whether the service has been initialized.

Implements IVoiceService.

IsMuted

bool IsMuted

get

Indicates if current user is muted.

Implements IVoiceService.

---

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

• Runtime/Voice/VoiceService.cs