AudioStreamPlayer Properties

If true, audio plays when added to scene tree.

Bus on which this audio is playing.

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

If the audio configuration has more than two speakers, this sets the target channels. See AudioStreamPlayerMixTargetEnum constants.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.

If true, audio is playing.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

The AudioStream object to be played.

If true, the playback is paused. You can resume it by setting stream_paused to false.

Volume of sound, in dB.