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

Immutable container identity owned by StormByte::Multimedia::Registry. More...

#include <StormByte/multimedia/container.hxx>

Public Member Functions

 Container (const Container &other) noexcept=delete
 Copy is disabled; instances are unique in the registry.
 Container (Container &&other) noexcept
 Moves the compatibility list in the multimedia provider.
 ~Container () noexcept
 Destroys the compatibility list in the multimedia provider.
Container & operator= (const Container &other) noexcept=delete
 Copy assignment is disabled.
Container & operator= (Container &&other) noexcept
 Moves the compatibility list in the multimedia provider.
bool operator== (const Container &other) const noexcept
 Identity equality (same registry slot).
bool operator!= (const Container &other) const noexcept
 Identity inequality.
constexpr std::string_view Name () const noexcept
 StormByte container name.
constexpr std::string_view Description () const noexcept
 Human description.
constexpr std::string_view Extension () const noexcept
 Default file extension without a leading dot.
bool HasAccess (Access access) const noexcept
 Tests Read/Write flags.
bool Allows (const CodecRefs &codecs) const noexcept
 Whether every codec in codecs is allowed in this container.
bool Stores (Metadata::FileTag tag) const noexcept
 Whether files written in this container keep file tag tag.
bool Stores (Metadata::StreamTag tag) const noexcept
 Whether files written in this container keep per-track tag tag.
bool SharedTitle () const noexcept
 Whether the file title and the track titles share one field.

Friends

class Registry
 Registry creates identities and resolves compatibility handles.

Detailed Description

Immutable container identity owned by StormByte::Multimedia::Registry.

Container identity owned by the multimedia registry.

Name() is the StormByte key. FFmpeg format ids live only in the registry map.

Note
Conditional DLL safety requires a compatible compiler, standard-library ABI and provider layout. Borrowed identities and table views require the registry to remain alive and the multimedia provider to remain loaded.

Constructor & Destructor Documentation

◆ Container() [1/2]

StormByte::Multimedia::Container::Container ( const Container & other)
deletenoexcept

Copy is disabled; instances are unique in the registry.

Parameters
otherSource container.

◆ Container() [2/2]

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

Moves the compatibility list in the multimedia provider.

Parameters
otherSource container.

◆ ~Container()

StormByte::Multimedia::Container::~Container ( )
noexcept

Destroys the compatibility list in the multimedia provider.

Member Function Documentation

◆ Allows()

bool StormByte::Multimedia::Container::Allows ( const CodecRefs & codecs) const
noexcept

Whether every codec in codecs is allowed in this container.

Parameters
codecsCodecs to test.
Returns
true if codecs is empty or all nonempty entries are allowed; false if any handle is empty or any codec is not allowed.

◆ Description()

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

Human description.

Returns
View to a process-lifetime literal.

◆ Extension()

std::string_view StormByte::Multimedia::Container::Extension ( ) const
inlineconstexprnoexcept

Default file extension without a leading dot.

Returns
View to a table literal, or empty if the row has none.

◆ HasAccess()

bool StormByte::Multimedia::Container::HasAccess ( Access access) const
noexcept

Tests Read/Write flags.

Parameters
accessFlags to test.
Returns
true if every bit in access is set.

◆ Name()

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

StormByte container name.

Returns
View to a process-lifetime literal.

◆ operator!=()

bool StormByte::Multimedia::Container::operator!= ( const Container & other) const
noexcept

Identity inequality.

Parameters
otherOther container.
Returns
true if they are different instances.

◆ operator=() [1/2]

Container & StormByte::Multimedia::Container::operator= ( const Container & other)
deletenoexcept

Copy assignment is disabled.

Parameters
otherSource container.
Returns
*this.

◆ operator=() [2/2]

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

Moves the compatibility list in the multimedia provider.

Parameters
otherSource container.
Returns
*this.

◆ operator==()

bool StormByte::Multimedia::Container::operator== ( const Container & other) const
noexcept

Identity equality (same registry slot).

Parameters
otherOther container.
Returns
true if both refer to the same instance.

◆ SharedTitle()

bool StormByte::Multimedia::Container::SharedTitle ( ) const
noexcept

Whether the file title and the track titles share one field.

Ogg-based containers store the file title as each track's TITLE comment, so a file title edit also replaces the track titles.

Returns
true for Ogg-based containers.

◆ Stores() [1/2]

bool StormByte::Multimedia::Container::Stores ( Metadata::FileTag tag) const
noexcept

Whether files written in this container keep file tag tag.

Parameters
tagFile tag.
Returns
false for read-only containers and tags the muxer drops.

◆ Stores() [2/2]

bool StormByte::Multimedia::Container::Stores ( Metadata::StreamTag tag) const
noexcept

Whether files written in this container keep per-track tag tag.

Parameters
tagStream tag.
Returns
false for read-only containers and tags the muxer drops.

◆ Registry

friend class Registry
friend

Registry creates identities and resolves compatibility handles.


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