vx_evt_media_stream_updated

Reference the Vivox Core SDK API.

Read time 3 minutes

Last updated 8 months ago

Module: Group Voice and Text Communications

Sent when session media 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	status_code The code used to identify why a state change has been made.
char *	status_string Text (in English) to describe the status code.
vx_session_media_state	state The new state of the entity.
int	incoming Indicates whether this is an incoming call.
char *	durable_media_id The durable media identifier used to access value add services.
char *	media_probe_server The current media probe server.
vx_call_stats_t *	call_stats NULL, except for state session_media_disconnected.

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 status_code


int status_code;

The code used to identify why a state change has been made.

This code is only useful if the state is equal to session_media_disconnected. In this case, the following rules apply:

1. Any code < 400 can be ignored.
1. 401 - A password is needed to join this channel. Typically, an application presents a password dialog at this point. You can retry the request if you obtain a password from the user.
1. 403 - If the call is to a channel, the user does not have sufficient privilege to join the channel. Otherwise, the call has been declined.
1. 404 - The destination (either a channel or other user) does not exist.
1. 408 - The remote user did not answer the call. You can retry the request after a 10s delay.
1. 480 - The remote user is temporarily offline. You can retry the request after a 10s delay.
1. 486 - The remote user is busy (on another call). You can retry the request after a 10s delay.
1. 503 - The server is busy (overloaded). You can retry the request after a 10s delay.
1. 603 - The remote user has declined the call. The application should only retry a failed request if there is a chance the retry will succeed, as indicated in the preceding list. It is recommended that the status_string field only be displayed as diagnostic information for status codes > 400, and not the codes in the preceding list. This status_string is often generated by the network, which can also include public PSTN networks. This can result in status_string values that are informative to a technician, but not to an end user, and can be subject to change. Applications should not depend on the value of this field. Applications should present an application-specific message for each of the status codes outlined in the preceding list.

variable status_string


char * status_string;

Text (in English) to describe the status code.

For more information, refer to the vx_evt_media_stream_updated status_code description.

variable state


vx_session_media_state state;

The new state of the entity.

Refer to the codes in table vx_session_media_state

variable incoming


int incoming;

Indicates whether this is an incoming call.

variable durable_media_id


char * durable_media_id;

The durable media identifier used to access value add services.

variable media_probe_server


char * media_probe_server;

The current media probe server.

variable call_stats


vx_call_stats_t * call_stats;

NULL, except for state session_media_disconnected.

Documentation

Development

User Acquisition

Monetization

Industry