Keymap: pressing leader key (Alt) again closes tool prompt
[blender.git] / extern / audaspace / include / ISound.h
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
19 /**
20  * @file ISound.h
21  * @ingroup general
22  * The ISound interface.
23  */
24
25 #include "Audaspace.h"
26
27 #include <memory>
28
29 AUD_NAMESPACE_BEGIN
30
31 class IReader;
32
33 /**
34  * @interface ISound
35  * This class represents a type of sound source and saves the necessary values
36  * for it. It is able to create a reader that is actually usable for playback
37  * of the respective sound source through the factory method createReader.
38  */
39 class AUD_API ISound
40 {
41 public:
42         /**
43          * Destroys the sound.
44          */
45         virtual ~ISound() {}
46
47         /**
48          * Creates a reader for playback of the sound source.
49          * \return A pointer to an IReader object or nullptr if there has been an
50          *         error.
51          * \exception Exception An exception may be thrown if there has been
52          *            a more unexpected error during reader creation.
53          */
54         virtual std::shared_ptr<IReader> createReader()=0;
55 };
56
57 AUD_NAMESPACE_END