StreamSoundSource Class Reference
#include <streamsoundsource.h>
Inheritance diagram for StreamSoundSource:
Collaboration diagram for StreamSoundSource:
Public Types | |
| enum | DownMix { NoDownMix, DownMixLeft, DownMixRight } |
 Public Types inherited from SoundSource | |
| enum | FadeState { NoFading, FadingOn, FadingOff } |
Public Member Functions | |
| StreamSoundSource () | |
| virtual | ~StreamSoundSource () |
| void | play () |
| void | stop () |
| bool | isPlaying () |
| void | setSoundFile (const SoundFilePtr &soundFile) |
| void | downMix (DownMix downMix) |
| void | update () |
| Public Member Functions inherited from SoundSource | |
| SoundSource () | |
| virtual | ~SoundSource () |
| virtual bool | isBuffering () |
| void | setName (const std::string &name) |
| virtual void | setLooping (bool looping) |
| virtual void | setRelative (bool relative) |
| virtual void | setReferenceDistance (float distance) |
| virtual void | setGain (float gain) |
| virtual void | setPitch (float pitch) |
| virtual void | setPosition (const Point &pos) |
| virtual void | setVelocity (const Point &velocity) |
| virtual void | setFading (FadeState state, float fadetime) |
| std::string | getName () |
| uchar | getChannel () |
| float | getGain () |
| Public Member Functions inherited from LuaObject | |
| LuaObject () | |
| virtual | ~LuaObject () |
| template<typename T > | |
| void | connectLuaField (const std::string &field, const std::function< T > &f, bool pushFront=false) |
| template<typename... T> | |
| int | luaCallLuaField (const std::string &field, const T &... args) |
| template<typename R , typename... T> | |
| R | callLuaField (const std::string &field, const T &... args) |
| template<typename... T> | |
| void | callLuaField (const std::string &field, const T &... args) |
| bool | hasLuaField (const std::string &field) |
| Returns true if the lua field exists. More... | |
| template<typename T > | |
| void | setLuaField (const std::string &key, const T &value) |
| Sets a field in this lua object. More... | |
| template<typename T > | |
| T | getLuaField (const std::string &key) |
| Gets a field from this lua object. More... | |
| void | releaseLuaFieldsTable () |
| Release fields table reference. More... | |
| void | luaSetField (const std::string &key) |
| Sets a field from this lua object, the value must be on the stack. More... | |
| void | luaGetField (const std::string &key) |
| Gets a field from this lua object, the result is pushed onto the stack. More... | |
| void | luaGetMetatable () |
| Get object's metatable. More... | |
| void | luaGetFieldsTable () |
| Gets the table containing all stored fields of this lua object, the result is pushed onto the stack. More... | |
| int | getUseCount () |
| std::string | getClassName () |
| Returns the derived class name, its the same name used in Lua. More... | |
| LuaObjectPtr | asLuaObject () |
| void | operator= (const LuaObject &) |
| Public Member Functions inherited from stdext::shared_object | |
| shared_object () | |
| virtual | ~shared_object () |
| void | add_ref () |
| void | dec_ref () |
| refcount_t | ref_count () |
| template<typename T > | |
| stdext::shared_object_ptr< T > | static_self_cast () |
| template<typename T > | |
| stdext::shared_object_ptr< T > | dynamic_self_cast () |
| template<typename T > | |
| stdext::shared_object_ptr< T > | const_self_cast () |
Additional Inherited Members | |
| Protected Member Functions inherited from SoundSource | |
| SoundSource (uint sourceId) | |
| void | setBuffer (const SoundBufferPtr &buffer) |
| void | setChannel (uchar channel) |
| Protected Attributes inherited from SoundSource | |
| uint | m_sourceId |
| uchar | m_channel |
| std::string | m_name |
| SoundBufferPtr | m_buffer |
| FadeState | m_fadeState |
| float | m_fadeStartTime |
| float | m_fadeTime |
| float | m_fadeGain |
| float | m_gain |
Detailed Description
Definition at line 28 of file streamsoundsource.h.
Member Enumeration Documentation
◆ DownMix
| Enumerator | |
|---|---|
| NoDownMix | |
| DownMixLeft | |
| DownMixRight | |
Definition at line 37 of file streamsoundsource.h.
Constructor & Destructor Documentation
◆ StreamSoundSource()
| StreamSoundSource::StreamSoundSource | ( | ) |
Definition at line 30 of file streamsoundsource.cpp.
◆ ~StreamSoundSource()
|
virtual |
Member Function Documentation
◆ downMix()
| void StreamSoundSource::downMix | ( | StreamSoundSource::DownMix | downMix | ) |
Definition at line 186 of file streamsoundsource.cpp.
◆ isPlaying()
|
inlinevirtual |
Reimplemented from SoundSource.
Definition at line 45 of file streamsoundsource.h.
◆ play()
|
virtual |
Reimplemented from SoundSource.
Definition at line 51 of file streamsoundsource.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setSoundFile()
| void StreamSoundSource::setSoundFile | ( | const SoundFilePtr & | soundFile | ) |
◆ stop()
|
virtual |
Reimplemented from SoundSource.
Definition at line 70 of file streamsoundsource.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ update()
|
virtual |
Reimplemented from SoundSource.
Definition at line 101 of file streamsoundsource.cpp.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- src/framework/sound/streamsoundsource.h
- src/framework/sound/streamsoundsource.cpp
