Interface IParticipant

A participant in a channel. Note: The key for this interface is not the account ID; it is a unique identifier of that participant's session in that channel.

Inherited Members

IKeyedItemNotifyPropertyChanged<string>.Key

INotifyPropertyChanged.PropertyChanged

IParticipantProperties.IsSelf

IParticipantProperties.InAudio

IParticipantProperties.InText

IParticipantProperties.UnavailableCaptureDevice

IParticipantProperties.UnavailableRenderDevice

IParticipantProperties.SpeechDetected

IParticipantProperties.AudioEnergy

IParticipantProperties.LocalVolumeAdjustment

IParticipantProperties.LocalMute

IParticipantProperties.IsMutedForAll

Namespace: VivoxUnity

Assembly: VivoxUnity.dll

Syntax

public interface IParticipant : IKeyedItemNotifyPropertyChanged<string>, INotifyPropertyChanged, IParticipantProperties

Properties

Account

The account ID of this participant.

Declaration

AccountId Account { get; }

Property Value

Type	Description
AccountId

ParentChannelSession

The ChannelSession that owns this participant.

Declaration

IChannelSession ParentChannelSession { get; }

Property Value

Type	Description
IChannelSession

ParticipantId

The unique identifier for this participant. This is not the same as Account.

Declaration

string ParticipantId { get; }

Property Value

Type	Description
string

Methods

SetIsMuteForAll(bool, AsyncCallback)

Mute or unmute a given user for all other users in a channel.

Declaration

IAsyncResult SetIsMuteForAll(bool setMuted, AsyncCallback callback)

Parameters

Type	Name	Description
bool	setMuted	True to mute, false to unmute.
AsyncCallback	callback	A delegate to call when this operation completes.

Returns

Type	Description
IAsyncResult

SetIsMuteForAll(bool, string, AsyncCallback)

Mute or unmute a given user for all other users in a channel. Not suggested for most uses - use the version that doesn't require an accessToken instead.

Declaration

IAsyncResult SetIsMuteForAll(bool setMuted, string accessToken, AsyncCallback callback)

Parameters

Type	Name	Description
bool	setMuted	True to mute, false to unmute.
string	accessToken	The access token that grants the user permission to mute this participant in the channel.
AsyncCallback	callback	A delegate to call when this operation completes.

Returns

Type	Description
IAsyncResult	The AsyncResult.

SetIsMuteForAll(string, bool, AsyncCallback)

Mute a given user for all other users in a channel.

Declaration

[Obsolete("Use SetIsMuteForAll without the 'accountHandle' parameter instead")]
IAsyncResult SetIsMuteForAll(string accountHandle, bool setMuted, AsyncCallback callback)

Parameters

Type	Name	Description
string	accountHandle	The account handle of the user you are muting.
bool	setMuted	True to mute, false to unmute.
AsyncCallback	callback	A delegate to call when this operation completes.

Returns

Type	Description
IAsyncResult	The AsyncResult.

SetIsMuteForAll(string, bool, string, AsyncCallback)

Mute a given user for all other users in a channel. Not suggested for most uses - use the version that doesn't require an accessToken instead.

Declaration

[Obsolete("Use SetIsMuteForAll without the 'accountHandle' parameter instead")]
IAsyncResult SetIsMuteForAll(string accountHandle, bool setMuted, string accessToken, AsyncCallback callback)

Parameters

Type	Name	Description
string	accountHandle	The account handle of the user you are muting.
bool	setMuted	True to mute, false to unmute.
string	accessToken	The access token that grants the user permission to mute this participant in the channel.
AsyncCallback	callback	A delegate to call when this operation completes.

Returns

Type	Description
IAsyncResult	The AsyncResult.