Detailed Description

Statistics for a single stream.

Since: 9.6

#include <types.h>

Data Fields
bool	active
	If this stream is currently active. More...

uint64_t	duration
	Time, in seconds, this stream has been active. More...

uint64_t	id
	ID number of this stream. More...

uint64_t	groupId
	Group ID number of this stream. More...

uint64_t	startTime
	Time this stream started, seconds since epoch. More...

double	uploadSpeed
	Current upload speed of this stream, in megabits per second. More...

double	downloadSpeed
	Current download speed of this stream, in megabits per second. More...

double	averageUploadSpeed
	Average upload speed of this stream, in megabits per second. More...

double	averageDownloadSpeed
	Average download speed of this stream, in megabits per second. More...

uint64_t	redundantModeSaves
	Number of saves while in redundant mode. More...

uint64_t	speedModeSaves
	Number of saves while in speed mode. More...

uint64_t	failoverSaves

char	name [SPEEDIFYSDK_MAX_STREAM_NAME_LEN]
	Name of the application or domain of this stream, or 'stream_test' for testing streams. More...

SpeedifySDK_StreamHealth	health
	Stream health. More...

SpeedifySDK_IPAddressString	remoteIp
	The remote ip that this stream is connected to. More...

uint16_t	remotePort
	The remote port that this stream is connected to. More...

char	protocol [SPEEDIFYSDK_MAX_PROTOCOL_LENGTH]
	The protocol of this stream. This is typically VNC, RTP, RTMP, RDP, Wifi Calling, TCP, UDP or HTTPS, if known. More...

SpeedifySDK_HostnameString	hostname
	The hostname of the service that this stream is connected to. More...

Field Documentation

◆ active

bool SpeedifySDK_StreamStats::active

If this stream is currently active.

Since: 9.6

◆ averageDownloadSpeed

double SpeedifySDK_StreamStats::averageDownloadSpeed

Average download speed of this stream, in megabits per second.

Since: 9.8

◆ averageUploadSpeed

double SpeedifySDK_StreamStats::averageUploadSpeed

Average upload speed of this stream, in megabits per second.

Since: 9.8

◆ downloadSpeed

double SpeedifySDK_StreamStats::downloadSpeed

Current download speed of this stream, in megabits per second.

Since: 9.8

◆ duration

uint64_t SpeedifySDK_StreamStats::duration

Time, in seconds, this stream has been active.

Since: 9.6

◆ failoverSaves

uint64_t SpeedifySDK_StreamStats::failoverSaves

Number of saves through connection failover

Since: 11.2

◆ groupId

uint64_t SpeedifySDK_StreamStats::groupId

Group ID number of this stream.

Since: 9.8

◆ health

SpeedifySDK_StreamHealth SpeedifySDK_StreamStats::health

Stream health.

Since: 11.5

◆ hostname

SpeedifySDK_HostnameString SpeedifySDK_StreamStats::hostname

The hostname of the service that this stream is connected to.

Since: 14.1

◆ id

uint64_t SpeedifySDK_StreamStats::id

ID number of this stream.

Since: 9.6

◆ name

char SpeedifySDK_StreamStats::name[SPEEDIFYSDK_MAX_STREAM_NAME_LEN]

Name of the application or domain of this stream, or 'stream_test' for testing streams.

Since: 9.8

◆ protocol

char SpeedifySDK_StreamStats::protocol[SPEEDIFYSDK_MAX_PROTOCOL_LENGTH]

The protocol of this stream. This is typically VNC, RTP, RTMP, RDP, Wifi Calling, TCP, UDP or HTTPS, if known.

Since: 14.1

◆ redundantModeSaves

uint64_t SpeedifySDK_StreamStats::redundantModeSaves

Number of saves while in redundant mode.

Since: 9.8

◆ remoteIp

SpeedifySDK_IPAddressString SpeedifySDK_StreamStats::remoteIp

The remote ip that this stream is connected to.

Since: 14.1

◆ remotePort

uint16_t SpeedifySDK_StreamStats::remotePort

The remote port that this stream is connected to.

Since: 14.1

◆ speedModeSaves

uint64_t SpeedifySDK_StreamStats::speedModeSaves

Number of saves while in speed mode.

Since: 9.8

◆ startTime

uint64_t SpeedifySDK_StreamStats::startTime

Time this stream started, seconds since epoch.

Since: 9.6

◆ uploadSpeed

double SpeedifySDK_StreamStats::uploadSpeed

Current upload speed of this stream, in megabits per second.

Since: 9.6

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

include/speedifysdk/types.h