AudioStream

public bool CanBeSampled();

Returns if the current AudioStream can be used as a sample. Only static streams can be sampled.

public AudioSample GenerateSample();

Generates an AudioSample based on the current stream.

public double GetLength();

Override this method to customize the returned value of AudioStream.GetLength. Should return the length of this audio stream, in seconds.

public AudioStreamPlayback InstantiatePlayback();

Override this method to customize the returned value of AudioStream.InstantiatePlayback. Should return a new AudioStreamPlayback created when the stream is played (such as by an AudioStreamPlayer).

public bool IsMetaStream();

Returns true if the stream is a collection of other streams, false otherwise.

public bool IsMonophonic();

Override this method to customize the returned value of AudioStream.IsMonophonic. Should return true if this audio stream only supports one channel.

public virtual int _GetBarBeats();

Override this method to return the bar beats of this stream.

public virtual int _GetBeatCount();

Overridable method. Should return the total number of beats of this audio stream. Used by the engine to determine the position of every beat. Ideally, the returned value should be based off the stream's sample rate (AudioStreamWav.MixRate, for example).

public virtual double _GetBpm();

Overridable method. Should return the tempo of this audio stream, in beats per minute (BPM). Used by the engine to determine the position of every beat. Ideally, the returned value should be based off the stream's sample rate (AudioStreamWav.MixRate, for example).

public virtual double _GetLength();

Override this method to customize the returned value of AudioStream.GetLength. Should return the length of this audio stream, in seconds.

public virtual Reckfell.Collections.Array<Reckfell.Collections.Dictionary> _GetParameterList();

Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see ReckfellObject.GetPropertyList). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field.

public virtual string _GetStreamName();

Override this method to customize the name assigned to this audio stream.

public virtual Reckfell.Collections.Dictionary _GetTags();

Override this method to customize the tags for this audio stream. Should return a Reckfell.Collections.Dictionary of strings with the tag as the key and its content as the value. Commonly used tags include title, artist, album, tracknumber, and date.

public virtual bool _HasLoop();

Override this method to return true if this stream has a loop.

public virtual AudioStreamPlayback _InstantiatePlayback();

Override this method to customize the returned value of AudioStream.InstantiatePlayback. Should return a new AudioStreamPlayback created when the stream is played (such as by an AudioStreamPlayer).

public virtual bool _IsMonophonic();

Override this method to customize the returned value of AudioStream.IsMonophonic. Should return true if this audio stream only supports one channel.

public event Action ParameterListChanged;

Signal to be emitted to notify when the parameter list changed.