Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

ChannelId

Reference the ChannelId class for representing Vivox channels.
Read time 2 minutesLast updated 2 days ago
The unique identifier for a channel. Channels are created and destroyed automatically on demand. 
#include <ChannelId.h>

Public Functions

Name

ChannelIdCreateFromUri(const FString & uri, const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
Internal use only.
boolIsNullOrEmpty(ChannelId * id)
True if the ID is null or empty.
ChannelId()
Constructor.
ChannelId(const FString & issuer, const FString & name, const FString & domain, ChannelType type =ChannelType::NonPositional, Channel3DProperties properties =Channel3DProperties(), const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
Constructor.
const FString &Issuer() const
The issuer that is responsible for authenticating this channel.
const FString &Name() const
The name you assigned to the channel.
const FString &Domain() const
The Vivox domain that provides service for this channel.
ChannelTypeType() const
The type of channel.
Channel3DPropertiesProperties() const
The 3D properties of the channel.
const FString &UnityEnvironmentId() const
The Unity Environment of the UGS Project.
boolIsEmpty() const
True if Issuer, Name, and Domain are all empty, and Type is NonPositional.
boolIsValid() const
True if Issuer and Domain are non-empty, and Name and Properties meet restrictions.
FStringToString() const
Internal use only.

Public Functions Documentation

function CreateFromUri

static ChannelId CreateFromUri(    const FString & uri,    const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
Internal use only.

function IsNullOrEmpty

static bool IsNullOrEmpty(    ChannelId * id)
True if the ID is null or empty.

function ChannelId

ChannelId()
Constructor.

function ChannelId

ChannelId(    const FString & issuer,    const FString & name,    const FString & domain,    ChannelType type =ChannelType::NonPositional,    Channel3DProperties properties =Channel3DProperties(),    const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
Constructor. Parameters:
  • issuer The issuer that is responsible for authenticating this channel.
  • name The name you assigned to the channel.
  • domain The Vivox domain that provides service for this channel, for example: mt1s.vivox.com.
  • type The type of channel, each with built-in characteristics (for example, 3D positional effects).
  • properties The 3D properties of the channel. Note: This is optional, and is only used for positional channels.
  • unityEnvironmentId The Unity Environment Id, from the Unity Dashboard, to be embedded in the Accounts URI, primarily for Moderation requests
Remark: Name must not exceed 200 characters, and can only use the letters A-Z and a-z, the numbers 0-9, and the special characters =+-_.!~()%

function Issuer

const FString & Issuer() const
The issuer that is responsible for authenticating this channel.

function Name

const FString & Name() const
The name you assigned to the channel.

function Domain

const FString & Domain() const
The Vivox domain that provides service for this channel.

function Type

ChannelType Type() const
The type of channel.

function Properties

Channel3DProperties Properties() const
The 3D properties of the channel.

function UnityEnvironmentId

const FString & UnityEnvironmentId() const
The Unity Environment of the UGS Project.

function IsEmpty

bool IsEmpty() const
True if Issuer, Name, and Domain are all empty, and Type is NonPositional.

function IsValid

bool IsValid() const
True if Issuer and Domain are non-empty, and Name and Properties meet restrictions.

function ToString

FString ToString() const
Internal use only.