#include <subscriber.h>

Data Fields
uint64_t	packets_lost
uint64_t	packets_received
uint64_t	bytes_received
double	timestamp
int64_t	sender_connection_max_allocated_bitrate
int64_t	sender_connection_estimated_bandwidth
int32_t	width
int32_t	height
double	decoded_frame_rate
int64_t	bitrate
int64_t	total_bitrate
int64_t	pause_count
int64_t	total_pauses_duration
int64_t	freeze_count
int64_t	total_freezes_duration
const char *	codec
enum otc_quality_restriction	sender_quality_restriction
enum otc_quality_restriction	remote_publisher_quality_restriction

Detailed Description

This struct represents subscriber video stats, reported periodically by the otc_subscriber_callbacks.on_video_stats callback function.

Data passed into a callback function (other than subscriber and user_data) will be released after the callback is called. Make a copy of the data if you need to retain it.

Field Documentation

◆ bitrate

int64_t bitrate

Bitrate (bps)

◆ bytes_received

uint64_t bytes_received

The total number of video bytes received by the subscriber.

◆ codec

const char* codec

Current codec for this subscriber

◆ decoded_frame_rate

double decoded_frame_rate

Decoded frame rate (fps)

◆ freeze_count

int64_t freeze_count

Number of times the subscriber’s video has frozen. A freeze is defined according to https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

◆ height

int32_t height

Decoded video frame height

◆ packets_lost

uint64_t packets_lost

The total number of video packets lost by the subscriber.

◆ packets_received

uint64_t packets_received

The total number of video bytes received by the subscriber.

◆ pause_count

int64_t pause_count

Number of times the subscriber’s video playback has paused. Video is considered to be paused if time passed since last rendered frame exceeds 5 seconds.

◆ remote_publisher_quality_restriction

enum otc_quality_restriction remote_publisher_quality_restriction

Indicates remote publisher imposed video quality restrictions, if any. This reflects limitations applied by the upstream originating publisher that ultimately affect the received stream quality. May be limited if sender-side stats are disabled.

◆ sender_connection_estimated_bandwidth

int64_t sender_connection_estimated_bandwidth

Deprecated: Use otc_subscriber_media_link_stats instead, which provides complete network metrics including visibility into the remote publisher's transport performance. The current bandwidth estimation for the sender connection. If no data is available, then -1 is returned. Currently, this feature only supports calls with more than two participants.

◆ sender_connection_max_allocated_bitrate

int64_t sender_connection_max_allocated_bitrate

Deprecated: Use otc_subscriber_media_link_stats instead, which provides complete network metrics including visibility into the remote publisher's transport performance. The maximum bitrate that can be estimated for the sender connection. If no data is available, then -1 is returned. Currently, this feature only supports calls with more than two participants.

◆ sender_quality_restriction

enum otc_quality_restriction sender_quality_restriction

Indicates sender–imposed video quality restrictions, if any. This reflects limitations applied at the current sending hop (e.g., the Media Router or direct publisher in a P2P topology). May be limited if sender-side stats are disabled.

◆ timestamp

double timestamp

The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.

◆ total_bitrate

int64_t total_bitrate

Bitrate (bps), including RTP headers, padding and payload

◆ total_freezes_duration

int64_t total_freezes_duration

Cumulative duration (in milliseconds) of all video freezes.

◆ total_pauses_duration

int64_t total_pauses_duration

Cumulative duration (in milliseconds) of all video pauses.

◆ width

int32_t width

Decoded video frame width

The documentation for this struct was generated from the following file:

src/otkit/include/opentok/subscriber.h

Data Fields