Namespace Unity.Services.Vivox

Classes

Channel3DProperties

Properties to control the 3D effects applied to audio in positional channels.

ChannelOptions

Options to set behaviour on a channel join - like making the channel the Active channel being spoken into, or having Vivox log in automatically without a seperate LoginAsync call

ChatHistoryQueryOptions

Options for ChatHistoryQuery requests. Allows for things like filtering based on specific text, timestamps, or PlayerIds

ConversationQueryOptions

Options for GetConversationsAsync(ConversationQueryOptions) requests.

InitializationOptionsExtensions

Utilities to simplify setting options related to this SDK through code.

LoginOptions

The options used to control Login behaviour - like enabling Text to Speech, setting a display name, or loading a blocked user list

MessageOptions

Used for configuring optional fields related to sending channel or direct messages.

MintException

An Exception relating to the Vivox Mint Authentication service, which checks Vivox tokens against the Unity Game Gateway

VivoxConfigurationOptions

Used during initialization to set up the SDK with a custom configuration.

VivoxConversation

Provides information about either a channel or direct message conversation.

VivoxInputDevice

An Input AudioDevice on the device connecting to Vivox. Can be a physical audio device, like a microphone, or an abstraction, like the device's default communication audio device

VivoxMessage

A Message for Vivox Text - either sent in a channel or directed, and either sent while this login was active, or requested from the Session or Account archives.

VivoxOutputDevice

An Output AudioDevice on the device connecting to Vivox. Can be a physical audio device, like a set of headphones, or an abstraction, like the device's default communication audio device.

VivoxParticipant

Representation of a player that is in a Vivox voice and/or text channel.

VivoxService

Stores the Instance of the VivoxService that is interacted with using the IVivoxService

Interfaces

IVivoxService

The interface used to interact with the VivoxService

IVivoxTokenProvider

Must be implemented by the SetTokenProvider(IVivoxTokenProvider) caller. This object's responsibility is to provide an overridable implementation that will generate tokens for Vivox actions.

Enums

AudioFadeModel

The distance model for a positional channel, which determines the algorithm to use when computing attenuation.

BluetoothProfile

Profiles used for configuring how the SDK should handle Bluetooth audio. Note: These profile configurations currently only affect mobile devices.

ChatCapability

Used to indicate what type of channel a user wants to join.

ConversationType

Used to denote different types of Vivox conversations.

MintExceptionCode

Simple mapping of HTTP error codes for easier reading

ParticipantPropertyUpdateFrequency

Determine how often the SDK sends participant property events while in a channel.

TextToSpeechMessageType

A unified selection of output streams and mechanisms for text-to-speech (TTS) injection.

TransmissionMode

Define the policy for where microphone and injected audio are broadcast to.

VivoxLogLevel

The log level for the Vivox SDK. Log level order from least to most verbose: None -> Error -> Warning -> Info -> Debug -> Trace -> All