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

IClient

Reference the IClient interface for initializing and managing Vivox connections.
Read time 2 minutes
Last updated 8 months ago
Provides access to the Vivox voice system.
#include <IClient.h>

Public Functions

Name

virtual VivoxCoreErrorInitialize(VivoxConfig sdkConfig =VivoxConfig()) =0
Initializes this Client instance. If the client is already initialized, then this does nothing and returns VxErrorAlreadyInitialized.
virtual voidUninitialize() =0
Uninitialize this Client instance. If this Client instance is not initialized, then this does nothing.
virtual ILoginSession &GetLoginSession(const AccountId & loginSessionId) =0
Gets the LoginSession object for the provided accountId, and creates one if necessary.
virtual const TMap< AccountId, TSharedPtr< ILoginSession > > &LoginSessions() =0
All of the login sessions that are associated with this Client instance.
virtual IAudioDevices &AudioInputDevices() =0
The audio input devices that are associated with this Client instance.
virtual IAudioDevices &AudioOutputDevices() =0
The audio output devices that are associated with this Client instance.
FStringInternalVersion()
The internal version of the low-level vivoxsdk library.
FStringInternalVersionExtended()
The internal version of the low-level vivoxsdk library with extended information.

Public Functions Documentation

function Initialize

virtual VivoxCoreError Initialize(    VivoxConfig sdkConfig =VivoxConfig()) =0
Initializes this Client instance. If the client is already initialized, then this does nothing and returns VxErrorAlreadyInitialized.
Parameters:
  • sdkConfig The config to initialize with, which allows for the customization of certain aspects of the Vivox SDK.
Return: VxErrorSuccess under most circumstances. Note that failures to initialize are rare.

function Uninitialize

virtual void Uninitialize() =0
Uninitialize this Client instance. If this Client instance is not initialized, then this does nothing.

function GetLoginSession

virtual ILoginSession & GetLoginSession(    const AccountId & loginSessionId) =0
Gets the LoginSession object for the provided accountId, and creates one if necessary.
Parameters:
  • loginSessionId The AccountId for this login session.
Return: The login session for that accountId.
Remark: If a new login session is created, then LoginSessions.AfterKeyAdded is raised.

function LoginSessions

virtual const TMap< AccountId, TSharedPtr< ILoginSession > > & LoginSessions() =0
All of the login sessions that are associated with this Client instance.

function AudioInputDevices

virtual IAudioDevices & AudioInputDevices() =0
The audio input devices that are associated with this Client instance.

function AudioOutputDevices

virtual IAudioDevices & AudioOutputDevices() =0
The audio output devices that are associated with this Client instance.

function InternalVersion

static FString InternalVersion()
The internal version of the low-level vivoxsdk library.

function InternalVersionExtended

static FString InternalVersionExtended()
The internal version of the low-level vivoxsdk library with extended information.
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

    • Public Functions Documentation

      • function Initialize

      • function Uninitialize

      • function GetLoginSession

      • function LoginSessions

      • function AudioInputDevices

      • function AudioOutputDevices

      • function InternalVersion

      • function InternalVersionExtended

Report a problem with this page