vx_resp_sessiongroup_get_stats

Reference the Vivox Core SDK API.

Read time 5 minutes

Last updated a day ago

Get the network statistics associated with a particular session group. More...

#include <VxcResponses.h>

Public Attributes

	Name
vx_resp_base_t	base The common properties for all responses.
int	insufficient_bandwidth RESERVED FOR FUTURE USE.
int	min_bars RESERVED FOR FUTURE USE.
int	max_bars RESERVED FOR FUTURE USE.
int	current_bars
int	pk_loss RESERVED FOR FUTURE USE.
int	incoming_received The number of packets received.
int	incoming_expected The number of incoming packets expected.
int	incoming_packetloss The number of packets lost in the network.
int	incoming_out_of_time The number of packets received too late to be useful and discarded.
int	incoming_discarded The number of packets received but discarded because the local queue overflowed.
int	outgoing_sent The number of packets sent.
int	render_device_underruns The number of render device underruns.
int	render_device_overruns The number of render device overruns.
int	render_device_errors The number of render device errors.
char *	call_id The SIP call ID.
int	plc_on A flag which indicates whether Packet Loss Concealment (error correction) has occurred.
int	plc_synthetic_frames The number of 10ms synthetic frames generated by Packet Loss Concealment.
char *	codec_name A codec negotiated in the current call.
int	codec_mode
double	min_latency The minimum network latency, which is detected in seconds.
double	max_latency The maximum network latency, which is detected in seconds.
int	latency_measurement_count The number of times that latency was measured.
double	latency_sum The total number of seconds of measured network latency.
double	last_latency_measured The last latency that was measured.
int	latency_packets_lost The number of latency measurement packets lost.
double	r_factor A computation of quality.
int	latency_packets_sent The number of latency measurement request packets sent.
int	latency_packets_dropped The number of latency measurement response packets dropped.
int	latency_packets_malformed The number of latency measurement packets that were too short or otherwise malformed.
int	latency_packets_negative_latency The number of latency measurement packets that arrived before they were sent.
double	sample_interval_begin The beginning of the sample period in fractional seconds since midnight on January 1, 1970 GMT.
double	sample_interval_end The end of the sample period in fractional seconds since midnight on January 1, 1970 GMT.
int[5]	capture_device_consecutively_read_count The number of intervals where 0, 1, 2, 3, or 4 or greater audio frames were read from the capture device.
int	current_opus_bit_rate The OPUS bit rate that was used for encoding the last transmitted OPUS packet.
int	current_opus_complexity The OPUS complexity that was used for encoding the last transmitted OPUS packet.
int	current_opus_vbr_mode The OPUS VBR mode (vx_opus_vbr_mode) that was used for encoding the last transmitted OPUS packet.
int	current_opus_bandwidth The OPUS bandwith (vx_opus_bandwidth) that was used for encoding the last transmitted OPUS packet.
int	current_opus_max_packet_size The OPUS max packet size limit that was used for encoding the last transmitted OPUS packet.
int	signal_secure Signals whether transport is secure (1) or not secure (0).

Detailed Description


struct vx_resp_sessiongroup_get_stats;

Get the network statistics associated with a particular session group. See: vx_req_sessiongroup_get_stats

Public Attributes Documentation

variable base


vx_resp_base_t base;

The common properties for all responses.

variable insufficient_bandwidth


int insufficient_bandwidth;

RESERVED FOR FUTURE USE.

variable min_bars


int min_bars;

RESERVED FOR FUTURE USE.

variable max_bars


int max_bars;

RESERVED FOR FUTURE USE.

variable current_bars


int current_bars;

Deprecated: This is deprecated and should not be used. An indication of the network quality in the range of 1-5, with 5 indicating the best quality.

variable pk_loss


int pk_loss;

RESERVED FOR FUTURE USE.

variable incoming_received


int incoming_received;

The number of packets received.

variable incoming_expected


int incoming_expected;

The number of incoming packets expected.

variable incoming_packetloss


int incoming_packetloss;

The number of packets lost in the network.

variable incoming_out_of_time


int incoming_out_of_time;

The number of packets received too late to be useful and discarded.

variable incoming_discarded


int incoming_discarded;

The number of packets received but discarded because the local queue overflowed.

variable outgoing_sent


int outgoing_sent;

The number of packets sent.

variable render_device_underruns


int render_device_underruns;

The number of render device underruns. Note: Applicable to mobile platforms only.

variable render_device_overruns


int render_device_overruns;

The number of render device overruns. Note: Applicable to mobile platforms only.

