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

Common destination-stream identity. More...

#include <StormByte/multimedia/pipeline/config/base.hxx>

Inheritance diagram for StormByte::Multimedia::Pipeline::Config::Base:
Collaboration diagram for StormByte::Multimedia::Pipeline::Config::Base:

Public Member Functions

Lifecycle
 Base (const Base &other)
 Copy constructor.
 Base (Base &&other) noexcept
 Move constructor.
virtual ~Base () noexcept override
 Destructor.
Base & operator= (const Base &other)
 Copy assignment.
Base & operator= (Base &&other) noexcept
 Move assignment.
Identity
constexpr enum StormByte::Multimedia::Type Type () const noexcept
 Media stamped by the leaf constructor.
Tags
const StormByte::Safe::Optional< StormByte::Safe::String > & Language () const noexcept
 Language override.
void Language (StormByte::Safe::String language)
 Sets the language override.
void RemoveLanguage ()
 Writes the track without a language tag, even if the source has one.
const StormByte::Safe::Optional< StormByte::Safe::String > & Title () const noexcept
 Title override.
void Title (StormByte::Safe::String title)
 Sets the title override.
void RemoveTitle ()
 Writes the track without a title, even if the source has one.
const StormByte::Safe::Optional< bool > & Default () const noexcept
 Default-disposition override.
void Default (StormByte::Safe::Optional< bool > value) noexcept
 Sets or clears the default-disposition override.
const StormByte::Safe::Optional< bool > & Forced () const noexcept
 Forced-disposition override.
void Forced (StormByte::Safe::Optional< bool > value) noexcept
 Sets or clears the forced-disposition override.
Implementation
const struct Implementation & Implementation () const noexcept
 Decoder / encoder pins.
void Implementation (struct Implementation implementation) noexcept
 Replaces both pins.
Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
constexpr Clonable ()=default
constexpr Clonable & operator= (const Clonable &)=default
virtual constexpr ~Clonable () noexcept=default
virtual PointerType Clone () const =0
virtual PointerType Move ()=0

Protected Member Functions

 Base (enum StormByte::Multimedia::Type type)
 Empty overrides; media fixed for the leaf lifetime.

Additional Inherited Members

Public Types inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
typedef SmartPointer PointerType
Static Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
static PointerType MakePointer (Args &&... args)

Detailed Description

Common destination-stream identity.

Polymorphic store root (StormByte::Safe::Clonable with StormByte::Safe::Unique). Holds tags and implementation pins that apply to every media StormByte::Multimedia::Type used in a Plan slot. Type is stored at construction; it is not virtual. Oficio knobs live on the leaves.

A null destination codec on a leaf means Remux. Boundary use requires compatible C++ ABI and a loaded provider module. Derived classes must provide boundary-safe fields and creator-module lifetime operations, Clone and Move; this interface does not certify them.

Constructor & Destructor Documentation

◆ Base() [1/3]

StormByte::Multimedia::Pipeline::Config::Base::Base ( const Base & other)

Copy constructor.

Parameters
otherSource config.

◆ Base() [2/3]

StormByte::Multimedia::Pipeline::Config::Base::Base ( Base && other)
noexcept

Move constructor.

Parameters
otherConfig to take.

◆ ~Base()

virtual StormByte::Multimedia::Pipeline::Config::Base::~Base ( )
overridevirtualnoexcept

Destructor.

◆ Base() [3/3]

StormByte::Multimedia::Pipeline::Config::Base::Base ( enum StormByte::Multimedia::Type type)
explicitprotected

Empty overrides; media fixed for the leaf lifetime.

Parameters
typeStormByte::Multimedia::Type of the derived class.

Member Function Documentation

◆ Default() [1/2]

const StormByte::Safe::Optional< bool > & StormByte::Multimedia::Pipeline::Config::Base::Default ( ) const
inlinenoexcept

Default-disposition override.

Returns
Engaged value, or empty to inherit.

◆ Default() [2/2]

void StormByte::Multimedia::Pipeline::Config::Base::Default ( StormByte::Safe::Optional< bool > value)
inlinenoexcept

Sets or clears the default-disposition override.

Parameters
valuetrue / false to stamp, empty to inherit.

◆ Forced() [1/2]

const StormByte::Safe::Optional< bool > & StormByte::Multimedia::Pipeline::Config::Base::Forced ( ) const
inlinenoexcept

Forced-disposition override.

Returns
Engaged value, or empty to inherit.

◆ Forced() [2/2]

void StormByte::Multimedia::Pipeline::Config::Base::Forced ( StormByte::Safe::Optional< bool > value)
inlinenoexcept

Sets or clears the forced-disposition override.

Parameters
valuetrue / false to stamp, empty to inherit.

◆ Implementation() [1/2]

const struct Implementation & StormByte::Multimedia::Pipeline::Config::Base::Implementation ( ) const
inlinenoexcept

Decoder / encoder pins.

Returns
Pair; each side empty means Step default.

◆ Implementation() [2/2]

void StormByte::Multimedia::Pipeline::Config::Base::Implementation ( struct Implementation implementation)
inlinenoexcept

Replaces both pins.

Parameters
implementationDecoder / encoder names. Empty sides = default.

◆ Language() [1/2]

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Base::Language ( ) const
inlinenoexcept

Language override.

Returns
ISO tag; an engaged empty tag removes the language; disengaged inherits.

◆ Language() [2/2]

void StormByte::Multimedia::Pipeline::Config::Base::Language ( StormByte::Safe::String language)

Sets the language override.

Parameters
languageISO tag. Empty clears the override.

◆ operator=() [1/2]

Base & StormByte::Multimedia::Pipeline::Config::Base::operator= ( Base && other)
noexcept

Move assignment.

Parameters
otherConfig to take.
Returns
*this.

◆ operator=() [2/2]

Base & StormByte::Multimedia::Pipeline::Config::Base::operator= ( const Base & other)

Copy assignment.

Parameters
otherSource config.
Returns
*this.

◆ RemoveLanguage()

void StormByte::Multimedia::Pipeline::Config::Base::RemoveLanguage ( )

Writes the track without a language tag, even if the source has one.

Containers with a mandatory language field write their own undefined value.

◆ RemoveTitle()

void StormByte::Multimedia::Pipeline::Config::Base::RemoveTitle ( )

Writes the track without a title, even if the source has one.

◆ Title() [1/2]

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Base::Title ( ) const
inlinenoexcept

Title override.

Returns
Title; an engaged empty title removes it; disengaged inherits.

◆ Title() [2/2]

void StormByte::Multimedia::Pipeline::Config::Base::Title ( StormByte::Safe::String title)

Sets the title override.

Parameters
titleTitle. Empty clears the override.

◆ Type()

enum StormByte::Multimedia::Type StormByte::Multimedia::Pipeline::Config::Base::Type ( ) const
inlineconstexprnoexcept

Media stamped by the leaf constructor.

Returns
Value passed to Base(Type).

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