Index · Object → RefCounted → Resource → AudioStream → AudioStreamRandomizer

AudioStreamRandomizer

Wraps a pool of audio streams with pitch and volume shifting.

Class Description

Picks a random AudioStream from the pool, depending on the playback mode, and applies random pitch shifting and volume shifting during playback.

Properties

var playback_mode: AudioStreamRandomizer.PlaybackMode = 0

Controls how this AudioStreamRandomizer picks which AudioStream to play next.

var random_pitch: float = 1.0

The largest possible frequency multiplier of the random pitch variation. Pitch will be randomly chosen within a range of [code skip-lint]1.0 / random_pitch[/code] and [code skip-lint]random_pitch[/code]. A value of 1.0 means no variation. A value of 2.0 means pitch will be randomized between double and half.

Note: Setting this property also sets random_pitch_semitones.

var random_pitch_semitones: float = 0.0

The largest possible distance, in semitones, of the random pitch variation. A value of 0.0 means no variation.

Note: Setting this property also sets random_pitch.

var random_volume_offset_db: float = 0.0

The intensity of random volume variation. Volume will be increased or decreased by a random value up to [code skip-lint]random_volume_offset_db[/code]. A value of 0.0 means no variation. A value of 3.0 means volume will be randomized between -3.0 dB and +3.0 dB.

var stream_{index}/stream: AudioStream

The AudioStream at index.

Note: index is a value in the 0 .. streams_count - 1 range.

var stream_{index}/weight: float = 1.0

The probability weight of the AudioStream at index.

Note: index is a value in the 0 .. streams_count - 1 range.

var streams_count: int = 0

The number of streams in the stream pool.

Inherited from Resource (4)

Methods

func add_stream(index: int, stream: AudioStream, weight: float = 1.0) -> void

Insert a stream at the specified index. If the index is less than zero, the insertion occurs at the end of the underlying pool.

func get_stream(index: int) -> AudioStream

Returns the stream at the specified index.

func get_stream_probability_weight(index: int) -> float

Returns the probability weight associated with the stream at the given index.

func move_stream(index_from: int, index_to: int) -> void

Move a stream from one index to another.

func remove_stream(index: int) -> void

Remove the stream at the specified index.

func set_stream(index: int, stream: AudioStream) -> void

Set the AudioStream at the specified index.

func set_stream_probability_weight(index: int, weight: float) -> void

Set the probability weight of the stream at the specified index. The higher this value, the more likely that the randomizer will choose this stream during random playback modes.

Inherited from AudioStream (16)
func _get_bpm() -> float
func _get_length() -> float
func _get_parameter_list() -> Dictionary[]
func _has_loop() -> bool
func get_length() -> float
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from AudioStream (1)
Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum PlaybackMode
PLAYBACK_RANDOM_NO_REPEATS = 0

Pick a stream at random according to the probability weights chosen for each stream, but avoid playing the same stream twice in a row whenever possible. If only 1 sound is present in the pool, the same sound will always play, effectively allowing repeats to occur.

PLAYBACK_RANDOM = 1

Pick a stream at random according to the probability weights chosen for each stream. If only 1 sound is present in the pool, the same sound will always play.

PLAYBACK_SEQUENTIAL = 2

Play streams in the order they appear in the stream pool. If only 1 sound is present in the pool, the same sound will always play.