Vivox SDK design

Learn about the Vivox Core client software design.

Read time 1 minute

Last updated 5 months ago

The Vivox SDK interface is based on request, response, and event messages. The game client creates request messages, fills in the fields of those messages, and sends those messages to the Vivox Client SDK by using the

vx_issue_request3()

method.

Note

vx_issue_request3()

is a non-blocking method, and you can safely call it from the game client user interface thread.

When the request completes, or when there is data available for the game client to use, the Vivox SDK makes a response message or an event message available to the game client. The game client gets access to this message by calling the

vx_get_message()

method.

Note

vx_get_message()

is a non-blocking method, and can safely call it from the game client user interface or in the game message processing loop.

After the game client has an even or response, the game client uses the information in those fields to update the game client state. The following diagram displays how messages are communicated between the game client and the Vivox SDK.

Important

There are dozens of request/response pairs and events that are exposed by the Vivox SDK, although it is rare that the game needs to make use of all of them. For a detailed mapping of individual request and response pairs and events to functional areas, see Request, response, and event mapping to Vivox functionality.

Documentation

Development

User Acquisition

Monetization

Industry