AudioPlayer

显示已弃用

*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处

AudioPlayer 用于播放音频资产。它提供一个单一的 输出 端口,可以通过 Wires 连接到其他端口。

代码示例

Outputting Audio to Device

local audioPlayer : AudioPlayer = Instance.new("AudioPlayer")
audioPlayer.Parent = workspace
audioPlayer.AssetId = "rbxassetid://9112854440"
local deviceOutput = Instance.new("AudioDeviceOutput")
deviceOutput.Parent = workspace
local wire = Instance.new("Wire")
wire.Parent = workspace
wire.SourceInstance = audioPlayer
wire.TargetInstance = deviceOutput
audioPlayer:Play()

概要

属性

方法

属性

AssetId

读取并联

要加载到 AudioPlayer 。如果 AutoLoad 是真实的,资产将立即加载,一旦这个属性被分配。当加载完成后,IsReady 将变为真实。

AutoLoad

读取并联

控制是否 AssetId 在分配时自动加载。如果 false,资产将在第一次尝试播游玩时加载。

IsPlaying

读取并联
Roblox 安全性

在此处显示是否播放当前 AudioPlayer 。此属性是只读的,但是复制。要在执行时间时播放和停止 AudioPlayer ,请使用 Play() 和 1> Class.AudioPlayer:Stop()|Stop()1> 方法。

IsReady

只读
未复制
读取并联

在此 AudioPlayer 是否已加载、缓存并准备好播游玩。虽然不常见, AudioPlayers 在运行时可能会有其资产未加载,如果存在极端的内存压力,在此情况下 IsReady 将变为 false。

LoopRegion

读取并联

一个范围,在秒内,表示 PlaybackRegion 内所指示的所需循环开始和循环结束。

如果 LoopRegion 最低值小于 Class.AudioPlayer.PlaybackRegion|PlaybackRegion 最低值,循环从 PlaybackRegion 最低值开始。

如果 LoopRegion 最低值小于 更少 than PlaybackRegion 最低值,循环从 1> Class.AudioPlayer.PlaybackRegion|PlaybackRegion1> 最低值开始。

如果 LoopRegion 最大值大于 Class.AudioPlayer.PlaybackRegion|PlaybackRegion 最大值,循环将在 PlaybackRegion 最大值后结束。

如果 LoopRegion 最大值小于 更小PlaybackRegion 最大值,循环将在正确的 1> Class.AudioPlayer.LoopRegion|LoopRegion1> 最大值结束。

如果 LoopRegion 最小值 最大值 LoopRegion,那么 1> Class.AudioPlayer1> 使用了 4> Class.AudioPlayer.PlaybackRegion|PlaybackRegion4> 属性。

Looping

读取并联

控制是否超过了它的 TimeLength 结束时, LoopRegion 或 1> Class.AudioPlayer.PlaybackRegion|PlaybackRegion1> 。

PlaybackRegion

读取并联

TimeLength 内,代表所需开始时间(最小)和停止时间(最大)的范围。

如果 PlaybackRegion 最小值小于 0,音效将从 Class.AudioPlayer.PlaybackRegion|PlaybackRegion 最小时间开始播放。

如果 PlaybackRegion 最低值小于 0,声音将从 0 开始播放。

如果 PlaybackRegion 最大值大于 Class.AudioPlayer.TimeLength|TimeLength ,声音将在 TimeLength 停止。

如果 PlaybackRegion 最大值小于 小于TimeLength 的话,声音会停止在精确的 1> Class.AudioPlayer.PlaybackRegion|PlaybackRegion1> 最大值。

如果 PlaybackRegion 最低值 最大值 PlaybackRegion,声音在其整个播放区域。

PlaybackSpeed

读取并联

倍增器控制资产的播放速度,直接控制其感知的音调。从 0 到 20 范围。

TimeLength

只读
未复制
读取并联

在秒后表示已加载的 AssetId 的长度。

TimePosition

读取并联

跟踪和控制播放头在 AssetId 中的当前位置,以秒为单位。

Volume

读取并联

音量级别,可乘以输出音频串流,控制音乐资产的播放音量。从 0 到 3 之间。

方法

GetConnectedWires

Instances

返回连接到指定端置顶的 Wires 阵列。 AudioPlayer 有一个“输出”端置顶。

参数

pin: string

返回

Instances

Play

void

从其 AudioPlayer 位置播放 TimePosition。从服务器复制到客户端。


返回

void

Stop

void

AudioPlayer 的任何位置停止其 TimePosition。从服务器复制到客户端。


返回

void

GetWaveformAsync

暂停

参数

timeRange: NumberRange
samples: number

返回

活动

Ended

AudioPlayer 完成播放后,会发生。注意,该事件不会在播放结束后发生,因为它继续播放。这也会在 Class.AudioPlayer.IsPlaying|IsPlay

这个事件通常用于当 AudioPlayer 完成播放时摧毁它。


Looped

AudioPlayer 循环后发生的事件。当音频到达其内容(或 LoopRegion 如果它是活动)和 Looping 是 1> 真1> 。

如果音频通过手动循环 发生,这种事件会发生。