vx_evt_participant_updated

Reference the Vivox Core SDK API.

Read time 4 minutes

Last updated 7 months ago

Module: Group Voice and Text Communications

Received when the properties of the participant change For example: mod muted, speaking, volume, energy, or typing notifications.

#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 create request.
char *	participant_uri The URI of the participant whose properties are being updated.
int	is_moderator_muted Used to determine if the user has been muted by the moderator.
int	is_speaking Indicates if the participant is speaking.
int	volume This is the volume level that has been set by the user.
double	energy The energy, or the intensity, of the participant audio.
int	active_media This indicates which media the user is participating in.
int	is_muted_for_me Indicates whether the participant's audio is locally muted for the user.
int	is_text_muted_for_me Indicates whether the participant's text is locally muted for the user.
int	is_moderator_text_muted Used to determine if the user's text has been muted by the moderator.
vx_participant_type	type The type of the participant.
vx_participant_diagnostic_state_t *	diagnostic_states A list of diagnostic states, which tells the application the following information:
int	diagnostic_state_count The total number of diagnostic states.
char *	alias_username The identity of the user if P2P, or NULL if a channel call.
char *	encoded_uri_with_tag The encoded URI for the user with the tag.
int	is_current_user Indicates whether the message is from the current logged in user.
int	has_unavailable_capture_device Indicates if the participant's capture device is unavailable due to reasons other than muting.
int	has_unavailable_render_device Indicates if the participant's render device is unavailable.

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 create request.

variable participant_uri


char * participant_uri;

The URI of the participant whose properties are being updated.

variable is_moderator_muted


int is_moderator_muted;

Used to determine if the user has been muted by the moderator.

0 indicates the user was not muted.
1 indicates the user was muted.

variable is_speaking


int is_speaking;

Indicates if the participant is speaking.

variable volume


int volume;

This is the volume level that has been set by the user.

This is a non-negative integer value between 0 and 100 (inclusive), and should not change often.

variable energy


double energy;

The energy, or the intensity, of the participant audio.

This is used to determine how loud the user is speaking. This is a value between 0 and 1.

variable active_media


int active_media;

This indicates which media the user is participating in.

See VX_MEDIA_FLAGS_AUDIO and VX_MEDIA_FLAGS_TEXT

variable is_muted_for_me


int is_muted_for_me;

Indicates whether the participant's audio is locally muted for the user.

variable is_text_muted_for_me


int is_text_muted_for_me;

Indicates whether the participant's text is locally muted for the user.

variable is_moderator_text_muted


int is_moderator_text_muted;

Used to determine if the user's text has been muted by the moderator.

0 indicates the text was not muted.
1 indicates the text was muted.

variable type


vx_participant_type type;

The type of the participant.

See: vx_participant_type

variable diagnostic_states


vx_participant_diagnostic_state_t * diagnostic_states;

A list of diagnostic states, which tells the application the following information:

The participant is attempting to speak, but the system is not in a state to propogate that speech (for example, the mic is muted).
The participant has unavailable capture or render devices due to certain causes.

variable diagnostic_state_count


int diagnostic_state_count;

The total number of diagnostic states.

variable alias_username


char * alias_username;

The identity of the 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 original sender.

variable encoded_uri_with_tag


char * encoded_uri_with_tag;

The encoded URI for the user with the tag.

This uniquely identifies users that might appear multiple times in a channel.

variable is_current_user


int is_current_user;

Indicates whether the message is from the current logged in user.

variable has_unavailable_capture_device


int has_unavailable_capture_device;

Indicates if the participant's capture device is unavailable due to reasons other than muting.

Check the event's diagnostic_states for the cause (available for local participants only).

If the participant's render device is still operating, then the participant is "listen only".
If both the capture and render devices are unavailable, then the participant is "unavailable"/"on hold".

variable has_unavailable_render_device


int has_unavailable_render_device;

Indicates if the participant's render device is unavailable.