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

Attachment-track intention. More...

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

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

Public Member Functions

PointerType Clone () const override
 Deep copy.
PointerType Move () override
 Move into a new pointer.
const StormByte::Safe::String & MimeType () const noexcept
 Concrete MIME type.
void MimeType (StormByte::Safe::String mime_type) noexcept
 Replaces the MIME type (moved).
void MimeType (std::string_view mime_type) noexcept
 Replaces the MIME type (copied from a view).
Lifecycle
 Attachment (std::string_view mime_type)
 Builds from a mime view (copied).
 Attachment (StormByte::Safe::String mime_type)
 Builds from a moved mime string.
 Attachment (const Attachment &other)
 Copy constructor.
 Attachment (Attachment &&other) noexcept
 Move constructor.
virtual ~Attachment () noexcept override
 Destructor.
Attachment & operator= (const Attachment &other)
 Copy assignment.
Attachment & operator= (Attachment &&other) noexcept
 Move assignment.
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

Attachment-track intention.

One leaf per attached stream. There is no “all attachments” config; omit the track to drop, Track with this leaf to keep it. Tags live on Base.

MimeType is required. Wildcards (image/*) are not valid.

Todo
Replace MimeType with an enum.
Note
Boundary use requires compatible C++ ABIs and loaded providers. Derived providers must supply safe fields and local lifecycle, Clone and Move overrides that preserve their dynamic type.

Constructor & Destructor Documentation

◆ Attachment() [1/4]

StormByte::Multimedia::Pipeline::Config::Attachment::Attachment ( std::string_view mime_type)
explicit

Builds from a mime view (copied).

Parameters
mime_typeConcrete MIME type (image/jpeg, font/ttf, …).

◆ Attachment() [2/4]

StormByte::Multimedia::Pipeline::Config::Attachment::Attachment ( StormByte::Safe::String mime_type)
explicit

Builds from a moved mime string.

Parameters
mime_typeConcrete MIME type.

◆ Attachment() [3/4]

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

Copy constructor.

Parameters
otherSource config.

◆ Attachment() [4/4]

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

Move constructor.

Parameters
otherConfig to take.

◆ ~Attachment()

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

Destructor.

Member Function Documentation

◆ Clone()

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

Deep copy.

Returns
Owning pointer to a new Attachment.

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

◆ MimeType() [1/3]

const StormByte::Safe::String & StormByte::Multimedia::Pipeline::Config::Attachment::MimeType ( ) const
inlinenoexcept

Concrete MIME type.

Not a wildcard.

Returns
MIME string.

◆ MimeType() [2/3]

void StormByte::Multimedia::Pipeline::Config::Attachment::MimeType ( std::string_view mime_type)
noexcept

Replaces the MIME type (copied from a view).

Parameters
mime_typeConcrete MIME type. Not a wildcard.

◆ MimeType() [3/3]

void StormByte::Multimedia::Pipeline::Config::Attachment::MimeType ( StormByte::Safe::String mime_type)
noexcept

Replaces the MIME type (moved).

Parameters
mime_typeConcrete MIME type. Not a wildcard.

◆ Move()

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

Move into a new pointer.

Returns
Owning pointer to the moved Attachment.

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

◆ operator=() [1/2]

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

Move assignment.

Parameters
otherConfig to take.
Returns
*this.

◆ operator=() [2/2]

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

Copy assignment.

Parameters
otherSource config.
Returns
*this.

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