StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::EncoderOption Struct Reference

Description of one FFmpeg option of an encoder implementation. More...

#include <StormByte/multimedia/encoder_info.hxx>

Collaboration diagram for StormByte::Multimedia::EncoderOption:

Public Member Functions

 EncoderOption ()
 Constructs an empty description in Multimedia.
 EncoderOption (const EncoderOption &other)
 Copies a description in Multimedia.
 EncoderOption (EncoderOption &&other) noexcept
 Transfers a description.
 ~EncoderOption () noexcept
 Releases the description through its creator callbacks.
EncoderOption & operator= (const EncoderOption &other)
 Copies a description in Multimedia.
EncoderOption & operator= (EncoderOption &&other) noexcept
 Transfers a description.

Public Attributes

StormByte::Safe::String Name
 FFmpeg option name.
StormByte::Safe::String Help
 FFmpeg help text (English).
EncoderOptionType Type
 Value type.
double Minimum
 Lowest numeric value FFmpeg accepts.
double Maximum
 Highest numeric value FFmpeg accepts.
StormByte::Safe::String Default
 FFmpeg default as text; empty when unknown.
StormByte::Safe::Vector< StormByte::Safe::String > Choices
 Named constants accepted as values.

Detailed Description

Description of one FFmpeg option of an encoder implementation.

Note
Values come from the linked FFmpeg build (bundled or system).

Constructor & Destructor Documentation

◆ EncoderOption() [1/3]

StormByte::Multimedia::EncoderOption::EncoderOption ( )

Constructs an empty description in Multimedia.

◆ EncoderOption() [2/3]

StormByte::Multimedia::EncoderOption::EncoderOption ( const EncoderOption & other)

Copies a description in Multimedia.

Parameters
otherSource description.

◆ EncoderOption() [3/3]

StormByte::Multimedia::EncoderOption::EncoderOption ( EncoderOption && other)
noexcept

Transfers a description.

Parameters
otherSource description, left empty.

◆ ~EncoderOption()

StormByte::Multimedia::EncoderOption::~EncoderOption ( )
noexcept

Releases the description through its creator callbacks.

Member Function Documentation

◆ operator=() [1/2]

EncoderOption & StormByte::Multimedia::EncoderOption::operator= ( const EncoderOption & other)

Copies a description in Multimedia.

Parameters
otherSource description.
Returns
This object.

◆ operator=() [2/2]

EncoderOption & StormByte::Multimedia::EncoderOption::operator= ( EncoderOption && other)
noexcept

Transfers a description.

Parameters
otherSource description, left empty.
Returns
This object.

Member Data Documentation

◆ Choices

StormByte::Safe::Vector<StormByte::Safe::String> StormByte::Multimedia::EncoderOption::Choices

Named constants accepted as values.

◆ Default

StormByte::Safe::String StormByte::Multimedia::EncoderOption::Default

FFmpeg default as text; empty when unknown.

◆ Help

StormByte::Safe::String StormByte::Multimedia::EncoderOption::Help

FFmpeg help text (English).

◆ Maximum

double StormByte::Multimedia::EncoderOption::Maximum

Highest numeric value FFmpeg accepts.

◆ Minimum

double StormByte::Multimedia::EncoderOption::Minimum

Lowest numeric value FFmpeg accepts.

◆ Name

StormByte::Safe::String StormByte::Multimedia::EncoderOption::Name

FFmpeg option name.

◆ Type

EncoderOptionType StormByte::Multimedia::EncoderOption::Type

Value type.


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