UgCS video streamer
Public Attributes | List of all members
VsParams Struct Reference

#include <video_streamer_c_api.h>

Public Attributes

void * opaque = nullptr
 
const char * vehicleId
 
const char * tailNumber = nullptr
 
const char * targetUri
 
int64_t transcodeBitrate = 0
 
float transcodeScale = 1.0
 
float transcodeFramerateLimit = 0
 

Detailed Description

Streamer parameters.

Member Data Documentation

◆ opaque

void* VsParams::opaque = nullptr

Caller-defined parameter to pass in callbacks.

◆ tailNumber

const char* VsParams::tailNumber = nullptr

User-defined tail number, may be null.

◆ targetUri

const char* VsParams::targetUri

Target URI for streaming. Examples:

  • udp://1.2.3.4:3338 - Plain UDP streaming, suitable for external MISP-compliant players such as GIS software or just a regular media player (metadata will not be available in such case).
  • `urtp+connect://1.2.3.4://3341 - URTP streaming with outgoing connection. URTP is UgCS proprietary protocol supported by its Command Center components. It ensures better quality on unreliable links.

◆ transcodeBitrate

int64_t VsParams::transcodeBitrate = 0

Zero value disables transcoding, -1 for auto (based on input bitrate and scale), otherwise value in bits/s.

◆ transcodeFramerateLimit

float VsParams::transcodeFramerateLimit = 0

Frame rate limit for transcoding output, fps. Zero to preserve all input frames.

◆ transcodeScale

float VsParams::transcodeScale = 1.0

Frame size scale factor for transcoding output, 1.0 to preserve input size.

◆ vehicleId

const char* VsParams::vehicleId

Vehicle ID (typically serial number).


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