variable render_device_errors


int render_device_errors;

The number of render device errors. Note: Applicable to mobile platforms only.

variable call_id


char * call_id;

The SIP call ID.

variable plc_on


int plc_on;

A flag which indicates whether Packet Loss Concealment (error correction) has occurred.

variable plc_synthetic_frames


int plc_synthetic_frames;

The number of 10ms synthetic frames generated by Packet Loss Concealment.

variable codec_name


char * codec_name;

A codec negotiated in the current call.

variable codec_mode


int codec_mode;

Deprecated: This is deprecated and should not be used.

variable min_latency


double min_latency;

The minimum network latency, which is detected in seconds. This is zero if no latency measurements are made.

variable max_latency


double max_latency;

The maximum network latency, which is detected in seconds. This is zero if no latency measurements are made.

variable latency_measurement_count


int latency_measurement_count;

The number of times that latency was measured.

variable latency_sum


double latency_sum;

The total number of seconds of measured network latency.

variable last_latency_measured


double last_latency_measured;

The last latency that was measured.

variable latency_packets_lost


int latency_packets_lost;

The number of latency measurement packets lost. This counter is reset to 0 every time vx_req_sessiongroup_get_stats is called.

variable r_factor


double r_factor;

A computation of quality.

variable latency_packets_sent


int latency_packets_sent;

The number of latency measurement request packets sent.

variable latency_packets_dropped


int latency_packets_dropped;

The number of latency measurement response packets dropped.

variable latency_packets_malformed


int latency_packets_malformed;

The number of latency measurement packets that were too short or otherwise malformed.

variable latency_packets_negative_latency


int latency_packets_negative_latency;

The number of latency measurement packets that arrived before they were sent. Note: This can occur if there are clock adjustments.

variable sample_interval_begin


double sample_interval_begin;

The beginning of the sample period in fractional seconds since midnight on January 1, 1970 GMT.

variable sample_interval_end


double sample_interval_end;

The end of the sample period in fractional seconds since midnight on January 1, 1970 GMT.

variable capture_device_consecutively_read_count


int[5] capture_device_consecutively_read_count;

The number of intervals where 0, 1, 2, 3, or 4 or greater audio frames were read from the capture device.

variable current_opus_bit_rate


int current_opus_bit_rate;

The OPUS bit rate that was used for encoding the last transmitted OPUS packet. If no OPUS packets were transmitted, this value is -1.

variable current_opus_complexity


int current_opus_complexity;

The OPUS complexity that was used for encoding the last transmitted OPUS packet. If no OPUS packets were transmitted, this value is -1.

variable current_opus_vbr_mode


int current_opus_vbr_mode;

The OPUS VBR mode (vx_opus_vbr_mode) that was used for encoding the last transmitted OPUS packet. If no OPUS packets were transmitted, this value is -1 .

variable current_opus_bandwidth


int current_opus_bandwidth;

The OPUS bandwith (vx_opus_bandwidth) that was used for encoding the last transmitted OPUS packet. If no OPUS packets were transmitted, this value is -1.

variable current_opus_max_packet_size


int current_opus_max_packet_size;

The OPUS max packet size limit that was used for encoding the last transmitted OPUS packet. If no OPUS packets were transmitted, this value is -1.

variable signal_secure


int signal_secure;

Signals whether transport is secure (1) or not secure (0). Note: V5 only. In V4, this value is always equal to 0.

vx_resp_sessiongroup_get_stats

Public Attributes

Name

Detailed Description

Public Attributes Documentation

variable base

variable insufficient_bandwidth

variable min_bars

variable max_bars

variable current_bars

variable pk_loss

variable incoming_received

variable incoming_expected

variable incoming_packetloss

variable incoming_out_of_time

variable incoming_discarded

variable outgoing_sent

variable render_device_underruns

variable render_device_overruns

variable render_device_errors

variable call_id

variable plc_on

variable plc_synthetic_frames

variable codec_name

variable codec_mode

variable min_latency

variable max_latency

variable latency_measurement_count

variable latency_sum

variable last_latency_measured

variable latency_packets_lost

variable r_factor

variable latency_packets_sent

variable latency_packets_dropped

variable latency_packets_malformed

variable latency_packets_negative_latency

variable sample_interval_begin

variable sample_interval_end

variable capture_device_consecutively_read_count

variable current_opus_bit_rate

variable current_opus_complexity

variable current_opus_vbr_mode

variable current_opus_bandwidth

variable current_opus_max_packet_size

variable signal_secure