기술 자료

​
​

Development

User Acquisition

Monetization

산업 분야

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

IParticipantProperties

Reference the IParticipantProperties interface for participant properties.
읽는 시간 5분
최근 업데이트: 8달 전
Common properties that represent a player in a channel.
#include <IParticipantProperties.h>
Inherited by IParticipant

Public Types

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

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.

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
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.
Parameters:
  • 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.
Copyright © 2026 Unity Technologies
법률 정보개인정보 처리방침쿠키Documentation Terms of Use개인 정보 판매 또는 공유 금지개인정보 보호 선택(쿠키 설정)

'Unity', Unity 로고 및 기타 Unity 상표는 미국 및 기타 지역 내 Unity Technologies 또는 그 계열사의 상표 또는 등록상표입니다(자세한 내용은 여기에서 확인하세요). 기타 명칭 또는 브랜드는 해당 소유자의 상표입니다.

일부 페이지는 편의를 위해 기계 번역되었으며 부정확한 내용이 있을 수 있습니다. 정보가 상충되는 경우, 영어 버전을 우선으로 참조하세요.

  • 보고 있는 페이지

    • Public Types

    • Public Functions

    • 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

이 페이지의 문제 보고