方法--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

方法

最近更新时间：2024.03.06 19:52:42首次发布时间：2024.03.06 19:52:42

播放器方法

类型： interface

openLog

调用此方法开启直播日志上报。

类型

() => void

closeLog

调用此方法关闭直播日志上报。

类型

() => void

switch

调用此方法切换拉流地址、线路、清晰度。

类型

(target: string | { definition?: string; source?: string;}) => void

参数

名称	类型	是否必选	默认值	说明
target	-	是	-	目标地址，可以是播放地址，也可以是线路和清晰度。
definition	string \| undefined	否	无	清晰度的唯一标识。
source	string \| undefined	否	无	线路的唯一标识。

play

调用此方法开始播放。

类型

() => void

pause

调用此方法暂停播放。

类型

() => void

stop

调用此方法停止播放。

类型

() => void

resume

调用此方法恢复播放。

类型

() => void

peerPlay

调用此方法进行预加载。

类型

() => void

replay

调用此方法重新播放。

类型

() => void

mute

调用此方法静音。

类型

() => void

unmute

调用此方法取消静音。

类型

() => void

requestFullscreen

调用此方法进入全屏播放。

类型

(option: Pick<WechatMiniprogram.LivePlayerContextRequestFullScreenOption, 'direction'>) => Promise<unknown>

参数

名称	类型	是否必选	默认值	说明
option	Pick<T, K>	是	无	传入 direction 控制旋转角度。

返回值

Promise<unknown>

exitFullscreen

调用此方法退出全屏。

类型

() => Promise<unknown>

返回值

Promise<unknown>

getContext

调用此方法获取 live-player 实例。

类型

() => WechatMiniprogram.LivePlayerContext

返回值

WechatMiniprogram.LivePlayerContext

参考

官方文档

once

调用此方法监听指定事件，事件处理函数只执行一次。

类型

(event: string, callback: (data?: any) => any) => void

参数

名称	类型	是否必选	默认值	说明
event	string	是	无	表示事件的名称。
callback	(data?: any) => any	是	无	表示事件的回调函数。

on

调用此方法监听指定事件。

类型

<Key extends keyof Events>(type: Key, handler: Mitt.MittHandler<Events[Key]>) => void

参数

名称	类型	是否必选	默认值	说明
type	Key	是	无	表示事件名称。
handler	Handler<T>	是	无	表示事件的回调函数。

off

调用此方法解绑或移除指定事件的事件监听。

类型

<Key extends keyof Events>(type: Key, handler?: Mitt.MittHandler<Events[Key]>) => void

参数

名称	类型	是否必选	默认值	说明
type	Key	是	无	表示事件名称。
handler	Mitt.MittHandler<Events[Key]> \| undefined	否	无	已使用 on 方法配置监听的事件的回调函数。

emit

调用此方法触发指定事件。

类型

<Key extends keyof Events>(type: Key, event: Events[Key]) => void

参数

名称	类型	是否必选	默认值	说明
type	Key	是	无	表示事件名称。
event	Events[Key]	是	无	事件参数。

offAll

调用此方法解绑或移除所有事件监听。

类型

() => void