Class VivoxParticipant

Representation of a player that is in a Vivox voice and/or text channel.

Inheritance

object

VivoxParticipant

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Unity.Services.Vivox

Assembly: solution.dll

Syntax

public sealed class VivoxParticipant

Properties

Name	Description
AudioEnergy	The AudioEnergy of the participant. This can be used to create a voice activity meter for participants in a channel.
ChannelName	The unique identifier of the channel that this participant is associated with.
ChannelURI	The universal resource identifier of the channel this participant is associated with.
DisplayName	The DisplayName of the participant.
IsMuted	Whether or not this participant is muted.
IsSelf	Whether or not this participant is the logged in user.
LocalVolume	The volume of a participant only for the local user in a given channel.
ParticipantTapAudioSource	The AudioSource component of a VivoxParticipantTap gameobject if one has been created. This will be null if there is no active VivoxParticipantTap associated with this participant object.
PlayerId	The PlayerId and unique identifier of a Vivox channel participant. This will be either a Unity Authentication Service PlayerId if the Authentication package is in use, or a unique GUID assigned by Vivox during the account creation process.
SpeechDetected	Whether or not the AudioEnergy has surpassed the threshold to be considered speech.
URI	The Vivox universal resource identifier of this participant.

Methods

Name	Description
CreateVivoxParticipantTap(string, bool)	Creates a GameObject containing the VivoxParticipantTap and AudioSource for this VivoxParticipant
DestroyVivoxParticipantTap()	Destroys the GameObject containing the VivoxParticipantTap for this VivoxParticipant and sets the AudioSource to null
MutePlayerLocally()	Sets this participant as muted for the local user only in the channel associated with this participant. In order to mute this player across multiple channels you will need to iterate over ActiveChannels and leverage this method on the additional VivoxParticipant objects that match this instance's PlayerId.
SetLocalVolume(int)	Sets the volume of a participant for the local user only in the channel associated with this participant. In order to adjust the volume of this player across multiple channels you will need to iterate over ActiveChannels. Similar participants will have a matching PlayerId as the current VivoxParticipant. This only affects the audio that is heard locally, and does not change the audio that is heard by any of the other participants in a channel. Volume value is clamped between -50 and 50 with a default of 0.
UnmutePlayerLocally()	Sets this participant as unmuted for the local user only in the channel associated with this participant. In order to unmute this player across multiple channels you will need to iterate over ActiveChannels and leverage this method on the additional VivoxParticipant objects that match this instance's PlayerId.

Events

Name	Description
ParticipantAudioEnergyChanged	An event that fires if the Participants audio energy changes.
ParticipantMuteStateChanged	An event that fires if the mute state of the participant changes.
ParticipantSpeechDetected	An event that fires if the Participant's speech detected status changes.