播放器
幻灯片播放器插件:
var editor = new window.shimo.sdk.slide.Editor()
var player = new window.shimo.sdk.slide.plugins.Player({
editor: editor
})
方法列表
示例
var player = editor.player
player.play()
someCustomizeNextBtn.addEventListener('click', () => {
if (player.isPlaying()) {
player.next()
}
})
play
播放幻灯片。
- 参数
名称 | 类型 | 默认值 | 描述 | 必选/可选 |
---|---|---|---|---|
id | string or number | - | slide 的 id 或者 player 中 slideList 对应的 index | 可选 |
fileData | string | 原 editor 中的 fileDelta | 特定版本的file数据,可被初始化为 Delta | 可选 |
options | object | 见下 | 播放参数选项,包括是否受控和播放模式 | 可选 |
options.controllable | boolean | true | 是否受控 | 可选 |
options.mode | Editor.PlayMode | PlayMode.FULLSCREEN | 播放模式 | 可选 |
options.container | HTMLElement | document.body | 播放区域可以选定mount到特定的节点上 | 可选 |
- 返回值 void
- 用法
play(id?, fileData?, { controllable: true, mode: Editor.PlayMode.FULLSCREEN, container: someDIVContainer }?)
stop
退出播放幻灯片。
- 参数
- 返回值 void
- 用法
stop()
next
播放下一张幻灯片。
- 参数:无
- 返回值 void
- 用法
next()
prev
播放上一张幻灯片。
- 参数
- 返回值 void
- 用法
prev()
jumpTo
跳转至特定幻灯片,以开始播放时的幻灯片顺序为准,跳转过程中无动画切换效
名称 | 类型 | 默认值 | 描述 | 必选/可选 |
---|---|---|---|---|
id | string or number | - | slide的id或者player中slideList对应的index | 必选 |
withAnimation | boolean | false | 是否有过渡效果 | 可选 |
- 参数
id
- 返回值
void
- 用法
jumpTo(id)
isPlaying
获取当前是否在播放状态。
- 参数:无
- 返回值
boolean
- 用法
isPlaying()
isFullScreen
获取当前是否为全屏状态。
- 参数:无
- 返回值
boolean
- 用法
isFullScreen()
destroy
销毁播放器实例。
- 参数:无
- 返回值
void
- 用法
destroy()
setFinishPage
配置播放结束提示内容。
- 参数
名称 | 类型 | 默认值 | 描述 | 必选/可选 |
---|---|---|---|---|
message | string | - | 提示内容 | 可选 |