Play.md

Classes

BaseDirective ⇐ BaseDirective

Play 用于生成Play指令的类

Play

BaseDirective ⇐ BaseDirective

Play 用于生成Play指令的类

Kind: global class
Extends: BaseDirective

Play

Kind: global class
Access: public

• Play
  • new Play(url, playBehavior)
  • .setToken(token)
  • .getToken() ⇒ string
  • .setUrl(url)
  • .setOffsetInMilliseconds(milliSeconds)
  • .setExpiryTime(expiryTime)
  • .setReportDelayInMs(reportDelayMs)
  • .setReportIntervalInMs(intervalMs)
  • .setExpectedPreviousToken(previousToken)
  • .setStopPointsInMilliseconds(stopPoints)

new Play(url, playBehavior)

构造方法

Param	Type	Description
url	string	音频播放地址
playBehavior	string	默认替换所有 REPLACE_ALL: 立即停止当前播放并清除播放队列，立即播放指令中的audio item。 ENQUEUE: 将audio item添加到当前队列的尾部。 REPLACE_ENQUEUED: 替换播放队列中的所有audio item，但不影响当前正在播放的audio item。

play.setToken(token)

设置directive的token. 默认在构造时自动生成了token，可以覆盖

Kind: instance method of Play
Access: public

Param	Type	Description
token	string	视频的token

play.getToken() ⇒ string

获取directive的token. 默认在构造时自动生成了token

Kind: instance method of Play
Access: public

play.setUrl(url)

设置directive的视频地址url

Kind: instance method of Play
Access: public

Param	Type	Description
url	string	视频地址

play.setOffsetInMilliseconds(milliSeconds)

设置directive的属性。从指定的offset开始进行播放

Kind: instance method of Play
Access: public

Param	Type	Description
milliSeconds	number	毫秒数,比如5分钟的视频，播放的长度是5601000毫秒，选择起始的播放位置

play.setExpiryTime(expiryTime)

stream过期时间

Kind: instance method of Play
Access: public

Param	Type	Description
expiryTime	string	过期时间

play.setReportDelayInMs(reportDelayMs)

设置directive的属性。如果此字段存在，则设备端在播放该video item时，播放到所指定时间之后应该上报ProgressReportDelayElapsed事件；如果此字段不存在，则设备端端不需要上报ProgressReportDelayEsapsed事件

Kind: instance method of Play
Access: public

Param	Type	Description
reportDelayMs	number	毫秒数。

play.setReportIntervalInMs(intervalMs)

设置directive的属性。定时上报事件的间隔时间,如果此字段存在，则设备端在播放该video item时，每隔指定时间上报ProgressReportIntervalElapsed事件；如果此字段不存在，则设备端不需要上报ProgressReportIntervalElapsed事件

Kind: instance method of Play
Access: public

Param	Type	Description
intervalMs	number	毫秒数。

play.setExpectedPreviousToken(previousToken)

设置directive的属性。如果此字段存在，则应当匹配前一个video item中的token，如果不匹配则不执行本Play指令

Kind: instance method of Play
Access: public

Param	Type	Description
previousToken	string	上一首的token。

play.setStopPointsInMilliseconds(stopPoints)

播放到指定的offset后停止播放，并且会上报PlaybackScheduledStopReached事件

Kind: instance method of Play
Access: public

Param	Type	Description
stopPoints	number | Array	停止点。