JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
AudioPlayHead Class Referenceabstract

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

Classes

struct  CurrentPositionInfo
 This structure is filled-in by the AudioPlayHead::getCurrentPosition() method. More...
 

Public Types

enum  FrameRateType {
  fps24 = 0, fps25 = 1, fps2997 = 2, fps30 = 3,
  fps2997drop = 4, fps30drop = 5, fpsUnknown = 99
}
 Frame rate types. More...
 

Public Member Functions

virtual ~AudioPlayHead ()
 
virtual bool getCurrentPosition (CurrentPositionInfo &result)=0
 Fills-in the given structure with details about the transport's position at the start of the current processing block.
 

Protected Member Functions

 AudioPlayHead ()
 

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

Member Enumeration Documentation

Frame rate types.

Enumerator:
fps24 
fps25 
fps2997 
fps30 
fps2997drop 
fps30drop 
fpsUnknown 

Constructor & Destructor Documentation

AudioPlayHead::AudioPlayHead ( )
protected
virtual AudioPlayHead::~AudioPlayHead ( )
virtual

Member Function Documentation

virtual bool 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.

This method must ONLY be called from within your AudioProcessor::processBlock() method. Calling it at any other time will probably cause a nasty crash.


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