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

Subtitle-track encoding intention, or Remux without a codec. More...

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

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

Public Member Functions

PointerType Clone () const override
 Deep copy.
PointerType Move () override
 Move into a new pointer.
Lifecycle
 Subtitle ()
 Empty subtitle config (Remux until Codec is set).
 Subtitle (const Subtitle &other)
 Copy constructor.
 Subtitle (Subtitle &&other)
 Move constructor.
virtual ~Subtitle () noexcept override
 Destructor.
Subtitle & operator= (const Subtitle &other)
 Copy assignment.
Subtitle & operator= (Subtitle &&other) noexcept
 Move assignment.
Encode
const StormByte::Multimedia::Codec * Codec () const noexcept
 Destination codec.
void Codec (const StormByte::Multimedia::Codec &codec) noexcept
 Sets the destination codec (Encode).
const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & FineTune () const noexcept
 Vendor leftovers.
void FineTune (StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options) noexcept
 Replaces the vendor dict.
Public Member Functions inherited from StormByte::Multimedia::Pipeline::Config::Base
 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.
constexpr enum StormByte::Multimedia::Type Type () const noexcept
 Media stamped by the leaf constructor.
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.
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

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)
Protected Member Functions inherited from StormByte::Multimedia::Pipeline::Config::Base
 Base (enum StormByte::Multimedia::Type type)
 Empty overrides; media fixed for the leaf lifetime.

Detailed Description

Subtitle-track encoding intention, or Remux without a codec.

Note
Boundary use requires compatible C++ ABIs and loaded providers. Codec registry storage must outlive this config and its copies. Derived providers must supply safe fields and local lifecycle, Clone and Move overrides that preserve their dynamic type. Const map iteration returns entry copies, not node references.

Constructor & Destructor Documentation

◆ Subtitle() [1/3]

StormByte::Multimedia::Pipeline::Config::Subtitle::Subtitle ( )

Empty subtitle config (Remux until Codec is set).

◆ Subtitle() [2/3]

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

Copy constructor.

Parameters
otherSource config.

◆ Subtitle() [3/3]

StormByte::Multimedia::Pipeline::Config::Subtitle::Subtitle ( Subtitle && other)

Move constructor.

Parameters
otherConfig to take.

◆ ~Subtitle()

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

Destructor.

Member Function Documentation

◆ Clone()

PointerType StormByte::Multimedia::Pipeline::Config::Subtitle::Clone ( ) const
overridevirtual

Deep copy.

Returns
Owning pointer to a new Subtitle.

Implements StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >.

◆ Codec() [1/2]

const StormByte::Multimedia::Codec * StormByte::Multimedia::Pipeline::Config::Subtitle::Codec ( ) const
inlinenoexcept

Destination codec.

Returns
Registry codec, or nullptr if this track is Remux.

◆ Codec() [2/2]

void StormByte::Multimedia::Pipeline::Config::Subtitle::Codec ( const StormByte::Multimedia::Codec & codec)
inlinenoexcept

Sets the destination codec (Encode).

Parameters
codecRegistry codec. Must be subtitle at Plan validation.

◆ FineTune() [1/2]

const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Subtitle::FineTune ( ) const
inlinenoexcept

Vendor leftovers.

Returns
Key/value map.

◆ FineTune() [2/2]

void StormByte::Multimedia::Pipeline::Config::Subtitle::FineTune ( StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options)
noexcept

Replaces the vendor dict.

Parameters
optionsKey/value pairs.

◆ Move()

PointerType StormByte::Multimedia::Pipeline::Config::Subtitle::Move ( )
overridevirtual

Move into a new pointer.

Returns
Owning pointer to the moved Subtitle.

Implements StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >.

◆ operator=() [1/2]

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

Copy assignment.

Parameters
otherSource config.
Returns
*this.

◆ operator=() [2/2]

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

Move assignment.

Parameters
otherConfig to take.
Returns
*this.

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