Speedify SDK for Desktop/Embedded  15.0.1
Data Fields
SpeedifySDK_SpeedTestResultData Struct Reference

Detailed Description

Results of a speed test.

Since
11.0

#include <types.h>

Data Fields

int64_t testTime
 time of the test, in seconds since epoch More...
 
char country [SPEEDIFYSDK_MAX_COUNTRY_LEN]
 2-character ISO country code, ie: 'us'. More...
 
char city [SPEEDIFYSDK_MAX_CITY_LEN]
 City code, ie: 'atlanta'. More...
 
uint16_t numConnections
 How many connections were used during this test. More...
 
double downloadSpeed
 tested download speed, bits per second More...
 
double uploadSpeed
 tested upload speed, bits per second More...
 
bool isError
 is this test errored More...
 
char errorMessage [SPEEDIFYSDK_MAX_ERROR_STRING]
 error message for this test More...
 
SpeedifySDK_SpeedTestType testType
 type of test More...
 
char resolution [SPEEDIFYSDK_MAX_STREAM_RESOLUTION_LENGTH]
 supported streaming resolution, only valid for streaming tests More...
 
uint16_t fps
 supported streaming frames per second (fps), only valid for streaming tests More...
 
uint16_t jitter
 jitter during test in ms, only valid for streaming tests More...
 
uint16_t latency
 baseline latency in ms More...
 
double loss
 packet loss percent during test, only valid for streaming tests More...
 

Field Documentation

◆ city

char SpeedifySDK_SpeedTestResultData::city[SPEEDIFYSDK_MAX_CITY_LEN]

City code, ie: 'atlanta'.

Since
11.0

◆ country

char SpeedifySDK_SpeedTestResultData::country[SPEEDIFYSDK_MAX_COUNTRY_LEN]

2-character ISO country code, ie: 'us'.

Since
11.0

◆ downloadSpeed

double SpeedifySDK_SpeedTestResultData::downloadSpeed

tested download speed, bits per second

Since
11.0

◆ errorMessage

char SpeedifySDK_SpeedTestResultData::errorMessage[SPEEDIFYSDK_MAX_ERROR_STRING]

error message for this test

Since
11.0

◆ fps

uint16_t SpeedifySDK_SpeedTestResultData::fps

supported streaming frames per second (fps), only valid for streaming tests

Since
11.5

◆ isError

bool SpeedifySDK_SpeedTestResultData::isError

is this test errored

Since
11.0

◆ jitter

uint16_t SpeedifySDK_SpeedTestResultData::jitter

jitter during test in ms, only valid for streaming tests

Since
11.5

◆ latency

uint16_t SpeedifySDK_SpeedTestResultData::latency

baseline latency in ms

Since
11.5

◆ loss

double SpeedifySDK_SpeedTestResultData::loss

packet loss percent during test, only valid for streaming tests

Since
11.5

◆ numConnections

uint16_t SpeedifySDK_SpeedTestResultData::numConnections

How many connections were used during this test.

Since
11.0

◆ resolution

char SpeedifySDK_SpeedTestResultData::resolution[SPEEDIFYSDK_MAX_STREAM_RESOLUTION_LENGTH]

supported streaming resolution, only valid for streaming tests

Since
11.5

◆ testTime

int64_t SpeedifySDK_SpeedTestResultData::testTime

time of the test, in seconds since epoch

Since
9.5

◆ testType

SpeedifySDK_SpeedTestType SpeedifySDK_SpeedTestResultData::testType

type of test

Since
11.5

◆ uploadSpeed

double SpeedifySDK_SpeedTestResultData::uploadSpeed

tested upload speed, bits per second

Since
11.0

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