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

This class is a default ISynchronizer implementation that actually does no synchronization and is intended for devices that don't support it. More...

#include <DefaultSynchronizer.h>

Inheritance diagram for DefaultSynchronizer:
Inheritance graph
[legend]

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

This class is a default ISynchronizer implementation that actually does no synchronization and is intended for devices that don't support it.

Member Function Documentation

◆ getPosition()

virtual double DefaultSynchronizer::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 DefaultSynchronizer::isPlaying ( )
virtual

Retrieves whether the synchronizer is playing back.

Returns
Whether the synchronizer plays back.

Implements ISynchronizer.

◆ play()

virtual void DefaultSynchronizer::play ( )
virtual

Starts the synchronizer playback.

Implements ISynchronizer.

◆ seek()

virtual void DefaultSynchronizer::seek ( std::shared_ptr< IHandle handle,
double  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 DefaultSynchronizer::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 DefaultSynchronizer::stop ( )
virtual

Stops the synchronizer playback.

Implements ISynchronizer.


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