blob: 430230fbcb3ff69457da4a29741cfc2743234450 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*******************************************************************************
* Copyright 2009-2016 Jörg Müller
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
#pragma once
/**
* @file ISynchronizer.h
* @ingroup devices
* The ISynchronizer interface.
*/
#include "Audaspace.h"
#include <memory>
AUD_NAMESPACE_BEGIN
class IHandle;
/**
* @interface ISynchronizer
* This class enables global synchronization of several audio applications if supported.
* JACK for example supports synchronization through JACK Transport.
*/
class AUD_API ISynchronizer
{
public:
/**
* Destroys the synchronizer.
*/
virtual ~ISynchronizer() {}
/**
* The syncFunction is called when a synchronization event happens.
* The function awaits three parameters. The first one is a user defined
* pointer, the second informs about whether playback is on and the third
* is the current playback time in seconds.
*/
typedef void (*syncFunction)(void*, int, float);
/**
* Sets the playback position of a handle and the synchronizer to a specific time.
* @param handle The handle that should be synchronized/seeked.
* @param time The absolute time to synchronize to.
*/
virtual void seek(std::shared_ptr<IHandle> handle, double time) = 0;
/**
* Retrieves the position of the synchronizer.
* @param handle The handle which is synchronized.
* @return The position in seconds.
*/
virtual double getPosition(std::shared_ptr<IHandle> handle) = 0;
/**
* Starts the synchronizer playback.
*/
virtual void play() = 0;
/**
* Stops the synchronizer playback.
*/
virtual void stop() = 0;
/**
* Sets the callback function that is called when a synchronization event happens.
* @param function The function to be called.
* @param data User data to be passed to the callback.
*/
virtual void setSyncCallback(syncFunction function, void* data) = 0;
/**
* Retrieves whether the synchronizer is playing back.
* @return Whether the synchronizer plays back.
*/
virtual int isPlaying() = 0;
};
AUD_NAMESPACE_END
|
