arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
RTSPVideoInfo Struct Reference

Video Information Structure. More...

#include <VideoInfo.h>

Public Member Functions

 RTSPVideoInfo ()=default
 
 RTSPVideoInfo (uint16_t w, uint16_t h, float fps=30.0f, RTSPVideoFormat fmt=RTSPVideoFormat::MJPEG, uint8_t bpp=24)
 
float aspectRatio () const
 Get aspect ratio.
 
uint32_t framePeriodUs () const
 Calculate frame period in microseconds.
 
uint32_t frameSize () const
 Calculate frame size in bytes (uncompressed)
 
bool isCompressed () const
 Check if format is compressed.
 
void logInfo (const char *source="VideoInfo") const
 Log video info.
 
uint32_t timestampIncrement () const
 Calculate RTP timestamp increment per frame.
 
String toString () const
 Convert to string for debugging.
 

Public Attributes

uint8_t bits_per_pixel = 24
 Bits per pixel (depends on format)
 
RTSPVideoFormat format = RTSPVideoFormat::MJPEG
 Pixel format.
 
float framerate = 30.0f
 Frames per second.
 
uint16_t height = 480
 Video height in pixels.
 
uint32_t rtp_clock_rate = 90000
 RTP clock rate (90kHz for video per RFC)
 
uint16_t width = 640
 Video width in pixels.
 

Detailed Description

Video Information Structure.

Contains all video stream parameters including dimensions, framerate, pixel format, and timing information for RTSP video streaming. This structure parallels AudioInfo for video streams.

Note
Named RTSPVideoInfo (not VideoInfo) - see RTSPVideoFormat's note.
Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ RTSPVideoInfo() [1/2]

RTSPVideoInfo ( )
default

◆ RTSPVideoInfo() [2/2]

RTSPVideoInfo ( uint16_t  w,
uint16_t  h,
float  fps = 30.0f,
RTSPVideoFormat  fmt = RTSPVideoFormat::MJPEG,
uint8_t  bpp = 24 
)
inline

Member Function Documentation

◆ aspectRatio()

float aspectRatio ( ) const
inline

Get aspect ratio.

◆ framePeriodUs()

uint32_t framePeriodUs ( ) const
inline

Calculate frame period in microseconds.

◆ frameSize()

uint32_t frameSize ( ) const
inline

Calculate frame size in bytes (uncompressed)

◆ isCompressed()

bool isCompressed ( ) const
inline

Check if format is compressed.

◆ logInfo()

void logInfo ( const char *  source = "VideoInfo") const
inline

Log video info.

◆ timestampIncrement()

uint32_t timestampIncrement ( ) const
inline

Calculate RTP timestamp increment per frame.

◆ toString()

String toString ( ) const
inline

Convert to string for debugging.

Member Data Documentation

◆ bits_per_pixel

uint8_t bits_per_pixel = 24

Bits per pixel (depends on format)

◆ format

Pixel format.

◆ framerate

float framerate = 30.0f

Frames per second.

◆ height

uint16_t height = 480

Video height in pixels.

◆ rtp_clock_rate

uint32_t rtp_clock_rate = 90000

RTP clock rate (90kHz for video per RFC)

◆ width

uint16_t width = 640

Video width in pixels.


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