Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_evt_session_updated

Reference the Vivox Core SDK API.
Read time 2 minutesLast updated 20 hours ago

Module: Group Voice and Text Communications Sent when a session is updated.
#include <VxcEvents.h>

Public Attributes

Name

vx_evt_base_tbase
The common properties for all events.
VX_HANDLEsessiongroup_handle
The handle returned from a successful session group create request.
VX_HANDLEsession_handle
The handle returned from a successful session add request.
char *uri
The full URI of the session.
intis_muted
Indicates whether the session's audio is muted.
intvolume
The volume of this session.
inttransmit_enabled
Indicates whether the session is transmitting.
intis_focused
Indicates whether the session has focus.
double[3]speaker_position
The position of the virtual "mouth".
intsession_font_id
The ID of the session font applied to this session.
intis_text_muted
Indicates whether the session's text is muted.
intis_ad_playing
Indicates whether there is an audio ad playing in this session.

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.

variable is_muted

int is_muted;
Indicates whether the session's audio is muted.

variable volume

int volume;
The volume of this session.

variable transmit_enabled

int transmit_enabled;
Indicates whether the session is transmitting.

variable is_focused

int is_focused;
Indicates whether the session has focus.

variable speaker_position

double[3] speaker_position;
The position of the virtual "mouth". This three vector is a right handed Cartesian coordinate, with the positive axis pointing towards the speaker's right, the positive Y axis pointing up, and the positive Z axis pointing towards the speaker.

variable session_font_id

int session_font_id;
The ID of the session font applied to this session. 0 = none.

variable is_text_muted

int is_text_muted;
Indicates whether the session's text is muted.

variable is_ad_playing

int is_ad_playing;
Indicates whether there is an audio ad playing in this session.