soundbuffer.h Source File - ClanLib SDK
Description: soundbuffer.h Source File

soundbuffer.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32#include "soundbuffer_session.h"
33#include "../Core/Resources/resource.h"
34
35namespace clan
36{
39
40 class SoundOutput;
41 class SoundProvider;
42 class SoundBuffer_Session;
43 class SoundFilter;
44 class SoundBuffer_Impl;
45 class IODevice;
46 class FileSystem;
47 class ResourceManager;
48 class XMLResourceDocument;
49
55 class SoundBuffer
56 {
57 public:
59 SoundBuffer();
60
62
74
75 SoundBuffer(
76 const std::string &fullname,
77 bool streamed = false,
78 const std::string &format = "");
79
80 SoundBuffer(
81 const std::string &filename,
82 bool streamed,
83 const FileSystem &fs,
84 const std::string &type = "");
85
86 SoundBuffer(
87 IODevice &file,
88 bool streamed,
89 const std::string &type);
90
96 static Resource<SoundBuffer> resource(const std::string &id, const ResourceManager &resources);
97
99 static SoundBuffer load(const std::string & id, const XMLResourceDocument & doc);
100
101 virtual ~SoundBuffer();
102
104 SoundProvider *get_provider() const;
105
107 float get_volume() const;
108
110 float get_pan() const;
111
113 bool is_null() const { return !impl; }
114
116 void throw_if_null() const;
117
119
122 void set_volume(float new_volume);
123
125
129 void set_pan(float new_pan);
130
134 void add_filter(SoundFilter &filter);
135
137 void remove_filter(SoundFilter &filter);
138
145 SoundBuffer_Session play(bool looping = false, SoundOutput *output = nullptr);
146
152 SoundBuffer_Session prepare(bool looping = false, SoundOutput *output = nullptr);
153
154 private:
155 std::shared_ptr<SoundBuffer_Impl> impl;
156 };
157
159}
clan::FileSystem
Virtual File System (VFS).
Definition file_system.h:47
clan::IODevice
I/O Device interface.
Definition iodevice.h:50
clan::ResourceManager
Resource manager.
Definition resource_manager.h:44
clan::Resource
Resource proxy of a specific type.
Definition resource.h:58
clan::SoundBuffer_Session
SoundBuffer_Session provides control over a playing soundeffect.
Definition soundbuffer_session.h:51
clan::SoundBuffer::set_volume
void set_volume(float new_volume)
Sets the volume of the sound buffer in a relative measure (0->1)
clan::SoundBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::SoundBuffer::set_pan
void set_pan(float new_pan)
Sets the panning of the sound buffer played in measures from -1 -> 1.
clan::SoundBuffer::add_filter
void add_filter(SoundFilter &filter)
Adds the sound filter to the sound buffer.
clan::SoundBuffer::resource
static Resource< SoundBuffer > resource(const std::string &id, const ResourceManager &resources)
Retrieves a SoundBuffer resource from the resource manager.
clan::SoundBuffer::SoundBuffer
SoundBuffer()
Construct a null instance.
clan::SoundBuffer::play
SoundBuffer_Session play(bool looping=false, SoundOutput *output=nullptr)
Plays the soundbuffer on the specified soundcard.
clan::SoundBuffer::get_provider
SoundProvider * get_provider() const
Returns the sound provider to be used for playback.
clan::SoundBuffer::load
static SoundBuffer load(const std::string &id, const XMLResourceDocument &doc)
Loads a SoundBuffer from a XML resource definition.
clan::SoundBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition soundbuffer.h:113
clan::SoundBuffer::SoundBuffer
SoundBuffer(IODevice &file, bool streamed, const std::string &type)
clan::SoundBuffer::SoundBuffer
SoundBuffer(const std::string &filename, bool streamed, const FileSystem &fs, const std::string &type="")
clan::SoundBuffer::get_volume
float get_volume() const
Returns the start/default volume used when the buffer is played.
clan::SoundBuffer::remove_filter
void remove_filter(SoundFilter &filter)
Remove the sound filter from the sound buffer.
clan::SoundBuffer::SoundBuffer
SoundBuffer(const std::string &fullname, bool streamed=false, const std::string &format="")
Construct sound buffer.
clan::SoundBuffer::prepare
SoundBuffer_Session prepare(bool looping=false, SoundOutput *output=nullptr)
Prepares the soundbuffer for playback on the specified soundcard.
clan::SoundBuffer::~SoundBuffer
virtual ~SoundBuffer()
clan::SoundBuffer::get_pan
float get_pan() const
Returns the default panning position when the buffer is played.
clan::SoundFilter
Sound Filter Class.
Definition soundfilter.h:44
clan::SoundOutput
SoundOutput interface in ClanLib.
Definition soundoutput.h:48
clan::SoundProvider
Sound provider.
Definition soundprovider.h:46
clan::XMLResourceDocument
XML Resource Document.
Definition xml_resource_document.h:48
clan
Definition clanapp.h:36