StormByte::Multimedia::Pipeline::SideData Class Reference

One side-data blob attached to a Frame or Packet. More...

#include <StormByte/multimedia/pipeline/side_data.hxx>

Public Member Functions
	SideData (SideDataKind kind, StormByte::Buffer::FIFO payload) noexcept
	Known kind plus payload.
	SideData (std::string name, StormByte::Buffer::FIFO payload) noexcept
	Other kind plus FFmpeg name and payload.
	SideData (const SideData &other) noexcept=default
	Copy constructor.
	SideData (SideData &&other) noexcept=default
	Move constructor.
	~SideData () noexcept=default
	Destructor.
SideData &	operator= (const SideData &other) noexcept=default
	Copy assignment.
SideData &	operator= (SideData &&other) noexcept=default
	Move assignment.
SideDataKind	Kind () const noexcept
	Kind.
const std::optional< std::string > &	Name () const noexcept
	libav name when Kind is Other.
const StormByte::Buffer::FIFO &	Payload () const noexcept
	Raw payload.
StormByte::Buffer::FIFO &	Payload () noexcept
	Raw payload (mutable).

Detailed Description

One side-data blob attached to a Frame or Packet.

Copy duplicates the FIFO. That is cheap next to an AVFrame plane clone; StormByte::Multimedia::Pipeline::Frame needs it for its private copy.

Constructor & Destructor Documentation

SideData() [1/4]

StormByte::Multimedia::Pipeline::SideData::SideData ( SideDataKind  kind, StormByte::Buffer::FIFO  payload  )

noexcept

Known kind plus payload.

Parameters

kind	Side-data kind.
payload	Raw bytes.

SideData() [2/4]

StormByte::Multimedia::Pipeline::SideData::SideData ( std::string  name, StormByte::Buffer::FIFO  payload  )

noexcept

Other kind plus FFmpeg name and payload.

Parameters

name	libav side-data name.
payload	Raw bytes.

Sets Kind to SideDataKind::Other.

SideData() [3/4]

StormByte::Multimedia::Pipeline::SideData::SideData ( const SideData &  other )

defaultnoexcept

Copy constructor.

Parameters

other

Source blob.

SideData() [4/4]

StormByte::Multimedia::Pipeline::SideData::SideData ( SideData &&  other )

defaultnoexcept

Move constructor.

Parameters

other

Blob to take.

~SideData()

StormByte::Multimedia::Pipeline::SideData::~SideData ( )

defaultnoexcept

Destructor.

Member Function Documentation

Kind()

SideDataKind StormByte::Multimedia::Pipeline::SideData::Kind ( ) const

noexcept

Kind.

Returns

Kind.

Name()

const std::optional< std::string > & StormByte::Multimedia::Pipeline::SideData::Name ( ) const

noexcept

libav name when Kind is Other.

Returns

Name, or empty.

operator=() [1/2]

SideData & StormByte::Multimedia::Pipeline::SideData::operator= ( const SideData &  other )

defaultnoexcept

Copy assignment.

Parameters

other

Source blob.

Returns

*this.

operator=() [2/2]

SideData & StormByte::Multimedia::Pipeline::SideData::operator= ( SideData &&  other )

defaultnoexcept

Move assignment.

Parameters

other

Blob to take.

Returns

*this.

Payload() [1/2]

const StormByte::Buffer::FIFO & StormByte::Multimedia::Pipeline::SideData::Payload ( ) const

noexcept

Raw payload.

Returns

FIFO.

Payload() [2/2]

StormByte::Buffer::FIFO & StormByte::Multimedia::Pipeline::SideData::Payload ( )

noexcept

Raw payload (mutable).

Returns

FIFO.

---

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

• lib/public/StormByte/multimedia/pipeline/side_data.hxx