Interface IVivoxService

Namespace: Unity.Services.Vivox

Assembly: Unity.Services.Vivox.dll

Syntax

public interface IVivoxService

Properties

AccessToken

Returns the current player's access token when they are signed in, otherwise null.

Declaration

string AccessToken { get; }

Property Value

Type	Description
string

Client

Object that is used to start the Vivox service and also houses the current LoginSession for a user which is used to perform operations such as joining channels.

Declaration

Client Client { get; }

Property Value

Type	Description
Client

Domain

The Domain value placed into the Vivox tab of the Project Settings

Declaration

string Domain { get; }

Property Value

Type	Description
string

EnvironmentId

Returns the current environment ID when they are signed in, otherwise null.

Declaration

string EnvironmentId { get; }

Property Value

Type	Description
string

IsAuthenticated

We are authenticated if we have successfully retrieved both an Environment ID and a Player ID The implementation can handle things differently if we are not authenticated and cannot produce the EnvID and PlayerID.

Declaration

bool IsAuthenticated { get; }

Property Value

Type	Description
bool

IsEnvironmentCustom

Whether or not the credentials were automatically pulled from the Unity Dashboard, or input by hand from the Vivox Developer Portal

Declaration

bool IsEnvironmentCustom { get; }

Property Value

Type	Description
bool

Issuer

The Issuer value placed into the Vivox tab of the Project Settings

Declaration

string Issuer { get; }

Property Value

Type	Description
string

PlayerId

Returns the current player's ID when they are signed in, otherwise null.

Declaration

string PlayerId { get; }

Property Value

Type	Description
string

Server

The Server value placed into the Vivox tab of the Project Settings

Declaration

string Server { get; }

Property Value

Type	Description
string

Methods

Initialize(VivoxConfig)

Initializes the Client object which will enable a user to login and check/manage audio devices.

Declaration

void Initialize(VivoxConfig config = null)

Parameters

Type	Name	Description
VivoxConfig	config	Configuration options for the Vivox SDK