Class VxClient
Assembly: VivoxUnity.dll
Syntax
public class VxClient : IDisposable
Fields
appId
A three letter appId that should be set to UNI. Caution: Do not set this value. Contact your Vivox representative for more information.
Declaration
public const string appId = "UNI"
Field Value
defaultRealm
Declaration
public string defaultRealm
Field Value
vivoxDebug
Declaration
public VivoxDebug vivoxDebug
Field Value
Properties
Instance
Declaration
public static VxClient Instance { get; }
Property Value
Started
Declaration
public bool Started { get; }
Property Value
Methods
BeginIssueRequest(vx_req_base_t, AsyncCallback)
Declaration
public IAsyncResult BeginIssueRequest(vx_req_base_t request, AsyncCallback callback)
Parameters
Returns
Cleanup()
Declaration
Dispose()
Declaration
Dispose(bool)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type |
Name |
Description |
| bool |
disposing |
|
EndIssueRequest(IAsyncResult)
Declaration
public vx_resp_base_t EndIssueRequest(IAsyncResult result)
Parameters
Returns
~VxClient()
Declaration
GetRandomChannelUri(string, string)
Declaration
public static string GetRandomChannelUri(string prefix, string realm)
Parameters
Returns
GetRandomUserId(string)
Declaration
public static string GetRandomUserId(string prefix)
Parameters
| Type |
Name |
Description |
| string |
prefix |
|
Returns
GetRandomUserIdEx(string, string)
Declaration
public static string GetRandomUserIdEx(string prefix, string issuer)
Parameters
Returns
GetVersion()
Declaration
public static string GetVersion()
Returns
Start(VivoxConfig)
This method is used to start VxClient.
Most implementations should use Client instead of VxClient
Declaration
public void Start(VivoxConfig config = null)
Parameters
| Type |
Name |
Description |
| VivoxConfig |
config |
Optional: config to set on initialize.
|
Start(vx_sdk_config_t)
Note: It is recommended that you use Start(VivoxConfig config) instead of this method.
This method is used to start VxClient.
Most implementation should use Client instead of VxClient
Declaration
public void Start(vx_sdk_config_t config)
Parameters
| Type |
Name |
Description |
| vx_sdk_config_t |
config |
Optional: config to set on initialize.
|
Stop()
Declaration
Events
EventMessageReceived
Declaration
public event VxClient.HandleEventMessage EventMessageReceived
Event Type
Implements
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.