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

#include <Pipeline.hpp>

Public Types
using	ModifierIterator = details::Iterator< decltype(_modifiers)>

using	ConsumerIterator = details::Iterator< decltype(_consumers)>

Public Member Functions
	Pipeline ()=default

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

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

	Pipeline (Pipeline &&other)

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 runs the pipeline (if supported by the provider).

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

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)

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 = details::Iterator<decltype(_modifiers)>

◆ ConsumerIterator

using Vsdk::Audio::Pipeline::ConsumerIterator = details::Iterator<decltype(_consumers)>

Constructor & Destructor Documentation

◆ Pipeline() [1/3]

Vsdk::Audio::Pipeline::Pipeline ( )

default

◆ Pipeline() [2/3]

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

delete

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

◆ Pipeline() [3/3]

Pipeline::Pipeline ( Pipeline && other )

◆ ~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 )

delete

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

◆ 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:

The pipeline is already running ;
No producer has been set prior ;
The producer fails to open ;
The producer fails to run ;
The producer fails to close ;

◆ start()

void Pipeline::start ( )

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

Effectively calls:

producer.open();

producer.start();

Note: Does nothing if start() has already been called.

Exceptions

Vsdk::Exception

if:

No producer has been set prior ;
The producer fails to open ;
The producer fails to start ;

◆ stop()

void Pipeline::stop ( )

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

Effectively calls:

producer.stop();

producer.close();

Note: Does nothing if start() has not been called.

Exceptions

Vsdk::Exception

if:

No producer has been set prior ;
The producer fails to stop ;
The producer fails to close ;

◆ 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.