Interface IParticipantProperties
Common properties that represent a player in a channel.
Namespace: VivoxUnity
Assembly: VivoxUnity.dll
Syntax
public interface IParticipantPropertiesProperties
AudioEnergy
The energy or intensity of the participant audio.
Declaration
double AudioEnergy { get; }Property Value
| Type | Description |
|---|---|
| double |
Remarks
This determines how loud the user is speaking. This is a value between 0 and 1.
By default, participant property events send only on participant state change (for example, when a participant starts talking, stops talking, is muted, or is unmuted). If set to a per second rate, messages send at that rate if there has been a change since the last update message. This is always true unless the participant is muted through the SDK, which causes no audio energy and no state changes.
Caution: Audio energy might not reach 0 when the user stops speaking, even if the capture device is physically muted. This is because the SDK might still pick up background noise or interference from the physically muted device. To ensure that audio energy reaches 0, the capture device must be muted through the SDK.
InAudio
If true, the user is in audio.
Declaration
bool InAudio { get; }Property Value
| Type | Description |
|---|---|
| bool |
InText
If true, the user is in text.
Declaration
bool InText { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsMutedForAll
Indicates whether the user has been muted for all users.
Declaration
bool IsMutedForAll { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsSelf
True if this participant corresponds to the currently connected user.
Declaration
bool IsSelf { get; }Property Value
| Type | Description |
|---|---|
| bool |
LocalMute
Silence or un-silence this participant only for the currently connected user.
Declaration
bool LocalMute { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
LocalVolumeAdjustment
Set the gain for this user. This applies only for the currently signed in user.
Declaration
int LocalVolumeAdjustment { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Remarks
The valid range is between -50 and 50. Positive values increase volume, and negative values decrease volume. Zero (default) leaves the volume unchanged.
SpeechDetected
If true, the user is speaking.
Declaration
bool SpeechDetected { get; }Property Value
| Type | Description |
|---|---|
| bool |
UnavailableCaptureDevice
If true, the user has no available capture device.
Declaration
bool UnavailableCaptureDevice { get; }Property Value
| Type | Description |
|---|---|
| bool |
UnavailableRenderDevice
If true, the user has no available render device.
Declaration
bool UnavailableRenderDevice { get; }Property Value
| Type | Description |
|---|---|
| bool |