vsdk 8.1.0
 
Loading...
Searching...
No Matches
Vsdk::Audio::ProducerModuleImpl< T >

Producer modules with an accessible constructor should inherit this one. More...

#include <Pipeline.hpp>

Inheritance diagram for Vsdk::Audio::ProducerModuleImpl< T >:
Vsdk::Audio::ProducerModule

Public Member Functions

 ProducerModuleImpl ()=default
 
- Public Member Functions inherited from Vsdk::Audio::ProducerModule
 ProducerModule ()
 
 ProducerModule (ProducerModule &&)
 
ProducerModuleoperator= (ProducerModule &&)
 
virtual ~ProducerModule ()=0
 
 ProducerModule (ProducerModule const &)=delete
 
ProducerModuleoperator= (ProducerModule const &)=delete
 
auto subscribeFirst (AudioCallback c) -> Iterator
 Subscribes as first in the list of audio buffer receivers for this producer.
 
auto subscribeLast (AudioCallback c) -> Iterator
 Subscribes as last in the list of audio buffer receivers for this producer.
 
void unsubscribe (Iterator it) noexcept
 Unsubscribes from this producer audio buffer dispatch list.
 
auto lastError () const -> std::string
 
auto state () const -> State
 
bool isOpened () const
 
bool isRunning () const
 
bool isStarted () const
 
bool isPaused () const
 
bool isIdle () const
 
bool isClosed () const
 
bool open () noexcept
 Attempts to open the underlying resource(s) of the producer.
 
bool run () noexcept
 
bool start () noexcept
 
bool pause () noexcept
 Attempts to pause a started producer.
 
bool resume () noexcept
 Attempts to resume a paused producer.
 
bool stop () noexcept
 Attempts to stop a started producer.
 
bool close () noexcept
 

Static Public Member Functions

template<typename... Args>
static auto make (Args &&... args) -> std::shared_ptr< T >
 

Additional Inherited Members

- Public Types inherited from Vsdk::Audio::ProducerModule
enum class  State {
  Closed , Opened , Running , Started ,
  Paused , Idle
}
 
using Iterator = details::Iterator< decltype(_subscribers)>
 Iterator pointing to a subscriber of this producer.
 
- Protected Member Functions inherited from Vsdk::Audio::ProducerModule
virtual void openImpl ()
 
virtual void runImpl ()
 
virtual void startImpl ()
 
virtual void pauseImpl ()
 
virtual void resumeImpl ()
 
virtual void stopImpl ()
 
virtual void closeImpl ()
 
void dispatchBuffer (Buffer buffer, bool last)
 
template<typename T >
void dispatchAudio (T &&data, int sampleRate, int channelCount, bool isLast)
 
- Protected Attributes inherited from Vsdk::Audio::ProducerModule
std::atomic< State_state
 

Detailed Description

template<class T>
struct Vsdk::Audio::ProducerModuleImpl< T >

Producer modules with an accessible constructor should inherit this one.

Constructor & Destructor Documentation

◆ ProducerModuleImpl()

template<class T >
Vsdk::Audio::ProducerModuleImpl< T >::ProducerModuleImpl ( )
default

Member Function Documentation

◆ make()

template<class T >
template<typename... Args>
static auto Vsdk::Audio::ProducerModuleImpl< T >::make ( Args &&...  args) -> std::shared_ptr<T>
static