Audacity 3.2.0
Static Public Member Functions | List of all members
ScrubState Struct Reference

#include <ScrubState.h>

Static Public Member Functions

static bool IsScrubbing ()
 
static void UpdateScrub (double endTimeOrSpeed, const ScrubbingOptions &options)
 Notify scrubbing engine of desired position or speed. If options.adjustStart is true, then when mouse movement exceeds maximum scrub speed, adjust the beginning of the scrub interval rather than the end, so that the scrub skips or "stutters" to stay near the cursor. More...
 
static void StopScrub ()
 
static double GetLastScrubTime ()
 return the ending time of the last scrub interval. More...
 

Detailed Description

Definition at line 91 of file ScrubState.h.

Member Function Documentation

◆ GetLastScrubTime()

double ScrubState::GetLastScrubTime ( )
static

return the ending time of the last scrub interval.

Definition at line 476 of file ScrubState.cpp.

477{
478 auto &queue = ScrubQueue::Instance;
479 return queue.LastTrackTime();
480}

Referenced by Scrubber::ContinueScrubbingPoll().

Here is the caller graph for this function:

◆ IsScrubbing()

bool ScrubState::IsScrubbing ( )
static

Definition at line 482 of file ScrubState.cpp.

483{
484 auto gAudioIO = AudioIOBase::Get();
485 auto &queue = ScrubQueue::Instance;
486 return gAudioIO->IsBusy() && queue.Started();
487}
static AudioIOBase * Get()
Definition: AudioIOBase.cpp:94

References AudioIOBase::Get().

Referenced by ProjectAudioManager::OnPause().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StopScrub()

void ScrubState::StopScrub ( )
static

Definition at line 469 of file ScrubState.cpp.

470{
471 auto &queue = ScrubQueue::Instance;
472 queue.Stop();
473}

Referenced by Scrubber::StopScrubbing().

Here is the caller graph for this function:

◆ UpdateScrub()

void ScrubState::UpdateScrub ( double  endTimeOrSpeed,
const ScrubbingOptions options 
)
static

Notify scrubbing engine of desired position or speed. If options.adjustStart is true, then when mouse movement exceeds maximum scrub speed, adjust the beginning of the scrub interval rather than the end, so that the scrub skips or "stutters" to stay near the cursor.

Definition at line 462 of file ScrubState.cpp.

464{
465 auto &queue = ScrubQueue::Instance;
466 queue.Update(endTimeOrSpeed, options);
467}

Referenced by Scrubber::ContinueScrubbingPoll().

Here is the caller graph for this function:

The documentation for this struct was generated from the following files: