This is the documentation for the Scripting APIs of this package.
Show / Hide Table of Contents
-
Unity.
Services. Vivox -
Audio
Fade Model - Channel3DProperties
-
Channel
Options -
Chat
Capability -
Chat
History Query Options -
Conversation
Query Options -
Conversation
Type -
IVivox
Service -
Properties
-
Active
Channels -
Active
Input Device -
Active
Output Device -
Available
Input Devices -
Available
Output Devices -
Input
Device Volume -
Is
Audio Echo Cancellation Enabled -
Is
Input Device Muted -
Is
Logged In -
Is
Output Device Muted -
Output
Device Volume -
Signed
In Player Id -
Text
To Speech Available Voices -
Text
To Speech Current Voice -
Transmitting
Channels
-
Active
-
Methods
-
Block
Player Async -
Delete
Channel Text Message Async -
Delete
Direct Text Message Async -
Disable
Acoustic Echo Cancellation -
Disable
Auto Voice Activity Detection Async -
Edit
Channel Text Message Async -
Edit
Direct Text Message Async -
Enable
Acoustic Echo Cancellation -
Enable
Auto Voice Activity Detection Async -
Get
Channel Text Message History Async -
Get
Conversations Async -
Get
Direct Text Message History Async -
Initialize
Async -
Join
Echo Channel Async -
Join
Group Channel Async -
Join
Positional Channel Async -
Leave
All Channels Async -
Leave
Channel Async -
Login
Async -
Logout
Async -
Mute
Input Device -
Mute
Output Device -
Send
Channel Text Message Async -
Send
Direct Text Message Async - Set3DPosition
-
Set
Active Input Device Async -
Set
Active Output Device Async -
Set
Channel Transmission Mode Async -
Set
Channel Volume Async -
Set
Input Device Volume -
Set
Message As Read Async -
Set
Output Device Volume -
Set
Token Provider -
Set
Voice Activity Detection Properties Async -
Text
To Speech Cancel All Messages -
Text
To Speech Cancel Messages -
Text
To Speech Send Message -
Text
To Speech Set Voice -
Unblock
Player Async -
Unmute
Input Device -
Unmute
Output Device
-
Block
-
Events
-
Available
Input Devices Changed -
Available
Output Devices Changed -
Channel
Joined -
Channel
Left -
Channel
Message Deleted -
Channel
Message Edited -
Channel
Message Received -
Connection
Failed To Recover -
Connection
Recovered -
Connection
Recovering -
Directed
Message Deleted -
Directed
Message Edited -
Directed
Message Received -
Logged
In -
Logged
Out -
Participant
Added To Channel -
Participant
Removed From Channel
-
Available
-
Properties
-
IVivox
Token Provider -
Initialization
Options Extensions -
Login
Options -
Message
Options -
Mint
Exception -
Mint
Exception Code -
Participant
Property Update Frequency -
Text
To Speech Message Type -
Transmission
Mode -
Vivox
Configuration Options -
Properties
-
Capture
Device Buffer Size Intervals -
Disable
Audio Ducking -
Disable
Device Polling -
Dynamic
Voice Processing Switching -
Enable
Advanced Auto Levels -
Enable
Dtx -
Enable
Fast Network Change Detection -
Force
Capture Silence -
Log
Level -
Lost
Rtp Timeout Ms -
Max
Logins Per User -
Never
Rtp Timeout Ms -
Render
Device Buffer Size Intervals -
Render
Source Initial Buffer Count -
Render
Source Queue Depth Max -
Skip
Prepare For Vivox -
Upstream
Jitter Frame Count -
Use
Os Proxy Settings
-
Capture
-
Properties
-
Vivox
Conversation -
Vivox
Input Device -
Vivox
Log Level -
Vivox
Message -
Vivox
Output Device -
Vivox
Participant -
Vivox
Service
-
Audio
-
Unity.
Services. Vivox. Audio Taps