StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Property::Video Class Referencefinal

Per-stream video properties. More...

#include <StormByte/multimedia/property/video.hxx>

Public Member Functions

 Video ()
 Constructs unknown video properties without optional metadata.
 Video (Color color, Resolution resolution, StormByte::Safe::Optional< HDR10 > hdr10=std::nullopt, StormByte::Safe::Optional< AVRational > frameRate=std::nullopt, StormByte::Safe::Optional< AVRational > sampleAspectRatio=std::nullopt, StormByte::Safe::Optional< class DOVI > dovi=std::nullopt) noexcept
 Constructs video properties.
 Video (const Video &other)
 Copy constructor.
 Video (Video &&other) noexcept
 Move constructor.
 ~Video () noexcept
 Destructor.
Video & operator= (const Video &other)
 Copy assignment.
Video & operator= (Video &&other) noexcept
 Move assignment.
const class Color & Color () const noexcept
 Colorimetry and pixel format.
const class Resolution & Resolution () const noexcept
 Frame size.
const StormByte::Safe::Optional< class HDR10 > & HDR10 () const noexcept
 Mastering-display metadata, if present.
const StormByte::Safe::Optional< class DOVI > & DOVI () const noexcept
 Dolby Vision configuration and decoded metadata, if present.
const StormByte::Safe::Optional< AVRational > & FrameRate () const noexcept
 Stream frame rate, if the container exposed one.
const StormByte::Safe::Optional< AVRational > & SampleAspectRatio () const noexcept
 Pixel aspect ratio (sample_aspect_ratio).

Detailed Description

Per-stream video properties.

Note
DLL exchange requires compatible C++ ABIs. Base and Multimedia must remain loaded while their values and provider callbacks are in use.

Constructor & Destructor Documentation

◆ Video() [1/4]

StormByte::Multimedia::Property::Video::Video ( )

Constructs unknown video properties without optional metadata.

Exceptions
StormByte::ExceptionSafe storage initialization failed.

◆ Video() [2/4]

StormByte::Multimedia::Property::Video::Video ( Color color,
Resolution resolution,
StormByte::Safe::Optional< HDR10 > hdr10 = std::nullopt,
StormByte::Safe::Optional< AVRational > frameRate = std::nullopt,
StormByte::Safe::Optional< AVRational > sampleAspectRatio = std::nullopt,
StormByte::Safe::Optional< class DOVI > dovi = std::nullopt )
noexcept

Constructs video properties.

Parameters
colorColorimetry and pixel format.
resolutionFrame size.
hdr10Optional mastering-display metadata.
frameRateFrames per second ({num, den} like libav). Empty if unknown.
sampleAspectRatioPixel aspect (sample_aspect_ratio). Empty if unknown.
doviOptional Dolby Vision configuration and decoded metadata.

◆ Video() [3/4]

StormByte::Multimedia::Property::Video::Video ( const Video & other)

Copy constructor.

Parameters
otherProperties to copy.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ Video() [4/4]

StormByte::Multimedia::Property::Video::Video ( Video && other)
noexcept

Move constructor.

Parameters
otherProperties to move.

◆ ~Video()

StormByte::Multimedia::Property::Video::~Video ( )
noexcept

Destructor.

Member Function Documentation

◆ Color()

const class Color & StormByte::Multimedia::Property::Video::Color ( ) const
noexcept

Colorimetry and pixel format.

Returns
Color.

◆ DOVI()

const StormByte::Safe::Optional< class DOVI > & StormByte::Multimedia::Property::Video::DOVI ( ) const
noexcept

Dolby Vision configuration and decoded metadata, if present.

Returns
Borrowed optional DOVI, valid while this object is alive.

◆ FrameRate()

const StormByte::Safe::Optional< AVRational > & StormByte::Multimedia::Property::Video::FrameRate ( ) const
noexcept

Stream frame rate, if the container exposed one.

Returns
Borrowed optional fps ({24000, 1001} for 23.976), valid while this object is alive.

◆ HDR10()

const StormByte::Safe::Optional< class HDR10 > & StormByte::Multimedia::Property::Video::HDR10 ( ) const
noexcept

Mastering-display metadata, if present.

Returns
Borrowed optional HDR10, valid while this object is alive.

◆ operator=() [1/2]

Video & StormByte::Multimedia::Property::Video::operator= ( const Video & other)

Copy assignment.

Parameters
otherProperties to copy.
Returns
*this.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ operator=() [2/2]

Video & StormByte::Multimedia::Property::Video::operator= ( Video && other)
noexcept

Move assignment.

Parameters
otherProperties to move.
Returns
*this.

◆ Resolution()

const class Resolution & StormByte::Multimedia::Property::Video::Resolution ( ) const
noexcept

Frame size.

Returns
Resolution.

◆ SampleAspectRatio()

const StormByte::Safe::Optional< AVRational > & StormByte::Multimedia::Property::Video::SampleAspectRatio ( ) const
noexcept

Pixel aspect ratio (sample_aspect_ratio).

Returns
Borrowed optional SAR ({8, 9} anamorphic NTSC, {1, 1} square), valid while this object is alive.

The documentation for this class was generated from the following file:
  • lib/public/StormByte/multimedia/property/video.hxx