# FVivoxCoreModule

> Reference the FVivoxCoreModule class for accessing the Vivox SDK module.

An Unreal Engine 4 plugin for Vivox voice.

`#include <VivoxCore.h>`

Inherits from FTickableGameObject, FSelfRegisteringExec, IModuleInterface, IModularFeature

## Public Functions

|                                    | Name                                                                                                                                                                                                                                               |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|                                    | **[FVivoxCoreModule](./class_f_vivox_core_module.md#function-fvivoxcoremodule)**()Constructor.                                                                                                                                                     |
| void                               | **[StartupModule](./class_f_vivox_core_module.md#function-startupmodule)**() overrideIModuleInterface implementation - called on Modules startup.                                                                                                  |
| void                               | **[ShutdownModule](./class_f_vivox_core_module.md#function-shutdownmodule)**() overrideIModuleInterface implementation - called on Module shutdon.                                                                                                 |
| [IClient](./class_i_client.md) &   | **[VoiceClient](./class_f_vivox_core_module.md#function-voiceclient)**() constThe voice client.                                                                                                                                                    |
| [AccountId](./class_account_id.md) | **[GetRandomAccountId](./class_f_vivox_core_module.md#function-getrandomaccountid)**(const FString & issuer, const FString & domain, const FString & prefix)Get a random account identifier. For internal testing purposes only.                   |
| [ChannelId](./class_channel_id.md) | **[GetRandomChannelId](./class_f_vivox_core_module.md#function-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](./class_f_vivox_core_module.md#function-errortostring)**(VivoxCoreError error)Get the UTF-8 string for a specific error code in US English.                                                                                      |

## Public Functions Documentation

### function FVivoxCoreModule

```cpp
FVivoxCoreModule()
```

Constructor.

### function StartupModule

```cpp
void StartupModule() override
```

IModuleInterface implementation - called on Modules startup.

### function ShutdownModule

```cpp
void ShutdownModule() override
```

IModuleInterface implementation - called on Module shutdon.

### function VoiceClient

```cpp
IClient & VoiceClient() const
```

The voice client.

**Return**: The voice client.

### function GetRandomAccountId

```cpp
static AccountId GetRandomAccountId(
    const FString & issuer,
    const FString & domain,
    const FString & prefix
)
```

Get a random account identifier. For internal testing purposes only.

### function GetRandomChannelId

```cpp
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

```cpp
static const char * ErrorToString(
    VivoxCoreError error
)
```

Get the UTF-8 string for a specific error code in US English.