RealtimeEffectManager::ProcessScope Class Reference

Object whose lifetime encompasses one block of processing in one thread. More...

#include <RealtimeEffectManager.h>

Collaboration diagram for RealtimeEffectManager::ProcessScope:

Public Member Functions
	ProcessScope (AudacityProject *pProject)
	ProcessScope (ProcessScope &&other)
ProcessScope &	operator= (ProcessScope &&other)
	~ProcessScope ()
size_t	Process (Track *track, float **buffers, size_t numSamples)

Private Attributes
AudacityProject *	mpProject = nullptr

Detailed Description

Object whose lifetime encompasses one block of processing in one thread.

Definition at line 87 of file RealtimeEffectManager.h.

Constructor & Destructor Documentation

ProcessScope() [1/2]

RealtimeEffectManager::ProcessScope::ProcessScope ( AudacityProject *  pProject )

inlineexplicit

Definition at line 89 of file RealtimeEffectManager.h.

         : mpProject{ pProject }
      {
         if (mpProject)
            Get(*mpProject).ProcessStart();
      }

References BasicUI::Get().

Here is the call graph for this function:

ProcessScope() [2/2]

RealtimeEffectManager::ProcessScope::ProcessScope ( ProcessScope &&  other )

inline

Definition at line 95 of file RealtimeEffectManager.h.

         : mpProject{ other.mpProject }
      {
         other.mpProject = nullptr;
      }

~ProcessScope()

RealtimeEffectManager::ProcessScope::~ProcessScope ( )

inline

Definition at line 107 of file RealtimeEffectManager.h.

      {
         if (mpProject)
            Get(*mpProject).ProcessEnd();
      }

References BasicUI::Get().

Here is the call graph for this function:

Member Function Documentation

operator=()

ProcessScope & RealtimeEffectManager::ProcessScope::operator= ( ProcessScope &&  other )

inline

Definition at line 100 of file RealtimeEffectManager.h.

      {
         auto pProject = other.mpProject;
         other.mpProject = nullptr;
         mpProject = pProject;
         return *this;
      }

References mpProject.

Process()

size_t RealtimeEffectManager::ProcessScope::Process ( Track *  track, float **  buffers, size_t  numSamples  )

inline

Definition at line 113 of file RealtimeEffectManager.h.

      {
         if (mpProject)
            return Get(*mpProject)
               .Process(track, buffers, numSamples);
         else
            return numSamples; // consider them trivially processed
      }

References BasicUI::Get().

Here is the call graph for this function:

Member Data Documentation

mpProject

AudacityProject* RealtimeEffectManager::ProcessScope::mpProject = nullptr

private

Definition at line 123 of file RealtimeEffectManager.h.

Referenced by operator=().

---

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

• RealtimeEffectManager.h