IParticipantProperties

Reference the IParticipantProperties interface for participant properties.

読み終わるまでの所要時間 4 分

最終更新 1日前

Common properties that represent a player in a channel.

#include <IParticipantProperties.h>

Inherited by IParticipant

Public Types

	Name
typedef FDelegateBeginSetLocalVolumeAdjustmentCompleted::FDelegate	FOnBeginSetLocalVolumeAdjustmentCompletedDelegate The delegate called when `BeginSetLocalVolumeAdjustment()` completes.
typedef FDelegateBeginSetLocalMuteCompleted::FDelegate	FOnBeginSetLocalMuteCompletedDelegate The delegate called when `BeginSetLocalMute()` completes.
typedef FDelegateBeginSetIsMutedForAllCompleted::FDelegate	FOnBeginSetIsMutedForAllCompletedDelegate The delegate that is called when `BeginSetIsMutedForAll()` completes.

Public Functions

	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.

Public Types Documentation

typedef FOnBeginSetLocalVolumeAdjustmentCompletedDelegate


typedef FDelegateBeginSetLocalVolumeAdjustmentCompleted::FDelegate IParticipantProperties::FOnBeginSetLocalVolumeAdjustmentCompletedDelegate;

The delegate called when

BeginSetLocalVolumeAdjustment()

completes.

typedef FOnBeginSetLocalMuteCompletedDelegate


typedef FDelegateBeginSetLocalMuteCompleted::FDelegate IParticipantProperties::FOnBeginSetLocalMuteCompletedDelegate;

The delegate called when

BeginSetLocalMute()

completes.

typedef FOnBeginSetIsMutedForAllCompletedDelegate


typedef FDelegateBeginSetIsMutedForAllCompleted::FDelegate IParticipantProperties::FOnBeginSetIsMutedForAllCompletedDelegate;

The delegate that is called when

BeginSetIsMutedForAll()

completes.

Public Functions Documentation

function IsSelf


virtual bool IsSelf() const =0

True if this participant corresponds to the currently connected user.

function InAudio


virtual bool InAudio() const =0

If true, the user is in audio.

function InText


virtual bool InText() const =0

If true, the user is in text.

function SpeechDetected


virtual bool SpeechDetected() const =0

If true, the user is speaking.

function AudioEnergy


virtual double AudioEnergy() const =0

The audio energy for this user. You can use this to build a VU meter for this user.

function LocalVolumeAdjustment


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.

function SetLocalVolumeAdjustment


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. Deprecated: Use IParticipantProperties::BeginSetLocalVolumeAdjustment() instead; will be removed in a future release.

function BeginSetLocalVolumeAdjustment


virtual VivoxCoreError BeginSetLocalVolumeAdjustment(    int value,    FOnBeginSetLocalVolumeAdjustmentCompletedDelegate theDelegate =FOnBeginSetLocalVolumeAdjustmentCompletedDelegate()) =0

value The audio gain value to set.
theDelegate A delegate to call when this operation completes.

Return: 0 on success, or VxErrorInvalidArgument if the value is outside of -50 -> 50.

function LocalMute


virtual bool LocalMute() const =0

Returns the muted status of the participant for only the currently connected user.

function SetLocalMute


virtual void SetLocalMute(    bool value) =0

Use this to silence or un-silence this participant for only the currently connected user. Deprecated: Use IParticipantProperties::BeginSetLocalMute() instead; will be removed in a future release.

function BeginSetLocalMute


virtual VivoxCoreError BeginSetLocalMute(    bool value,    FOnBeginSetLocalMuteCompletedDelegate theDelegate =FOnBeginSetLocalMuteCompletedDelegate()) =0

Use this to silence or un-silence this participant for only the currently connected user. Parameters:

value True to mute, false to unmute.
theDelegate A delegate to call when this operation completes.

Return: 0 on success.

function IsTyping


virtual bool IsTyping() const =0

Indicates if the user is currently typing.

function IsMutedForAll


virtual bool IsMutedForAll() const =0

Indicates if the user is muted for all users.

function UnavailableRenderDevice


virtual bool UnavailableRenderDevice() const =0

Indicates if the user has an available render device.

function UnavailableCaptureDevice


virtual bool UnavailableCaptureDevice() const =0

Indicates if the user has an available capture device.

function BeginSetIsMutedForAll


virtual VivoxCoreError BeginSetIsMutedForAll(    bool setMuted,    const FString & accessToken,    FOnBeginSetIsMutedForAllCompletedDelegate theDelegate =FOnBeginSetIsMutedForAllCompletedDelegate()) const =0

Silence or un-silence this participant for everyone in the channel. Parameters:

setMuted True to mute, false to unmute.
accessToken The access token that grants the user permission to mute this participant in the channel.
theDelegate A delegate to call when this operation completes.

Return: 0 on success, or VxErrorInvalidArgument if accessToken is empty. Remark: Developers of games that do not have secure communications requirements can use GetMuteForAllToken() to generate the required access token.

function GetMuteForAllToken


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. Parameters:

tokenSigningKey The key that corresponds to the issuer for this account that is used to sign the token.
tokenExpirationDuration The length of time the token is valid for.

Return: A token that can be used to mute a participant in a channel. Remark: To be used only by applications without secure communications requirements.

ドキュメント

Development

User Acquisition

Monetization

産業

ドキュメント

Development

User Acquisition

Monetization

産業

Vivox Unreal SDK

Vivox Unreal SDK

IParticipantProperties

Public Types

Name

Public Functions

Name

Public Types Documentation

typedef FOnBeginSetLocalVolumeAdjustmentCompletedDelegate

typedef FOnBeginSetLocalMuteCompletedDelegate

typedef FOnBeginSetIsMutedForAllCompletedDelegate

Public Functions Documentation

function IsSelf

function InAudio

function InText

function SpeechDetected

function AudioEnergy

function LocalVolumeAdjustment

function SetLocalVolumeAdjustment

function BeginSetLocalVolumeAdjustment

function LocalMute

function SetLocalMute

function BeginSetLocalMute

function IsTyping

function IsMutedForAll

function UnavailableRenderDevice

function UnavailableCaptureDevice

function BeginSetIsMutedForAll

function GetMuteForAllToken