# Interface: Video
• Video()
# Properties
# autoplay
• autoplay: boolean
视频是否自动播放
Returns: boolean
# controls
• controls: boolean
视频是否显示控件
Returns: boolean
# enablePlayGesture
• enablePlayGesture: boolean
是否开启双击播放的手势
Returns: boolean
# enableProgressGesture
• enableProgressGesture: boolean
是否启用手势控制播放进度
Returns: boolean
# height
• height: number
视频的高度
Returns: number
# initialTime
• initialTime: number
视频的初始播放位置，单位为 s 秒
Returns: number
# live
• live: boolean
视频是否为直播
Returns: boolean
# loop
• loop: boolean
视频是否是否循环播放
Returns: boolean
# muted
• muted: boolean
视频是否禁音播放
Returns: boolean
# obeyMuteSwitch
• obeyMuteSwitch: boolean
视频是否遵从系统静音开关设置（仅iOS）
Returns: boolean
# objectFit
• objectFit: ObjectFit
视频的缩放模式
Returns: ObjectFit
# onended
• onended: Function
视频播放到末尾时触发的回调函数
Returns: Function
# onerror
• onerror: Function
视频发生错误时触发的回调函数
Returns: Function
# onpause
• onpause: Function
视频暂停时触发的回调函数
Returns: Function
# onplay
• onplay: Function
视频开始播放时触发的回调函数
Returns: Function
# onprogress
• onprogress: Function
视频下载（缓冲）时周期性触发的回调函数
Returns: Function
# ontimeupdate
• ontimeupdate: Function
每当视频播放进度更新时触发的回调函数
Returns: Function
# onwaiting
• onwaiting: Function
视频由于需要缓冲下一帧而停止时触发的回调函数
Returns: Function
# playbackRate
• playbackRate: PlaybackRate
视频的播放速率，有效值有 0.5、0.8、1.0、1.25、1.5
Returns: PlaybackRate
# poster
• poster: string
视频的封面
Returns: string
# showCenterPlayBtn
• showCenterPlayBtn: boolean
是否显示视频中央的播放按钮
Returns: boolean
# src
• src: string
视频的资源地址
Returns: string
# width
• width: number
视频的宽度
Returns: number
# x
• x: number
视频的左上角横坐标
Returns: number
# y
• y: number
视频的左上角纵坐标
Returns: number
# Methods
# destroy
▸ destroy(): void
销毁视频
# 返回值:
void
# exitFullScreen
▸ exitFullScreen(): Promise‹unknown›
视频退出全屏
# 返回值:
Promise‹unknown›
# offEnded
▸ offEnded(callback?: Function): void
取消监听视频播放到末尾事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# offError
▸ offError(callback?: OnVideoErrorCallback): void
取消监听视频错误事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | OnVideoErrorCallback |
# 返回值:
void
# offPause
▸ offPause(callback?: Function): void
取消监听视频暂停事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# offPlay
▸ offPlay(callback?: Function): void
取消监听视频播放事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# offProgress
▸ offProgress(callback?: OnProgressCallback): void
取消监听视频下载（缓冲）事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | OnProgressCallback |
# 返回值:
void
# offTimeUpdate
▸ offTimeUpdate(callback?: OnTimeUpdateCallback): void
取消监听视频播放进度更新事件
# 参数:
| 属性 | 类型 |
|---|---|
callback? | OnTimeUpdateCallback |
# 返回值:
void
# offWaiting
▸ offWaiting(callback?: Function): void
取消监听视频由于需要缓冲下一帧而停止时触发
# 参数:
| 属性 | 类型 |
|---|---|
callback? | Function |
# 返回值:
void
# onEnded
▸ onEnded(callback: Function): void
监听视频播放到末尾事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# onError
▸ onError(callback: OnVideoErrorCallback): void
监听视频错误事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnVideoErrorCallback |
# 返回值:
void
# onPause
▸ onPause(callback: Function): void
监听视频暂停事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# onPlay
▸ onPlay(callback: Function): void
监听视频播放事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# onProgress
▸ onProgress(callback: OnProgressCallback): void
监听视频下载（缓冲）事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnProgressCallback |
# 返回值:
void
# onTimeUpdate
▸ onTimeUpdate(callback: OnTimeUpdateCallback): void
监听视频播放进度更新事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnTimeUpdateCallback |
# 返回值:
void
# onWaiting
▸ onWaiting(callback: Function): void
监听视频由于需要缓冲下一帧而停止时触发
# 参数:
| 属性 | 类型 |
|---|---|
callback | Function |
# 返回值:
void
# pause
▸ pause(): Promise‹unknown›
暂停视频
# 返回值:
Promise‹unknown›
# play
▸ play(): Promise‹unknown›
播放视频
# 返回值:
Promise‹unknown›
# requestFullScreen
▸ requestFullScreen(): Promise‹unknown›
视频全屏
# 返回值:
Promise‹unknown›
# seek
▸ seek(time: number): Promise‹unknown›
视频跳转
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
time | number | 视频跳转到指定位置，单位为 s 秒 |
# 返回值:
Promise‹unknown›
# stop
▸ stop(): Promise‹unknown›
停止视频
# 返回值:
Promise‹unknown›