Route audio from a ProducerModule to ConsumerModule, with ModifierModule in the middle. More...

#include <Pipeline.hpp>

Public Types
using	ModifierIterator = Vsdk::Utils::Iterator< std::list< ModifierPtr > >

using	ConsumerIterator = Vsdk::Utils::Iterator< std::list< ConsumerPtr > >

Public Member Functions
	Pipeline ()

	Pipeline (std::string const &id)

	Pipeline (Pipeline const &other) noexcept=delete
	Cannot copy because Modifiers & Consumers cannot be shared nor cloned.

Pipeline &	operator= (Pipeline const &other) noexcept=delete

	Pipeline (Pipeline &&other)
	Move constructor & assignment.

Pipeline &	operator= (Pipeline &&)

	~Pipeline ()
	Stops the pipeline if running and unsubscribe from the producer.

void	run ()
	Synchronously runs the pipeline (if supported by the provider).

void	start ()
	Asynchronously starts the pipeline (if supported by the provider).

void	pause ()
	Attempts to pause an already started pipeline.

void	resume ()
	Attempts to resume a paused pipeline.

void	stop ()
	Stops a pipeline that's been start()-ed.

auto	id () const noexcept -> std::string const &
	Returns the pipeline's id.

void	setProducer (ProducerPtr prod)
	Sets a new producer that's already been constructed outside.

template<class T , typename... Args>
auto	setProducer (Args &&... args) -> std::shared_ptr< T >
	Sets a new producer by constructing it with `args`.

template<class T , typename... Args>
auto	pushBackModifier (Args &&... args) -> ModifierIterator

template<class T , typename... Args>
auto	pushFrontModifier (Args &&... args) -> ModifierIterator

template<class T , typename... Args>
auto	pushBackConsumer (Args &&... args) -> ConsumerIterator

template<class T , typename... Args>
auto	pushFrontConsumer (Args &&... args) -> ConsumerIterator

template<class T , typename... Args>
auto	insertModifier (ModifierIterator pos, Args &&... args) -> ModifierIterator

template<class T , typename... Args>
auto	insertConsumer (ConsumerIterator pos, Args &&... args) -> ConsumerIterator

auto	pushBackModifier (ModifierPtr ptr) -> ModifierIterator

auto	pushBackConsumer (ConsumerPtr ptr) -> ConsumerIterator

auto	pushFrontModifier (ModifierPtr ptr) -> ModifierIterator

auto	pushFrontConsumer (ConsumerPtr ptr) -> ConsumerIterator

auto	insertModifier (ModifierIterator pos, ModifierPtr ptr) -> ModifierIterator

auto	insertConsumer (ConsumerIterator pos, ConsumerPtr ptr) -> ConsumerIterator

void	eraseModifier (ModifierIterator it)

void	eraseConsumer (ConsumerIterator it)

void	clearModifiers ()

void	clearConsumers ()

auto	producer () const -> ProducerPtr
	Gets this pipeline's producer in a generic form.

template<typename T >
auto	producer () const -> std::shared_ptr< T >
	Gets this pipeline's producer statically casted to `T`.

Detailed Description

Route audio from a ProducerModule to ConsumerModule, with ModifierModule in the middle.

Member Typedef Documentation

◆ ModifierIterator

using Vsdk::Audio::Pipeline::ModifierIterator = Vsdk::Utils::Iterator<std::list<ModifierPtr> >

◆ ConsumerIterator

using Vsdk::Audio::Pipeline::ConsumerIterator = Vsdk::Utils::Iterator<std::list<ConsumerPtr> >

Constructor & Destructor Documentation

◆ Pipeline() [1/4]

Pipeline::Pipeline ( )

◆ Pipeline() [2/4]

Pipeline::Pipeline ( std::string const & id )

explicit

◆ Pipeline() [3/4]

Vsdk::Audio::Pipeline::Pipeline ( Pipeline const & other )

deletenoexcept

Cannot copy because Modifiers & Consumers cannot be shared nor cloned.

◆ Pipeline() [4/4]

Pipeline::Pipeline ( Pipeline && other )

Move constructor & assignment.

◆ ~Pipeline()

Pipeline::~Pipeline ( )

Stops the pipeline if running and unsubscribe from the producer.

Member Function Documentation

◆ operator=() [1/2]

Pipeline & Vsdk::Audio::Pipeline::operator= ( Pipeline const & other )

deletenoexcept

◆ operator=() [2/2]

Pipeline & Pipeline::operator= ( Pipeline && other )

◆ run()

void Pipeline::run ( )

Synchronously runs the pipeline (if supported by the provider).

Effectively calls:

producer.open();
producer.run();
producer.close();

Exceptions

Vsdk::Exception if error occurs

◆ start()

void Pipeline::start ( )

Asynchronously starts the pipeline (if supported by the provider).

Effectively calls:

producer.open();

producer.start();

Exceptions

Vsdk::Exception if error occurs

◆ pause()

void Pipeline::pause ( )

Attempts to pause an already started pipeline.

Note: This will send an empty "last" buffer into the pipeline if pausing succeeds

Exceptions

Vsdk::Exception if error occurs

◆ resume()

void Pipeline::resume ( )

Attempts to resume a paused pipeline.

Exceptions

Vsdk::Exception if error occurs

◆ stop()

void Pipeline::stop ( )

Stops a pipeline that's been start()-ed.

Effectively calls:

producer.stop();

producer.close();

Exceptions

Vsdk::Exception if error occurs

◆ id()

auto Pipeline::id ( ) const -> std::string const &

noexcept

Returns the pipeline's id.

◆ setProducer() [1/2]

void Pipeline::setProducer ( ProducerPtr prod )

Sets a new producer that's already been constructed outside.

Note: If the pipeline is running it will first be stopped before setting the producer.