使用指南
Cocos 组件 / 音频 / AudioSource节点
Cocos 组件 / 音频 / AudioSource 节点手册，包含 21 个节点的用途、引脚、使用场景和注意事项。
16
学习目标
访问 Cocos Creator 组件的属性、方法和事件，把引擎能力转成可视化工作流。
覆盖范围
- 节点数量：21
- 分类路径：Cocos 组件 / 音频 / AudioSource
典型使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
通用注意事项
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
节点索引
| 节点 | 节点 ID | 输入/输出 | 执行方式 |
|---|---|---|---|
| 绑定播放结束事件 | audioSourceEndedBind | 3 / 2 | 立即继续 |
| 绑定开始播放事件 | audioSourceStartedBind | 3 / 2 | 立即继续 |
| 播放音频 | audioSourcePlay | 2 / 2 | 立即继续 |
| 获取播放进度 | audioSourceGetCurrentTime | 1 / 1 | 立即继续 |
| 获取播放中 | audioSourceGetPlaying | 1 / 1 | 立即继续 |
| 获取播放状态 | audioSourceGetState | 1 / 1 | 立即继续 |
| 获取全部属性 | audioSourceGetProperties | 1 / 8 | 立即继续 |
| 获取循环播放 | audioSourceGetLoop | 1 / 1 | 立即继续 |
| 获取音量 | audioSourceGetVolume | 1 / 1 | 立即继续 |
| 获取音频资产 | audioSourceGetClip | 1 / 1 | 立即继续 |
| 获取自动播放 | audioSourceGetPlayOnAwake | 1 / 1 | 立即继续 |
| 获取总时长 | audioSourceGetDuration | 1 / 1 | 立即继续 |
| 设置播放进度 | audioSourceSetCurrentTime | 3 / 2 | 立即继续 |
| 设置全部属性 | audioSourceSetProperties | 7 / 2 | 立即继续 |
| 设置循环播放 | audioSourceSetLoop | 3 / 2 | 立即继续 |
| 设置音量 | audioSourceSetVolume | 3 / 2 | 立即继续 |
| 设置音频资产 | audioSourceSetClip | 3 / 2 | 立即继续 |
| 设置自动播放 | audioSourceSetPlayOnAwake | 3 / 2 | 立即继续 |
| 停止音频 | audioSourceStop | 2 / 2 | 立即继续 |
| 一次性播放 | audioSourcePlayOneShot | 4 / 2 | 立即继续 |
| 暂停音频 | audioSourcePause | 2 / 2 | 立即继续 |
绑定播放结束事件
绑定音频播放结束事件：当音频播放自然结束时触发，自动执行下游逻辑。可用于在音频播放完毕后播放下一个音频或触发对话。 循环播放模式下，每轮播放结束时都会触发。触发时携带 AudioSource 组件信息。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceEndedBind |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
event | 事件 | 事件 | 事件 | 事件入口 连接到事件节点的输出引脚以触发绑定 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 触发 | 执行流 | 执行流 | 事件触发时执行 | - | 可选 |
handle | 句柄 | 数据 | eventHandle | 绑定句柄 用于后续取消这个具体监听。 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
绑定开始播放事件
绑定音频开始播放事件：当默认音频开始播放时触发，自动执行下游逻辑。可用于在音频播放时同步显示字幕或更新 UI。 触发时携带触发事件的 AudioSource 组件信息。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceStartedBind |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
event | 事件 | 事件 | 事件 | 事件入口 连接到事件节点的输出引脚以触发绑定 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 触发 | 执行流 | 执行流 | 事件触发时执行 | - | 可选 |
handle | 句柄 | 数据 | eventHandle | 绑定句柄 用于后续取消这个具体监听。 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
播放音频
播放默认音频：开始播放 AudioSource 的默认音频。 已播放时会重新开始，已暂停时会继续播放。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourcePlay |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取播放进度
获取当前播放进度：读取当前播放进度，单位秒。可用于显示音频播放进度条。 尚未加载或未播放时返回 0。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetCurrentTime |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
currentTime | 播放进度 | 数据 | number | 当前播放进度，单位秒 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取播放中
获取是否正在播放：快速判断当前是否处于播放状态，等价于 state === PLAYING。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetPlaying |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
playing | 播放中 | 数据 | boolean | 是否正在播放 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取播放状态
获取播放状态：获取当前音频播放状态。可用于判断音频是否正在播放，以决定下一步逻辑。 状态值含义： 0 = 未初始化（尚未可播放） 1 = 正在播放 2 = 已暂停 3 = 已停止 4 = 被系统中断（如来电）
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetState |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
state | 状态 | 数据 | number | 播放状态：0=未初始化、1=播放中、2=已暂停、3=已停止、4=被系统中断 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取全部属性
获取全部属性：同时读取音频剪辑、循环、自动播放、音量、播放进度、总时长、播放状态等信息，一次获取所有常用配置。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
clip | 音频 | 数据 | cc.Asset / AudioClip | 当前绑定的默认 AudioClip | - | 可选 |
loop | 循环 | 数据 | boolean | 是否循环播放 | - | 可选 |
playOnAwake | 自动播放 | 数据 | boolean | 启用时是否自动播放 | - | 可选 |
volume | 音量 | 数据 | number | 当前音量 | - | 可选 |
currentTime | 播放进度 | 数据 | number | 当前播放进度（秒） | - | 可选 |
duration | 总时长 | 数据 | number | 音频总时长（秒） | - | 可选 |
state | 状态 | 数据 | number | 播放状态：0=未初始化、1=播放中、2=已暂停、3=已停止、4=被系统中断 | - | 可选 |
playing | 播放中 | 数据 | boolean | 是否正在播放 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取循环播放
获取循环播放状态：读取是否循环播放默认音频。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetLoop |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
loop | 循环 | 数据 | boolean | 是否循环播放默认音频 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取音量
获取当前音量：读取 AudioSource 的音量值，范围通常为 0~1。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetVolume |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
volume | 音量 | 数据 | number | 当前音量，范围 0~1 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取音频资产
获取默认音频：读取 AudioSource 当前绑定的默认音频剪辑。用于检查当前使用的是哪个音频文件。 若未配置默认音频，返回 null。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetClip |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
clip | 音频 | 数据 | cc.Asset / AudioClip | 当前绑定的默认 AudioClip，可能为 null | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取自动播放
获取自动播放状态：读取组件启用时是否尝试自动播放。 注意：Web 平台首次自动播放仍受用户手势策略限制，即使设为 true 也可能被浏览器拦截。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetPlayOnAwake |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
playOnAwake | 自动播放 | 数据 | boolean | 组件启用时是否尝试自动播放 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
获取总时长
获取音频总时长：读取默认音频的总时长，单位秒。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceGetDuration |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
duration | 总时长 | 数据 | number | 默认音频总时长，单位秒 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置播放进度
设置播放进度：设置当前播放位置，单位秒。用于实现音频快进、重播或跳转到指定段落。 设置的值会自动限制在 0 到音频总时长之间。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetCurrentTime |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
currentTime | 播放进度 | 数据 | number | 播放进度（秒），自动限制在 0~音频总时长 | 输入框 默认值：0 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置全部属性
设置全部属性：同时修改音频剪辑、循环、自动播放、音量和播放进度，一次完成多项配置。 说明：除执行和组件引脚外，其他属性引脚默认不显示，需要在节点上手动公开后才能使用。总时长、播放状态等为只读属性，不可写入。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
clip | 音频 | 数据 | cc.Asset / AudioClip | 新的默认 AudioClip | - | 可选 默认隐藏 |
loop | 循环 | 数据 | boolean | 是否循环播放 | 开关 默认值：false | 可选 默认隐藏 |
playOnAwake | 自动播放 | 数据 | boolean | 是否启用时自动播放 | 开关 默认值：true | 可选 默认隐藏 |
volume | 音量 | 数据 | number | 音量值，范围 0~1 | 输入框 默认值：1 | 可选 默认隐藏 |
currentTime | 播放进度 | 数据 | number | 播放进度（秒） | 输入框 默认值：0 | 可选 默认隐藏 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置循环播放
设置循环播放：切换默认音频是否循环播放。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetLoop |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
loop | 循环 | 数据 | boolean | 是否循环播放 | 开关 默认值：false | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置音量
设置音量：设置 AudioSource 的音量大小。用于游戏中控制背景音乐或音效的音量。 音量范围 0（静音）~1（最大音量）。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetVolume |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
volume | 音量 | 数据 | number | 音量值，范围 0~1 | 输入框 默认值：1 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置音频资产
设置默认音频：设置 AudioSource 的默认音频剪辑。可用于动态更换背景音乐或角色语音。 允许传入 null 清空当前音频。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetClip |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
clip | 音频 | 数据 | cc.Asset / AudioClip | 新的默认 AudioClip，允许为 null | - | 可选 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
设置自动播放
设置自动播放：控制组件启用时是否自动播放默认音频。 注意：Web 平台首次自动播放仍受用户手势策略限制，即使设为 true 也可能被浏览器拦截。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceSetPlayOnAwake |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
playOnAwake | 自动播放 | 数据 | boolean | 是否启用时自动播放 | 开关 默认值：true | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
停止音频
停止播放：停止当前播放的音频并重置播放进度。用于关闭背景音乐或停止音效。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourceStop |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
一次性播放
一次性播放音效：临时播放一次指定的音频剪辑，不会影响当前正在播放的默认音频。适用于按钮点击、道具拾取等一次性音效。 最终音量为组件音量与音量缩放的乘积，可通过音量缩放单独控制此次播放的音量。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourcePlayOneShot |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
clip | 音频 | 数据 | cc.Asset / AudioClip | 要临时播放的 AudioClip | - | 必填 |
volumeScale | 音量缩放 | 数据 | number | 音量缩放系数，最终音量为组件音量与此系数的乘积 | 输入框 默认值：1 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。
暂停音频
暂停当前播放：暂停正在播放的音频。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | audioSourcePause |
| 分类 | Cocos 组件 |
| 二级分类 | 音频 |
| 分组 | AudioSource |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 目标 AudioSource 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
audioSource | 音频源 | 数据 | cc.Component / AudioSource | 透传 AudioSource 组件 | - | 可选 |
使用场景
- 播放背景音乐和按钮音效
- 根据游戏设置动态调整音量、循环和播放状态
- 在动画或事件触发时播放一次性音效
注意事项
- 适合的工作流类型：component、library、method、function、class。
- AudioSource 播放控制应连接目标组件实例。
- AudioClip 资产需要先加载或在组件上配置。