Audaspace  1.3.0
A high level audio library.
ISynchronizer.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16 
17 #pragma once
18 
25 #include "Audaspace.h"
26 
27 #include <memory>
28 
30 
31 class IHandle;
32 
39 {
40 public:
44  virtual ~ISynchronizer() {}
45 
52  typedef void (*syncFunction)(void*, int, float);
53 
59  virtual void seek(std::shared_ptr<IHandle> handle, float time) = 0;
60 
66  virtual float getPosition(std::shared_ptr<IHandle> handle) = 0;
67 
71  virtual void play() = 0;
72 
76  virtual void stop() = 0;
77 
83  virtual void setSyncCallback(syncFunction function, void* data) = 0;
84 
89  virtual int isPlaying() = 0;
90 };
91 
ISynchronizer::play
virtual void play()=0
Starts the synchronizer playback.
ISynchronizer::seek
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.
ISynchronizer
This class enables global synchronization of several audio applications if supported.
Definition: ISynchronizer.h:39
ISynchronizer::setSyncCallback
virtual void setSyncCallback(syncFunction function, void *data)=0
Sets the callback function that is called when a synchronization event happens.
ISynchronizer::~ISynchronizer
virtual ~ISynchronizer()
Destroys the synchronizer.
Definition: ISynchronizer.h:44
ISynchronizer::stop
virtual void stop()=0
Stops the synchronizer playback.
AUD_NAMESPACE_END
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition: Audaspace.h:119
ISynchronizer::isPlaying
virtual int isPlaying()=0
Retrieves whether the synchronizer is playing back.
IHandle
The IHandle interface represents a playback handles of a specific device.
Definition: IHandle.h:49
AUD_NAMESPACE_BEGIN
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition: Audaspace.h:116
AUD_API
#define AUD_API
Used for exporting symbols in the shared library.
Definition: Audaspace.h:93
ISynchronizer::getPosition
virtual float getPosition(std::shared_ptr< IHandle > handle)=0
Retrieves the position of the synchronizer.
Audaspace.h
The main header file of the library defining the namespace and basic data types.