soundprovider_session.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_sound.h"
33 #include <memory>
34 #include "../soundformat.h"
35 
36 namespace clan
37 {
40 
41 class SoundProvider_Session_Impl;
42 
46 class CL_API_SOUND SoundProvider_Session
47 {
50 
51 public:
53 
54  virtual ~SoundProvider_Session();
55 
59 
60 public:
62  virtual int get_num_samples() const = 0;
63 
65 
66  virtual int get_frequency() const = 0;
67 
69  virtual int get_position() const = 0;
70 
72  virtual int get_num_channels() const = 0;
73 
77 
78 public:
80 
82  virtual bool set_looping(bool /* loop */) { return false; }
83 
85 
86  virtual bool eof() const = 0;
87 
89  virtual void stop() = 0;
90 
92 
93  virtual bool play() = 0;
94 
100  virtual bool set_position(int pos) = 0;
101 
107  virtual bool set_end_position(int pos) = 0;
108 
114  virtual int get_data(float **data_ptr, int data_requested) = 0;
115 
119 
120 private:
121 
123 };
124 
125 }
126 
virtual bool set_looping(bool)
Enable/disable session looping.
Definition: soundprovider_session.h:82
Sound provider playback session.
Definition: soundprovider_session.h:46