Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
  • Tutorials
  • Reference
    • Vivox Core Unreal class model overview
    • Vivox Unreal conventions
    • Unreal API Reference Manual
      • Class List
        • AccountId
        • Channel3DProperties
        • ChannelId
        • FVivoxCoreModule
        • IAudioDevice
        • IAudioDevices
        • IChannelConnectionState
        • IChannelSession
        • IChannelTextMessage
        • IClient
        • IDirectedTextMessage
        • ILoginSession
        • IParticipant
        • IParticipantProperties
        • IPresenceLocation
        • IPresenceSubscription
        • ITextMessage
        • ITextToSpeech
        • ITranscribedMessage
        • ITTSAudioBuffer
        • ITTSMessage
        • ITTSVoice
        • Presence
        • VivoxConfig
      • Deprecated List
    • Access Token Developer Guide
    • Server to Server Web API Reference Guide
    • Third-party license information
  1. Vivox Unreal SDK documentation

IParticipant

Reference the IParticipant interface for channel participant information.
Read time 3 minutes
Last updated 8 months ago
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::FDelegateFOnBeginSetLocalVolumeAdjustmentCompletedDelegate
The delegate called when 
BeginSetLocalVolumeAdjustment()
completes.
typedef FDelegateBeginSetLocalMuteCompleted::FDelegateFOnBeginSetLocalMuteCompletedDelegate
The delegate called when 
BeginSetLocalMute()
completes.
typedef FDelegateBeginSetIsMutedForAllCompleted::FDelegateFOnBeginSetIsMutedForAllCompletedDelegate
The delegate that is called when 
BeginSetIsMutedForAll()
completes.

Public Functions inherited from IParticipantProperties

Name

virtual boolIsSelf() const =0
True if this participant corresponds to the currently connected user.
virtual boolInAudio() const =0
If true, the user is in audio.
virtual boolInText() const =0
If true, the user is in text.
virtual boolSpeechDetected() const =0
If true, the user is speaking.
virtual doubleAudioEnergy() const =0
The audio energy for this user. You can use this to build a VU meter for this user.
virtual intLocalVolumeAdjustment() 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 VivoxCoreErrorSetLocalVolumeAdjustment(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 VivoxCoreErrorBeginSetLocalVolumeAdjustment(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 boolLocalMute() const =0
Returns the muted status of the participant for only the currently connected user.
virtual voidSetLocalMute(bool value) =0
Use this to silence or un-silence this participant for only the currently connected user.
virtual VivoxCoreErrorBeginSetLocalMute(bool value, FOnBeginSetLocalMuteCompletedDelegate theDelegate =FOnBeginSetLocalMuteCompletedDelegate()) =0
Use this to silence or un-silence this participant for only the currently connected user.
virtual boolIsTyping() const =0
Indicates if the user is currently typing.
virtual boolIsMutedForAll() const =0
Indicates if the user is muted for all users.
virtual boolUnavailableRenderDevice() const =0
Indicates if the user has an available render device.
virtual boolUnavailableCaptureDevice() const =0
Indicates if the user has an available capture device.
virtual VivoxCoreErrorBeginSetIsMutedForAll(bool setMuted, const FString & accessToken, FOnBeginSetIsMutedForAllCompletedDelegate theDelegate =FOnBeginSetIsMutedForAllCompletedDelegate()) const =0
Silence or un-silence this participant for everyone in the channel.
virtual FStringGetMuteForAllToken(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.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Public Functions

    • Additional inherited members

      • Public Types inherited from IParticipantProperties

      • Public Functions inherited from IParticipantProperties

    • Detailed Description

    • Public Functions Documentation

      • function ParticipantId

      • function ParentChannelSession

      • function Account

Report a problem with this page