Method JoinPositionalChannelAsync
JoinPositionalChannelAsync(string, ChatCapability, Channel3DProperties, ChannelOptions)
Puts the user in a 3-D/positional group channel using channelName as the unique identifier.
This channel type is similar to having a conversation in-person involving nuances such as audio attenutation and falloff.
The features of a positional channel can be configured by using the Channel3DProperties class. See this class for an in-depth explanation of these features.
If you are not logged into the Vivox service when this is called, you will be automatically logged in.
Declaration
Task JoinPositionalChannelAsync(string channelName, ChatCapability chatCapability, Channel3DProperties positionalChannelProperties, ChannelOptions channelOptions = null)
Parameters
Type |
Name |
Description |
string |
channelName |
A unique identifier for the channel.
|
ChatCapability |
chatCapability |
Used to indicate what type of capabilities the user wants when joining a channel.
|
Channel3DProperties |
positionalChannelProperties |
Configuration properties for a 3-D/positional channel.
|
ChannelOptions |
channelOptions |
General channel configuration options to be used when joining the channel.
|
Returns
Type |
Description |
Task |
Task for the operation
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.