Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
Fader.h
Go to the documentation of this file.
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
25#include "fx/Effect.h"
26#include "fx/FaderReader.h"
27
29
35class AUD_API Fader : public Effect
36{
37private:
41 const FadeType m_type;
42
46 const double m_start;
47
51 const double m_length;
52
53 // delete copy constructor and operator=
54 Fader(const Fader&) = delete;
55 Fader& operator=(const Fader&) = delete;
56
57public:
65 Fader(std::shared_ptr<ISound> sound,
66 FadeType type = FADE_IN,
67 double start = 0, double length = 1);
68
73
77 double getStart() const;
78
82 double getLength() const;
83
84 virtual std::shared_ptr<IReader> createReader();
85};
86
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition Audaspace.h:119
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition Audaspace.h:116
#define AUD_API
Used for exporting symbols in the shared library.
Definition Audaspace.h:93
The Effect class.
Defines the FaderReader class as well as the two fading types.
FadeType
Fading types.
Definition FaderReader.h:31
This sound is a base class for all effect factories that take one other sound as input.
Definition Effect.h:34
This sound fades another sound.
Definition Fader.h:36
FadeType getType() const
Returns the fading type.
Fader(std::shared_ptr< ISound > sound, FadeType type=FADE_IN, double start=0, double length=1)
Creates a new fader sound.
double getLength() const
Returns the fading length.
double getStart() const
Returns the fading start.
virtual std::shared_ptr< IReader > createReader()
Creates a reader for playback of the sound source.