StormByte::Multimedia::Attachment Class Reference

Container attachment (cover, fonts). More...

#include <StormByte/multimedia/attachment.hxx>

Public Member Functions
	Attachment (std::optional< std::string > fileName, std::optional< std::string > mimeType, StormByte::Buffer::FIFO payload) noexcept
	Builds an attachment.
	Attachment (const Attachment &)=delete
	Copy constructor (deleted).
	Attachment (Attachment &&) noexcept=default
	Move constructor.
	~Attachment () noexcept=default
	Destructor.
Attachment &	operator= (const Attachment &)=delete
	Copy assignment (deleted).
Attachment &	operator= (Attachment &&) noexcept=default
	Move assignment.
const std::optional< std::string > &	FileName () const noexcept
	Original file name.
const std::optional< std::string > &	MimeType () const noexcept
	MIME type.
const StormByte::Buffer::FIFO &	Payload () const noexcept
	Attachment bytes.

Detailed Description

Container attachment (cover, fonts).

Not a Stream.

avformat exposes Matroska attached files as fake video tracks (AV_DISPOSITION_ATTACHED_PIC). This type is the real contract.

Constructor & Destructor Documentation

Attachment() [1/3]

StormByte::Multimedia::Attachment::Attachment ( std::optional< std::string >  fileName, std::optional< std::string >  mimeType, StormByte::Buffer::FIFO  payload  )

noexcept

Builds an attachment.

Parameters

fileName	Source file name, if known.
mimeType	MIME type, if known.
payload	File bytes.

Attachment() [2/3]

StormByte::Multimedia::Attachment::Attachment ( const Attachment &  )

delete

Copy constructor (deleted).

Attachment() [3/3]

StormByte::Multimedia::Attachment::Attachment ( Attachment &&  )

defaultnoexcept

Move constructor.

~Attachment()

StormByte::Multimedia::Attachment::~Attachment ( )

defaultnoexcept

Destructor.

Member Function Documentation

FileName()

const std::optional< std::string > & StormByte::Multimedia::Attachment::FileName ( ) const

noexcept

Original file name.

Returns

Name, or empty.

MimeType()

const std::optional< std::string > & StormByte::Multimedia::Attachment::MimeType ( ) const

noexcept

MIME type.

Returns

Type, or empty.

operator=() [1/2]

Attachment & StormByte::Multimedia::Attachment::operator= ( Attachment &&  )

defaultnoexcept

Move assignment.

Returns

*this.

operator=() [2/2]

Attachment & StormByte::Multimedia::Attachment::operator= ( const Attachment &  )

delete

Copy assignment (deleted).

Returns

*this.

Payload()

const StormByte::Buffer::FIFO & StormByte::Multimedia::Attachment::Payload ( ) const

noexcept

Attachment bytes.

Returns

FIFO.

---

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

• lib/public/StormByte/multimedia/attachment.hxx