vx_evt_session_added

Reference the Vivox Core SDK API.

Read time 2 minutes

Last updated 8 months ago

Module: Group Voice and Text Communications

Sent when a session is added.

#include <VxcEvents.h>

Public Attributes

	Name
vx_evt_base_t	base The common properties for all events.
VX_HANDLE	sessiongroup_handle The handle returned from a successful session group create request.
VX_HANDLE	session_handle The handle returned from a successful session add request.
char *	uri The full URI of the session (user/channel).
int	is_channel Set to 1 if this session relates to a channel.
int	incoming Set to 1 if this is a session that was added because it was an incoming call.
char *	channel_name The name of the channel, if passed in when the channel is created.
char *	displayname
char *	application
char *	alias_username The identity of the remote user if P2P, or null if a channel call.

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 returned from a successful session group create request.

variable session_handle


VX_HANDLE session_handle;

The handle returned from a successful session add request.

variable uri


char * uri;

The full URI of the session (user/channel).

variable is_channel


int is_channel;

Set to 1 if this session relates to a channel.

Set to 0 if this session is not related to a channel.

variable incoming


int incoming;

Set to 1 if this is a session that was added because it was an incoming call.

Set to 0 for all other cases.

variable channel_name


char * channel_name;

The name of the channel, if passed in when the channel is created.

This is always empty for incoming sessions.

variable displayname


char * displayname;

Deprecated:

This is deprecated and should not be used.

variable application


char * application;

Deprecated:

This is deprecated and should not be used.

variable alias_username


char * alias_username;

The identity of the remote user if P2P, or null if a channel call.

Note: This is different than the participant_uri, which is the actual internal Vivox identity of the remote user.

Documentation

Development

User Acquisition

Monetization

Industry