IClient
Reference the IClient interface for initializing and managing Vivox connections.
阅读时间2 分钟最后更新于 8 个月前
Provides access to the Vivox voice system.
#include <IClient.h>Public Functions
Name | |
|---|---|
| virtual VivoxCoreError | Initialize(VivoxConfig sdkConfig =VivoxConfig()) =0 Initializes this Client instance. If the client is already initialized, then this does nothing and returns VxErrorAlreadyInitialized. |
| virtual void | Uninitialize() =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. |
| FString | InternalVersion() The internal version of the low-level vivoxsdk library. |
| FString | InternalVersionExtended() 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.