AudioStreamPlaybackPolyphonic

继承: AudioStreamPlayback < RefCounted < Object

AudioStreamPolyphonic 的播放实例。

描述

AudioStreamPolyphonic 的播放实例。设置 AudioStreamPlayerAudioStreamPlayer2DAudioStreamPlayer3Dstream 属性后,可以通过调用 AudioStreamPlayer.get_stream_playbackAudioStreamPlayer2D.get_stream_playbackAudioStreamPlayer3D.get_stream_playback 方法获取播放实例。

方法

bool

is_stream_playing ( int stream ) const

int

play_stream ( AudioStream stream, float from_offset=0, float volume_db=0, float pitch_scale=1.0 )

void

set_stream_pitch_scale ( int stream, float pitch_scale )

void

set_stream_volume ( int stream, float volume_db )

void

stop_stream ( int stream )


常量

INVALID_ID = -1

无法为播放分配一个流时由 play_stream 返回。


方法说明

bool is_stream_playing ( int stream ) const

与整数 ID 关联的流仍在播放时返回 true。请检查 play_stream 以获取有关此 ID 何时失效的信息。


int play_stream ( AudioStream stream, float from_offset=0, float volume_db=0, float pitch_scale=1.0 )

以给定的偏移量、音量和音高播放 AudioStream。播放立即开始。

返回值是与该播放流关联的唯一整数 ID,可用于控制该播放流。

当流结束(不循环)、AudioStreamPlaybackPolyphonic 停止或 stop_stream 被调用时,该 ID 将失效。

如果当前播放的流的数量等于 AudioStreamPolyphonic.polyphony,则该函数将返回 INVALID_ID。如果需要更大的最大复音数,请提高该值。


void set_stream_pitch_scale ( int stream, float pitch_scale )

改变流的音阶。stream 参数是一个由 play_stream 返回的整数 ID。


void set_stream_volume ( int stream, float volume_db )

改变流的音量(单位:db)。stream 参数是一个由 play_stream 返回的整数 ID。


void stop_stream ( int stream )

停止某个流。stream 参数是由 play_stream 返回的整数 ID,在调用这个函数后失效。

Previous Next


© 版权所有 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision b1c660f7.

Built with Sphinx using a theme provided by Read the Docs.