Namespace VivoxUnity
Classes
AccountId
The unique identifier for a player that accesses a Vivox instance.
AsyncNoResult
AsyncResult<T>
Channel3DProperties
Properties to control the 3D effects applied to audio in positional channels.
ChannelId
The unique identifier for a channel. Channels are created and destroyed automatically on demand.
Client
Provide access to the Vivox system. Note: An application should have only one Client object.
Helper
ITTSMessageQueueEventArgs
The arguments for ITTSMessageQueue event notifications.
KeyEventArg<TK>
Event arguments for key collections with add and delete notifications.
QueueItemAddedEventArgs<T>
The event arguments when an item is added to an IReadOnlyQueue.
TTSMessage
A message to be spoken in the text-to-speech (TTS) subsystem.
ValueEventArg<TK, TV>
Event arguments for key collections with value changed notifications.
VivoxApiException
VivoxConfig
Used during initialization to set up the SDK with a custom configuration.
VivoxDebug
VxClient
VxTokenGen
VxUnityInterop
Structs
Presence
The presence information for a user at a location.
Interfaces
IAccessTokenServer
IAccountArchiveMessage
A text message from an account archive query.
IArchiveQueryResult
The result of a session or account archive query.
IAudioDevice
Either an audio input device (microphone) or audio output device (speaker hardware or headphones).
IAudioDevices
An interface to enumerate and manage audio devices.
IChannelSession
A connection to a channel.
IChannelTextMessage
A text message from a channel.
IDirectedMessageResult
The result of a directed message (user-to-user).
IDirectedTextMessage
A text message from one user to another user.
IFailedDirectedTextMessage
A text message from one user to another user.
IKeyedItemNotifyPropertyChanged<TK>
An interface for notifying the consumer of changes to an element in a typed collection.
ILoginSession
A session for an account.
IParticipant
A participant in a channel.
IParticipantProperties
Common properties that represent a player in a channel.
IPresenceLocation
Presence information for a user signed in at a particular location.
IPresenceSubscription
A subscription to see another user's online status.
IReadOnlyDictionary<TK, T>
A read-only dictionary that raises an event whenever an item is added, removed, or modified.
IReadOnlyHashSet<T>
A read-only hash set that raises events when keys are added or removed.
IReadOnlyQueue<T>
A queue that raises an event when an item is added.
ISessionArchiveMessage
A text message from a session archive query.
ITTSMessageQueue
ITTSVoice
A voice used by the text-to-speech (TTS) subsystem to synthesize speech.
ITextMessage
A text message.
ITextToSpeech
An interface for events and methods related to text-to-speech.
ITranscribedMessage
A transcription message.
Enums
AudioFadeModel
The distance model for a positional channel, which determines the algorithm to use when computing attenuation.
ChannelType
The type of channel.
ConnectionRecoveryState
The state of Vivox when an unexpected network disconnection occurs. Use this to display the status of the disconnect to the user, or if there is a recovery failure, to reset the game state or retry the overall Vivox connection.
ConnectionState
The state of any resource with connection semantics (media and text state).
LoginState
The state of the Login session.
MediaCodecType
Configure a set of supported audio codecs.
ParticipantPropertyUpdateFrequency
Determine how often the SDK sends participant property events while in a channel.
PresenceStatus
The online status of the user.
SubscriptionMode
Determine how to handle incoming subscriptions.
TTSDestination
A unified selection of output streams and mechanisms for text-to-speech (TTS) injection.
TTSMessageState
The state of the text-to-speech (TTS) message.
TransmissionMode
Define the policy of where microphone audio and injected audio get broadcast to.