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

Ordered tube tracks. More...

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

Inheritance diagram for StormByte::Multimedia::Pipeline::Tracks:
Collaboration diagram for StormByte::Multimedia::Pipeline::Tracks:

Public Types

using ContainerType = StormByte::Safe::Vector<StormByte::Safe::Shared<Track>>
 Base-owned ordered track handles.
using size_type = StormByte::Size
 Count type.
using const_iterator = Iterable::const_iterator
 Read-only Safe iterator; dereference yields a shared track handle.

Public Member Functions

Lifecycle
 Tracks () noexcept
 Empty list.
 Tracks (const Tracks &other)
 Copy constructor.
 Tracks (Tracks &&other) noexcept
 Move constructor.
virtual ~Tracks () noexcept
 Destructor.
Tracks & operator= (const Tracks &other)
 Copy assignment.
Tracks & operator= (Tracks &&other) noexcept
 Move assignment.
Container
const_iterator begin () const noexcept
 Const begin.
const_iterator end () const noexcept
 Const end.
const_iterator cbegin () const noexcept
 Const begin.
const_iterator cend () const noexcept
 Const end.
const Track & operator[] (size_type index) const
 Track at mux slot index.
size_type size () const noexcept
 Element count.
bool empty () const noexcept
 Whether there are no tracks.
void add (const Track &track)
 Appends a clone of track.
void add (Track &&track)
 Appends track via Track::Move.

Detailed Description

Ordered tube tracks.

Index is mux slot.

Does not validate origin indexes or config. Consumers of Plan do. add / begin / end / size / empty are lowercase on purpose: container surface.

Member Typedef Documentation

◆ const_iterator

Read-only Safe iterator; dereference yields a shared track handle.

◆ ContainerType

◆ size_type

Constructor & Destructor Documentation

◆ Tracks() [1/3]

StormByte::Multimedia::Pipeline::Tracks::Tracks ( )
noexcept

Empty list.

◆ Tracks() [2/3]

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

Copy constructor.

Clones every Track.

Parameters
otherSource list.

◆ Tracks() [3/3]

StormByte::Multimedia::Pipeline::Tracks::Tracks ( Tracks && other)
noexcept

Move constructor.

Parameters
otherList to take.

◆ ~Tracks()

virtual StormByte::Multimedia::Pipeline::Tracks::~Tracks ( )
virtualnoexcept

Destructor.

Member Function Documentation

◆ add() [1/2]

void StormByte::Multimedia::Pipeline::Tracks::add ( const Track & track)

Appends a clone of track.

Parameters
trackTrack to copy.

◆ add() [2/2]

void StormByte::Multimedia::Pipeline::Tracks::add ( Track && track)

Appends track via Track::Move.

Parameters
trackTrack to take.

◆ begin()

const_iterator StormByte::Multimedia::Pipeline::Tracks::begin ( ) const
inlinenoexcept

Const begin.

Returns
Iterator to the first shared track handle.

◆ cbegin()

const_iterator StormByte::Multimedia::Pipeline::Tracks::cbegin ( ) const
inlinenoexcept

Const begin.

Returns
Iterator to the first element.

◆ cend()

const_iterator StormByte::Multimedia::Pipeline::Tracks::cend ( ) const
inlinenoexcept

Const end.

Returns
Past-the-last iterator.

◆ empty()

bool StormByte::Multimedia::Pipeline::Tracks::empty ( ) const
inlinenoexcept

Whether there are no tracks.

Returns
true if empty.

◆ end()

const_iterator StormByte::Multimedia::Pipeline::Tracks::end ( ) const
inlinenoexcept

Const end.

Returns
Past-the-last iterator.

◆ operator=() [1/2]

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

Copy assignment.

Clones every Track.

Parameters
otherSource list.
Returns
*this.

◆ operator=() [2/2]

Tracks & StormByte::Multimedia::Pipeline::Tracks::operator= ( Tracks && other)
noexcept

Move assignment.

Parameters
otherList to take.
Returns
*this.

◆ operator[]()

const Track & StormByte::Multimedia::Pipeline::Tracks::operator[] ( size_type index) const

Track at mux slot index.

Parameters
indexZero-based index.
Returns
Borrowed track, valid while its owner remains in this list.

◆ size()

size_type StormByte::Multimedia::Pipeline::Tracks::size ( ) const
inlinenoexcept

Element count.

Returns
Number of tracks.

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