Important: This is documentation for the legacy version of the Vivox Unity SDK. This documentation will be removed after July 2025. Refer to the v16 documentation for the new version of the SDK.
Channels
Vivox provides group text and voice communications through channels. Users can communicate with each other by joining the same channel.
Channels support the following functionality:
- Voice
- Voice rendered with 3D effects (positional/directional audio)
- Text
- Muting a user for oneself
- Muting a user for all users in the channel
- Forced removal of a user from a channel (kick)
Channels have the following characteristics:
- Channels are identified by channel IDs.
- Channel IDs are assigned by the game.
- Channels are platform agnostic - game clients running on different platforms interoperate with each other.
- Channels are created on demand, and inactive channels consume no Vivox resources.
| Topic | Description |
|---|---|
| Channel management | Information on the basic behavior of channels and their lifecycles. |
| Channel name criteria | Criteria for what makes an acceptable channel name. |
| Channel types | Information on the 3 channel types: Echo, group, and positional. |
| Positional channels | Information concerning the properties of positional channels. |
| Channel identifiers for large scale games | Information concerning channels in applications with a lot of concurrent users. |
| Participant management | Managing players within channels. |
| Join a channel | Steps for having a user join a channel. |
| Leave a channel | Steps to leave a channel. |
| Automatic connection recovery | Information on Vivox's built-in connection recovery function. |