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

Read-only description of one decoder implementation of a codec. More...

#include <StormByte/multimedia/decoder_info.hxx>

Public Member Functions

constexpr DecoderInfo () noexcept=default
 Constructs an empty description.
constexpr DecoderInfo (const DecoderInfo &other) noexcept=default
 Copy constructor.
constexpr DecoderInfo (DecoderInfo &&other) noexcept=default
 Move constructor.
 ~DecoderInfo () noexcept=default
 Destructor.
constexpr DecoderInfo & operator= (const DecoderInfo &other) noexcept=default
 Copy assignment.
constexpr DecoderInfo & operator= (DecoderInfo &&other) noexcept=default
 Move assignment.
constexpr std::string_view Name () const noexcept
 FFmpeg implementation name usable as a decoder pin.
constexpr std::string_view Description () const noexcept
 Human description.
constexpr const StormByte::Multimedia::Features & Features () const noexcept
 Known decoder capabilities from Multimedia's implementation tables.

Friends

class Codec
 Codec constructs implementation descriptions.

Detailed Description

Read-only description of one decoder implementation of a codec.

Obtained from StormByte::Multimedia::Codec::Decoders(). Names and descriptions refer to process-lifetime Multimedia or FFmpeg literals; the provider must remain loaded and use a compatible ABI.

Constructor & Destructor Documentation

◆ DecoderInfo() [1/3]

StormByte::Multimedia::DecoderInfo::DecoderInfo ( )
constexprdefaultnoexcept

Constructs an empty description.

◆ DecoderInfo() [2/3]

StormByte::Multimedia::DecoderInfo::DecoderInfo ( const DecoderInfo & other)
constexprdefaultnoexcept

Copy constructor.

Parameters
otherSource description.

◆ DecoderInfo() [3/3]

StormByte::Multimedia::DecoderInfo::DecoderInfo ( DecoderInfo && other)
constexprdefaultnoexcept

Move constructor.

Parameters
otherSource description.

◆ ~DecoderInfo()

StormByte::Multimedia::DecoderInfo::~DecoderInfo ( )
defaultnoexcept

Destructor.

Member Function Documentation

◆ Description()

std::string_view StormByte::Multimedia::DecoderInfo::Description ( ) const
inlineconstexprnoexcept

Human description.

Returns
Description.

◆ Features()

const StormByte::Multimedia::Features & StormByte::Multimedia::DecoderInfo::Features ( ) const
inlineconstexprnoexcept

Known decoder capabilities from Multimedia's implementation tables.

Returns
Feature set; empty for an unclassified backend fallback.

◆ Name()

std::string_view StormByte::Multimedia::DecoderInfo::Name ( ) const
inlineconstexprnoexcept

FFmpeg implementation name usable as a decoder pin.

Returns
Name, or empty for an empty description.

◆ operator=() [1/2]

DecoderInfo & StormByte::Multimedia::DecoderInfo::operator= ( const DecoderInfo & other)
constexprdefaultnoexcept

Copy assignment.

Parameters
otherSource description.
Returns
This object.

◆ operator=() [2/2]

DecoderInfo & StormByte::Multimedia::DecoderInfo::operator= ( DecoderInfo && other)
constexprdefaultnoexcept

Move assignment.

Parameters
otherSource description.
Returns
This object.

◆ Codec

friend class Codec
friend

Codec constructs implementation descriptions.


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