vx_evt_text_stream_updated

Reference the Vivox Core SDK API.

Read time 1 minute

Last updated 8 months ago

Module: Group Voice and Text Communications

Sent when the session text has been altered.

#include <VxcEvents.h>

Public Attributes

	Name
vx_evt_base_t	base The common properties for all events.
VX_HANDLE	sessiongroup_handle The handle created for the session group.
VX_HANDLE	session_handle The handle created for the session.
int	enabled Indicates whether text is enabled on the session.
vx_session_text_state	state Indicates the state of text (connected or disconnected).
int	incoming Indicates whether this is incoming.
int	status_code Code used to identify why a state change has been made.
char *	status_string Text (in English) used to describe the status code.

Public Attributes Documentation

variable base


vx_evt_base_t base;

The common properties for all events.

variable sessiongroup_handle


VX_HANDLE sessiongroup_handle;

The handle created for the session group.

variable session_handle


VX_HANDLE session_handle;

The handle created for the session.

variable enabled


int enabled;

Indicates whether text is enabled on the session.

variable state


vx_session_text_state state;

Indicates the state of text (connected or disconnected).

variable incoming


int incoming;

Indicates whether this is incoming.

variable status_code


int status_code;

Code used to identify why a state change has been made.

These codes are only useful for when the state is equal to session_text_disconnected. For a description of these status codes, see vx_evt_media_stream_updated

variable status_string


char * status_string;

Text (in English) used to describe the status code.

For guidelines on using this field, see vx_evt_media_stream_updated

Documentation

Development

User Acquisition

Monetization

Industry