Urho3D::SoundStream Class Referenceabstract
Base class for sound streams. More...
#include <Urho3D/Audio/SoundStream.h>
Inheritance diagram for Urho3D::SoundStream:
Public Member Functions | |
| SoundStream () | |
| Construct. | |
| ~SoundStream () override | |
| Destruct. | |
| virtual bool | Seek (unsigned sample_number) |
| Seek to sample number. Return true on success. Need not be implemented by all streams. | |
| virtual unsigned | GetData (signed char *dest, unsigned numBytes)=0 |
| Produce sound data into destination. Return number of bytes produced. Called by SoundSource from the mixing thread. | |
| void | SetFormat (unsigned frequency, bool sixteenBit, bool stereo) |
| Set sound data format. | |
| void | SetStopAtEnd (bool enable) |
| Set whether playback should stop when no more data. Default false. | |
| unsigned | GetSampleSize () const |
| Return sample size. | |
| float | GetFrequency () const |
| Return default frequency as a float. | |
| unsigned | GetIntFrequency () const |
| Return default frequency as an integer. | |
| bool | GetStopAtEnd () const |
| Return whether playback should stop when no more data. | |
| bool | IsSixteenBit () const |
| Return whether data is sixteen bit. | |
| bool | IsStereo () const |
| Return whether data is stereo. | |
 Public Member Functions inherited from Urho3D::RefCounted | |
| RefCounted () | |
| Construct. Allocate the reference count structure and set an initial self weak reference. | |
| virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist. | |
| RefCounted (const RefCounted &rhs)=delete | |
| Prevent copy construction. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| int | AddRef () |
| int | ReleaseRef () |
| int | Refs () const |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () const |
| Return pointer to the reference count structure. | |
| bool | HasScriptObject () const |
| Return true if script runtime object wrapping this native object exists. | |
| bool | IsScriptStrongRef () const |
| Return true if script reference is strong. | |
Protected Attributes | |
| unsigned | frequency_ |
| Default frequency. | |
| bool | stopAtEnd_ |
| Stop when no more data flag. | |
| bool | sixteenBit_ |
| Sixteen bit flag. | |
| bool | stereo_ |
| Stereo flag. | |
Detailed Description
Base class for sound streams.
The documentation for this class was generated from the following files:
- Urho3D/Audio/SoundStream.h
- Urho3D/Audio/SoundStream.cpp