Create Live Player Context

<!-- ## uni.createLivePlayerContext() @createliveplayercontext -->

::: sourceCode

uni.createLivePlayerContext(livePlayerId, component?) @createliveplayercontext

:::

创建并返回 live-player 组件上下文 LivePlayerContext 对象

参考文档： live-player组件文档

createLivePlayerContext 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	4.81	4.81	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
livePlayerId	string	是	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x
component	ComponentPublicInstance	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x

返回值

类型	描述	必备
LivePlayerContext	live-player 组件上下文对象	否

LivePlayerContext 的方法 @liveplayercontext-values

play(options?: LivePlayerOptions) : void @play

play 播放

play 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

options 的属性描述

名称	类型	必备	默认值	兼容性	描述
success	(res: UTSJSONObject) => void	否	-	Web: x; 微信小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x	接口调用成功的回调函数
fail	(res: UTSJSONObject) => void	否	-	Web: x; 微信小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x	接口调用失败的回调函数
complete	(res: any) => void	否	-	Web: x; 微信小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x	接口调用结束的回调函数（调用成功、失败都会执行）

pause(options?: LivePlayerOptions) : void @pause

pause 暂停

pause 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

stop(options?: LivePlayerOptions) : void @stop

stop 停止

stop 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

resume(options?: LivePlayerOptions) : void @resume

resume 恢复

resume 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

mute(options?: LivePlayerOptions): void @mute

mute 静音

mute 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

requestFullScreen(options?: LivePlayerOptions): void @requestfullscreen

requestFullScreen 全屏

requestFullScreen 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

exitFullScreen(options?: LivePlayerOptions): void @exitfullscreen

exitFullScreen 退出全屏

exitFullScreen 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
x	x	4.81	4.81	x

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePlayerOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	方法调用参数

<!-- UTSAPIJSON.createLivePlayerContext.example -->

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

示例代码另见live-player组件文档

<!-- UTSAPIJSON.createLivePlayerContext.example -->

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -	错误信息