OpenShot Audio Library | OpenShotAudio: juce::AudioPlayHead Class Reference

OpenShot Audio Library | OpenShotAudio 0.3.1

Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
juce::AudioPlayHead Class Referenceabstract

`#include <juce_AudioPlayHead.h>`

## Classes
struct | CurrentPositionInfo

## Public Types
enum | FrameRateType { fps23976 = 0 , fps24 = 1 , fps25 = 2 , fps2997 = 3 , fps30 = 4 , fps2997drop = 5 , fps30drop = 6 , fps60 = 7 , fps60drop = 8 , fpsUnknown = 99 }

## Public Member Functions
virtual bool | getCurrentPosition (CurrentPositionInfo &result)=0
virtual bool | canControlTransport ()
virtual void | transportPlay (bool shouldStartPlaying)
virtual void | transportRecord (bool shouldStartRecording)
virtual void | transportRewind ()

## Detailed Description

A subclass of AudioPlayHead can supply information about the position and status of a moving play head during audio playback.

One of these can be supplied to an AudioProcessor object so that it can find out about the position of the audio that it is rendering.

See also
  AudioProcessor::setPlayHead, AudioProcessor::getPlayHead

Definition at line 38 of file juce_AudioPlayHead.h.

## Member Enumeration Documentation

## ◆ FrameRateType

enum juce::AudioPlayHead::FrameRateType

Frame rate types.

Definition at line 49 of file juce_AudioPlayHead.h.

## Member Function Documentation

## ◆ canControlTransport()

virtual bool juce::AudioPlayHead::canControlTransport | ( |  | ) |
| inlinevirtual

Returns true if this object can control the transport.

Definition at line 145 of file juce_AudioPlayHead.h.

## ◆ getCurrentPosition()

virtual bool juce::AudioPlayHead::getCurrentPosition | ( | CurrentPositionInfo & | result | ) |
| pure virtual

Fills-in the given structure with details about the transport's position at the start of the current processing block. If this method returns false then the current play head position is not available and the given structure will be undefined.

You can ONLY call this from your processBlock() method! Calling it at other times will produce undefined behaviour, as the host may not have any context in which a time would make sense, and some hosts will almost certainly have multithreading issues if it's not called on the audio thread.

## ◆ transportPlay()

virtual void juce::AudioPlayHead::transportPlay | ( | bool | shouldStartPlaying | ) |
| inlinevirtual

Starts or stops the audio.

Definition at line 148 of file juce_AudioPlayHead.h.

## ◆ transportRecord()

virtual void juce::AudioPlayHead::transportRecord | ( | bool | shouldStartRecording | ) |
| inlinevirtual

Starts or stops recording the audio.

Definition at line 151 of file juce_AudioPlayHead.h.

## ◆ transportRewind()

virtual void juce::AudioPlayHead::transportRewind | ( |  | ) |
| inlinevirtual

Rewinds the audio.

Definition at line 154 of file juce_AudioPlayHead.h.

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

- juce_AudioPlayHead.h