Skip to main content

PlaybackControl

回放控制

用于控制音频播放 UI(用户界面)的状态对象。

扩展

方法

getIndexInParent

getIndexInParent(){number}

继承自:嵌套对象 - getIndexInParent

获取在父级对象中当前对象的索引。在 Lua 中索引从 1 开始,在 JavaScript 中索引从 0 开始。

返回:

类型:数字

getParent

getParent(){NestedObject|undefined}

继承自:嵌套对象 - getParent

获取父级 嵌套对象 。如果不存在则返回 undefined

返回:

类型:嵌套对象 | undefined

getPlayhead

getPlayhead(){number}

获取当前播放头(译者注:应该就是指播放进度条上的光标)的位置(以秒的形式)。

想要以 blicks 的形式获取位置的话,就将其与当前项目的 时间轴 一起使用。

返回:

类型:数字

getStatus

getStatus(){string}

获取当前的播放状态。其可能是以下三种之一。

  • "playing"(播放)
  • "looping"(循环)
  • "stopped"(停止)

返回:

类型:字符串

isMemoryManaged

isMemoryManaged(){boolean}

继承自:嵌套对象 - isMemoryManaged

检测选中的对象是否被内存管理(即脚本环境的垃圾回收)。

返回:

类型:布尔

loop

loop(tBegin, tEnd)

tBegin 秒和 tEnd 秒之间开始循环。

参数:

参数名类型描述
tBegin数字
tEnd数字

pause

pause()

停止播放,播放头保持在当前位置。

play

play()

开始播放音频。

seek

seek(t)

将播放头的位置置为 t 秒处。

如果当前音频正在播放,其不会停止音频,而是会在新的位置继续播放。

参数:

参数名类型描述
t数字

stop

stop()

停止播放,并且将播放头设置到起始处。