blob: 0aeffd53e8785274f42b1edc580c2fd97db0cdc7 (
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
|
/*******************************************************************************
* Copyright 2015-2016 Juan Francisco Crespo Galán
*
* 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 VolumeSound.h
* @ingroup fx
* The VolumeSound class.
*/
#include "ISound.h"
#include "VolumeStorage.h"
#include <memory>
AUD_NAMESPACE_BEGIN
/**
* This class allows to create a sound with its own volume.
*/
class AUD_API VolumeSound : public ISound
{
private:
/**
* A pointer to a sound.
*/
std::shared_ptr<ISound> m_sound;
/**
* A pointer to the shared volume being used.
*/
std::shared_ptr<VolumeStorage> m_volumeStorage;
// delete copy constructor and operator=
VolumeSound(const VolumeSound&) = delete;
VolumeSound& operator=(const VolumeSound&) = delete;
public:
/**
* Creates a new VolumeSound.
* \param sound The sound in which shall have its own volume.
* \param volumeStorage A shared pointer to a VolumeStorage object. It allows to change the volume of various sound in one go.
*/
VolumeSound(std::shared_ptr<ISound> sound, std::shared_ptr<VolumeStorage> volumeStorage);
virtual std::shared_ptr<IReader> createReader();
/**
* Retrieves the shared volume of this sound.
* \return A shared pointer to the VolumeStorage object that this sound is using.
*/
std::shared_ptr<VolumeStorage> getSharedVolume();
/**
* Changes the shared volume of this sound, it'll only affect newly created readers.
* \param volumeStorage A shared pointer to the new VolumeStorage object.
*/
void setSharedVolume(std::shared_ptr<VolumeStorage> volumeStorage);
};
AUD_NAMESPACE_END
|
