FVivoxCoreModule
Reference the FVivoxCoreModule class for accessing the Vivox SDK module.
Read time 1 minuteLast updated 8 months ago
An Unreal Engine 4 plugin for Vivox voice.
#include <VivoxCore.h>Inherits from FTickableGameObject, FSelfRegisteringExec, IModuleInterface, IModularFeature
Public Functions
Name | |
|---|---|
| FVivoxCoreModule() Constructor. | |
| void | StartupModule() override IModuleInterface implementation - called on Modules startup. |
| void | ShutdownModule() override IModuleInterface implementation - called on Module shutdon. |
| IClient & | VoiceClient() const The voice client. |
| AccountId | GetRandomAccountId(const FString & issuer, const FString & domain, const FString & prefix) Get a random account identifier. For internal testing purposes only. |
| ChannelId | GetRandomChannelId(const FString & issuer, const FString & domain, const FString & prefix, ChannelType type) Get a random channel identifier. For internal testing purposes only. |
| const char * | ErrorToString(VivoxCoreError error) Get the UTF-8 string for a specific error code in US English. |
Public Functions Documentation
function FVivoxCoreModule
FVivoxCoreModule()
Constructor.
function StartupModule
void StartupModule() override
IModuleInterface implementation - called on Modules startup.
function ShutdownModule
void ShutdownModule() override
IModuleInterface implementation - called on Module shutdon.
function VoiceClient
IClient & VoiceClient() const
The voice client.
Return: The voice client.
function GetRandomAccountId
static AccountId GetRandomAccountId( const FString & issuer, const FString & domain, const FString & prefix)
Get a random account identifier. For internal testing purposes only.
function GetRandomChannelId
static ChannelId GetRandomChannelId( const FString & issuer, const FString & domain, const FString & prefix, ChannelType type)
Get a random channel identifier. For internal testing purposes only.
function ErrorToString
static const char * ErrorToString( VivoxCoreError error)
Get the UTF-8 string for a specific error code in US English.