文档

​
​

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

FVivoxCoreModule

Reference the FVivoxCoreModule class for accessing the Vivox SDK module.
阅读时间1 分钟
最后更新于 8 个月前

An Unreal Engine 4 plugin for Vivox voice.
#include <VivoxCore.h>
Inherits from FTickableGameObject, FSelfRegisteringExec, IModuleInterface, IModularFeature

Public Functions

Name

FVivoxCoreModule()
Constructor.
voidStartupModule() override
IModuleInterface implementation - called on Modules startup.
voidShutdownModule() override
IModuleInterface implementation - called on Module shutdon.
IClient &VoiceClient() const
The voice client.
AccountIdGetRandomAccountId(const FString & issuer, const FString & domain, const FString & prefix)
Get a random account identifier. For internal testing purposes only.
ChannelIdGetRandomChannelId(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.

Copyright © 2026 Unity Technologies
法律信息隐私政策CookiesDocumentation Terms of Use请勿出售或分享我的个人信息您的隐私选择(Cookie 设置)

“Unity”、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属公司在美国和其他地方的商标或注册商标(此处查看更多信息)。其他名称或品牌是其各自所有者的商标。

为方便起见,一些页面是机器翻译的,可能包含不准确的内容。如有信息不一致的情况,以英文版本为准。

  • 在本页上
    • Public Functions

    • Public Functions Documentation

      • function FVivoxCoreModule

      • function StartupModule

      • function ShutdownModule

      • function VoiceClient

      • function GetRandomAccountId

      • function GetRandomChannelId

      • function ErrorToString


报告此页面的问题