Open CASCADE Technology 7.8.2.dev
Image_VideoParams Struct Reference

Auxiliary structure defining video parameters. Please refer to FFmpeg documentation for defining text values. More...

#include <Image_VideoRecorder.hxx>

Public Member Functions

 Image_VideoParams ()
 Empty constructor.
 
void SetFramerate (const Standard_Integer theNumerator, const Standard_Integer theDenominator)
 Setup playback FPS.
 
void SetFramerate (const Standard_Integer theValue)
 Setup playback FPS. For fixed-fps content, timebase should be 1/framerate and timestamp increments should be identical to 1.
 

Data Fields

TCollection_AsciiString Format
 [optional] video format (container), if empty - will be determined from the file name
 
TCollection_AsciiString VideoCodec
 [optional] codec identifier, if empty - default codec from file format will be used
 
TCollection_AsciiString PixelFormat
 [optional] pixel format, if empty - default codec pixel format will be used
 
Standard_Integer Width
 [mandatory] video frame width
 
Standard_Integer Height
 [mandatory] video frame height
 
Standard_Integer FpsNum
 [mandatory] framerate numerator
 
Standard_Integer FpsDen
 [mandatory] framerate denumerator
 
Resource_DataMapOfAsciiStringAsciiString VideoCodecParams
 map of advanced video codec parameters
 

Detailed Description

Auxiliary structure defining video parameters. Please refer to FFmpeg documentation for defining text values.

Constructor & Destructor Documentation

◆ Image_VideoParams()

Image_VideoParams::Image_VideoParams ( )
inline

Empty constructor.

Member Function Documentation

◆ SetFramerate() [1/2]

void Image_VideoParams::SetFramerate ( const Standard_Integer theNumerator,
const Standard_Integer theDenominator )
inline

Setup playback FPS.

◆ SetFramerate() [2/2]

void Image_VideoParams::SetFramerate ( const Standard_Integer theValue)
inline

Setup playback FPS. For fixed-fps content, timebase should be 1/framerate and timestamp increments should be identical to 1.

Field Documentation

◆ Format

TCollection_AsciiString Image_VideoParams::Format

[optional] video format (container), if empty - will be determined from the file name

◆ FpsDen

Standard_Integer Image_VideoParams::FpsDen

[mandatory] framerate denumerator

◆ FpsNum

Standard_Integer Image_VideoParams::FpsNum

[mandatory] framerate numerator

◆ Height

Standard_Integer Image_VideoParams::Height

[mandatory] video frame height

◆ PixelFormat

TCollection_AsciiString Image_VideoParams::PixelFormat

[optional] pixel format, if empty - default codec pixel format will be used

◆ VideoCodec

TCollection_AsciiString Image_VideoParams::VideoCodec

[optional] codec identifier, if empty - default codec from file format will be used

◆ VideoCodecParams

Resource_DataMapOfAsciiStringAsciiString Image_VideoParams::VideoCodecParams

map of advanced video codec parameters

◆ Width

Standard_Integer Image_VideoParams::Width

[mandatory] video frame width


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