AudioSource¶

类位于 InfEngine.components.builtin

描述¶

音频源组件。在场景中播放声音的扬声器。

description

名称	类型	描述
track_count	`int`	The number of audio tracks on this source.
volume	`float`	音量（0.0 到 1.0）。
pitch	`float`	音调。
mute	`bool`	Whether the audio source is muted.
loop	`bool`	是否循环播放。
play_on_awake	`bool`	是否在 Awake 时自动播放。
min_distance	`float`	3D 声音的最小距离。
max_distance	`float`	3D 声音的最大距离。
one_shot_pool_size	`int`	The maximum number of concurrent one-shot sounds.
output_bus	`str`	The name of the audio mixer bus to route output to.
is_playing	`bool`	当前是否正在播放。 (只读)
is_paused	`bool`	Whether any track is currently paused. (只读)
game_object_id	`int`	The ID of the GameObject this component is attached to. (只读)

properties

方法	描述
`set_track_clip(track_index: int, clip: Any) → None`	Assign an audio clip to the specified track.
`get_track_clip(track_index: int) → Any`	Return the audio clip assigned to the specified track.
`get_track_clip_guid(track_index: int) → str`	Return the asset GUID of the clip on the specified track.
`set_track_clip_by_guid(track_index: int, guid: str) → None`	Assign an audio clip to a track by its asset GUID.
`set_track_volume(track_index: int, volume: float) → None`	Set the volume of the specified track.
`get_track_volume(track_index: int) → float`	Return the volume of the specified track.
`play(track_index: int = ...) → None`	播放音频。
`stop(track_index: int = ...) → None`	停止。
`play_one_shot(clip: Any, volume_scale: float = ...) → None`	播放一次性音效（不影响主 clip）。
`stop_one_shots() → None`	Stop all currently playing one-shot sounds.
`pause(track_index: int = ...) → None`	暂停。
`un_pause(track_index: int = ...) → None`	Resume playback on the specified track.
`stop_all() → None`	Stop playback on all tracks and one-shots.
`is_track_playing(track_index: int) → bool`	Return whether the specified track is currently playing.
`is_track_paused(track_index: int) → bool`	Return whether the specified track is currently paused.
`serialize() → str`	Serialize the component to a JSON string.
`deserialize(json_str: str) → bool`	Deserialize the component from a JSON string.

public_methods

# TODO: Add example for AudioSource

example

see_also