Create Live Pusher Context

<!-- ## uni.createLivePusherContext() @createlivepushercontext -->

::: sourceCode

uni.createLivePusherContext(livePusherId, component?) @createlivepushercontext

:::

创建并返回 live-pusher 组件上下文 LivePusherContext 对象

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

createLivePusherContext 兼容性

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>

参数

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

返回值

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

LivePusherContext 的方法 @livepushercontext-values

start(options? : LivePusherOptions) : void @start

start 开始推流

start 兼容性

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

参数

名称	类型	必填	默认值	兼容性	描述
options	LivePusherOptions	否	-	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	接口调用结束的回调函数（调用成功、失败都会执行）

stop(options? : LivePusherOptions) : void @stop

stop 停止推流

stop 兼容性

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

参数

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

switchCamera(options? : LivePusherOptions) : void @switchcamera

switchCamera 切换前后摄像头

switchCamera 兼容性

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

参数

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

toggleTorch(options? : LivePusherOptions) : void @toggletorch

toggleTorch 开关闪光灯

toggleTorch 兼容性

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

参数

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

pause(options? : LivePusherOptions) : void @pause

pause 暂停推流

pause 兼容性

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

参数

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

resume(options? : LivePusherOptions) : void @resume

resume 恢复推流

resume 兼容性

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

参数

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

getMaxZoom(options? : LivePusherOptions) : void @getmaxzoom

getMaxZoom 获取最大缩放值

getMaxZoom 兼容性

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

参数

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

setZoom(zoom : number, options? : LivePusherOptions) : void @setzoom

setZoom 设置缩放

setZoom 兼容性

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

参数

名称	类型	必填	默认值	兼容性	描述
zoom	number	是	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x
options	LivePusherOptions	否	-	Web: x; 微信小程序: x; Android: -; iOS: -; HarmonyOS: x	-

startPreview(options? : LivePusherOptions) : void @startpreview

startPreview 开启摄像头预览

startPreview 兼容性

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

参数

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

stopPreview(options? : LivePusherOptions) : void @stoppreview

stopPreview 关闭摄像头预览

stopPreview 兼容性

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

参数

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

snapshot(options? : LivePusherOptions) : void @snapshot

snapshot 快照

snapshot 兼容性

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

参数

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

sendMessage(message : string, options? : LivePusherOptions) : void @sendmessage

sendMessage

sendMessage 兼容性

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

参数

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

<!-- UTSAPIJSON.createLivePusherContext.example -->

参见

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

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

<!-- UTSAPIJSON.createLivePusherContext.example -->

通用类型

GeneralCallbackResult

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