Urho.Audio.SoundStream Class

Base class for sound streams.

See Also: SoundStream

Syntax

public class SoundStream : RefCounted

Remarks

In addition to playing existing sound resources, sound can be generated during runtime using the SoundSource  class and its subclasses. To start playback of a stream on a SoundSource, call SoundSource.Play(SoundStream).

Sound streaming is used internally to implement on-the-fly Ogg Vorbis decoding. See the SoundSynthesis sample for an example of using the BufferedSoundStream subclass, which allows the sound data to be queued for playback from the main thread.

Requirements

Namespace: Urho.Audio
Assembly: Urho (in Urho.dll)
Assembly Versions: 1.0.0.0

The members of Urho.Audio.SoundStream are listed below.

See Also: RefCounted

Public Constructors

Constructs a new instance of Urho.Audio.SoundStream, given a raw pointer to an unmanaged object

Protected Constructors

Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.

Public Properties

[read-only]
FrequencySingle. Return default frequency as a float.
[read-only]
IntFrequencyUInt32. Return default frequency as an integer.
[read-only]
SampleSizeUInt32. Return sample size.
[read-only]
SixteenBitBoolean. Return whether audio data is sixteen bit.
[read-only]
StereoBoolean. Return whether data is stereo.
StopAtEndBoolean. Return whether playback should stop when no more data. Or Set whether playback should stop when no more data. Default false.

Public Methods

GetData(SByte*, UInt32) : UInt32
Produce sound data into destination. Return number of bytes produced. Called by SoundSource from the mixing thread.
SetFormat(UInt32, Boolean, Boolean)
Set sound data format.