IParticipant
Reference the IParticipant interface for channel participant information.
읽는 시간 3분최근 업데이트: 8달 전
A participant in a channel. More...
#include <IParticipant.h>Inherits from IParticipantProperties
Public Functions
Name | |
|---|---|
| virtual const FString & | ParticipantId() const =0 Identifies the participant's specific sign in location. |
| virtual IChannelSession & | ParentChannelSession() const =0 The ChannelSession that owns this participant. |
| virtual const AccountId & | Account() const =0 The AccountId associated with this participant. |
Additional inherited members
Public Types inherited from IParticipantProperties
Name | |
|---|---|
| typedef FDelegateBeginSetLocalVolumeAdjustmentCompleted::FDelegate | FOnBeginSetLocalVolumeAdjustmentCompletedDelegate The delegate called when |
| typedef FDelegateBeginSetLocalMuteCompleted::FDelegate | FOnBeginSetLocalMuteCompletedDelegate The delegate called when |
| typedef FDelegateBeginSetIsMutedForAllCompleted::FDelegate | FOnBeginSetIsMutedForAllCompletedDelegate The delegate that is called when |
Public Functions inherited from IParticipantProperties
Name | |
|---|---|
| virtual bool | IsSelf() const =0 True if this participant corresponds to the currently connected user. |
| virtual bool | InAudio() const =0 If true, the user is in audio. |
| virtual bool | InText() const =0 If true, the user is in text. |
| virtual bool | SpeechDetected() const =0 If true, the user is speaking. |
| virtual double | AudioEnergy() const =0 The audio energy for this user. You can use this to build a VU meter for this user. |
| virtual int | LocalVolumeAdjustment() const =0 The gain for this user for only the currently signed in user. The valid range is between -50 and 50. Positive values increase volume, and negative values decrease volume. Zero (the default value) leaves volume unchanged. |
| virtual VivoxCoreError | SetLocalVolumeAdjustment(int value) =0 Set the gain for this user for only the currently signed in user. The valid range is between -50 and 50. Positive values increase volume, and negative values decrease volume. Zero (the default value) leaves volume unchanged. |
| virtual VivoxCoreError | BeginSetLocalVolumeAdjustment(int value, FOnBeginSetLocalVolumeAdjustmentCompletedDelegate theDelegate =FOnBeginSetLocalVolumeAdjustmentCompletedDelegate()) =0 Set the gain for this user for only the currently signed in user. The valid range is between -50 and 50. Positive values increase volume, and negative values decrease volume. Zero (the default value) leaves volume unchanged. |
| virtual bool | LocalMute() const =0 Returns the muted status of the participant for only the currently connected user. |
| virtual void | SetLocalMute(bool value) =0 Use this to silence or un-silence this participant for only the currently connected user. |
| virtual VivoxCoreError | BeginSetLocalMute(bool value, FOnBeginSetLocalMuteCompletedDelegate theDelegate =FOnBeginSetLocalMuteCompletedDelegate()) =0 Use this to silence or un-silence this participant for only the currently connected user. |
| virtual bool | IsTyping() const =0 Indicates if the user is currently typing. |
| virtual bool | IsMutedForAll() const =0 Indicates if the user is muted for all users. |
| virtual bool | UnavailableRenderDevice() const =0 Indicates if the user has an available render device. |
| virtual bool | UnavailableCaptureDevice() const =0 Indicates if the user has an available capture device. |
| virtual VivoxCoreError | BeginSetIsMutedForAll(bool setMuted, const FString & accessToken, FOnBeginSetIsMutedForAllCompletedDelegate theDelegate =FOnBeginSetIsMutedForAllCompletedDelegate()) const =0 Silence or un-silence this participant for everyone in the channel. |
| virtual FString | GetMuteForAllToken(const FString & tokenSigningKey, FTimespan tokenExpirationDuration) const =0 Get a token that can be used to silence or un-silence a participant for everyone in a channel. |
Detailed Description
class IParticipant;
A participant in a channel.
Remark: The key for this interface is an account name returned by AccountId::Name().
Public Functions Documentation
function ParticipantId
virtual const FString & ParticipantId() const =0
Identifies the participant's specific sign in location.
Remark: Rarely used. In most implementations, use IParticipant::Account() as a unique identifier for participants in a channel instead of ParticipantId(). ParticipantId() is not the same as Account, but is the same as IPresenceLocation::LocationId(). The Account() of each participant is unique. Accounts cannot be connected to a ChannelSession from multiple locations (the location for the latest ChannelSession connection overrides locations from earlier ChannelSession connections). This will match a particular presence location when a user is signed in from more than one location.
function ParentChannelSession
virtual IChannelSession & ParentChannelSession() const =0
The ChannelSession that owns this participant.
function Account
virtual const AccountId & Account() const =0
The AccountId associated with this participant.