Audaspace 1.3.0
A high level audio library.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
JackSynchronizer Class Reference

This class is a Synchronizer implementation using JACK Transport. More...

#include <JackSynchronizer.h>

Inheritance diagram for JackSynchronizer:
Inheritance graph
[legend]

Public Member Functions

 JackSynchronizer (JackDevice *device)
 Creates a new JackSynchronizer. More...
 
virtual void seek (std::shared_ptr< IHandle > handle, float time)
 Sets the playback position of a handle and the synchronizer to a specific time. More...
 
virtual float getPosition (std::shared_ptr< IHandle > handle)
 Retrieves the position of the synchronizer. More...
 
virtual void play ()
 Starts the synchronizer playback. More...
 
virtual void stop ()
 Stops the synchronizer playback. More...
 
virtual void setSyncCallback (syncFunction function, void *data)
 Sets the callback function that is called when a synchronization event happens. More...
 
virtual int isPlaying ()
 Retrieves whether the synchronizer is playing back. More...
 
- Public Member Functions inherited from ISynchronizer
virtual ~ISynchronizer ()
 Destroys the synchronizer.
 
virtual void seek (std::shared_ptr< IHandle > handle, float time)=0
 Sets the playback position of a handle and the synchronizer to a specific time. More...
 
virtual float getPosition (std::shared_ptr< IHandle > handle)=0
 Retrieves the position of the synchronizer. More...
 
virtual void play ()=0
 Starts the synchronizer playback. More...
 
virtual void stop ()=0
 Stops the synchronizer playback. More...
 
virtual void setSyncCallback (syncFunction function, void *data)=0
 Sets the callback function that is called when a synchronization event happens. More...
 
virtual int isPlaying ()=0
 Retrieves whether the synchronizer is playing back. More...
 

Additional Inherited Members

- Public Types inherited from ISynchronizer
typedef void(* syncFunction) (void *, int, float)
 The syncFunction is called when a synchronization event happens. More...
 

Detailed Description

This class is a Synchronizer implementation using JACK Transport.

Constructor & Destructor Documentation

◆ JackSynchronizer()

JackSynchronizer::JackSynchronizer ( JackDevice device)

Creates a new JackSynchronizer.

Parameters
deviceThe device that should be synchronized.

Member Function Documentation

◆ getPosition()

virtual float JackSynchronizer::getPosition ( std::shared_ptr< IHandle handle)
virtual

Retrieves the position of the synchronizer.

Parameters
handleThe handle which is synchronized.
Returns
The position in seconds.

Implements ISynchronizer.

◆ isPlaying()

virtual int JackSynchronizer::isPlaying ( )
virtual

Retrieves whether the synchronizer is playing back.

Returns
Whether the synchronizer plays back.

Implements ISynchronizer.

◆ play()

virtual void JackSynchronizer::play ( )
virtual

Starts the synchronizer playback.

Implements ISynchronizer.

◆ seek()

virtual void JackSynchronizer::seek ( std::shared_ptr< IHandle handle,
float  time 
)
virtual

Sets the playback position of a handle and the synchronizer to a specific time.

Parameters
handleThe handle that should be synchronized/seeked.
timeThe absolute time to synchronize to.

Implements ISynchronizer.

◆ setSyncCallback()

virtual void JackSynchronizer::setSyncCallback ( syncFunction  function,
void *  data 
)
virtual

Sets the callback function that is called when a synchronization event happens.

Parameters
functionThe function to be called.
dataUser data to be passed to the callback.

Implements ISynchronizer.

◆ stop()

virtual void JackSynchronizer::stop ( )
virtual

Stops the synchronizer playback.

Implements ISynchronizer.


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