【小程序】媒体API能力集成指南——实时视频API

createIpcContext

ty.createIpcPlayerContext(string deviceId)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

创建 ipc-player 上下文 IpcContext 对象。

参数

string deviceId

ipc-player 组件的 device-id

返回值

IpcContext

IpcContext

IpcContext 实例，可通过 ty.createIpcPlayerContext 获取。

IpcContext 通过 device-id 跟一个 ipc-player 组件绑定，操作对应的 ipc-player 组件。

方法

connect

IpcContext.connect

IpcContext.connect(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

建立通道连接。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

disconnect

IpcContext.disconnect

IpcContext.disconnect(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

取消通道连接。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

👉 立即开发。

startPreview

IpcContext.startPreview

IpcContext.startPreview(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

开始预览。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

stopPreview

IpcContext.stopPreview

IpcContext.stopPreview(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

结束预览。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

snapshot

IpcContext.snapshot

IpcContext.snapshot(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

截取实时视频的影像图片存储到手机上（必须在 startPreview 之后才可被调用）。

参数

Object Object

属性	类型	默认值	必填	说明
saveToAlbum	number	0	否	0:保存到系统相册，1：保存到 ipc 相册
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
tempImagePath	string	图片文件的临时路径 (本地路径)
width	number	图片的宽度
height	number	图片的高度

setMuted

IpcContext.setMuted

IpcContext.setMuted(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

是否静音。

参数

Object Object

属性	类型	默认值	必填	说明
mute	boolean		否	true: 开启，false：关闭
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

setSoundMode

IpcContext.setSoundMode

IpcContext.setSoundMode(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

设置声音输出方式。

参数

Object Object

属性	类型	默认值	必填	说明
mode	string		否	speaker：扬声器播放，ear：听筒播放
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

setClarity

IpcContext.setClarity

IpcContext.setClarity(Object object)

基础库 2.2.0 开始支持, 低版本需做兼容处理。

设置视频清晰度(只针对实时预览)。

参数

Object Object

属性	类型	默认值	必填	说明
clarity	string		否	normal：标清，hd：高清
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

👉 立即开发。

startTalk

IpcContext.startTalk

IpcContext.startTalk(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

开启通话。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

stopTalk

IpcContext.stopTalk

IpcContext.stopTalk(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

结束通话。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

isTalkBacking

IpcContext.isTalkBacking

IpcContext.isTalkBacking(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

是否对讲中。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数, 返回值 true: 对讲中, false: 未开启
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

startRecord

IpcContext.startRecord

IpcContext.startRecord(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

开启通话。

参数

Object Object

属性	类型	默认值	必填	说明
saveToAlbum	number	0	否	0:保存到系统相册，1：保存到 ipc 相册
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

stopRecord

IpcContext.stopRecord

IpcContext.stopRecord(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

结束通话。

参数

Object Object

属性	类型	默认值	必填	说明
saveToAlbum	number	0	否	0:保存到系统相册，1：保存到 ipc 相册
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

isRecording

IpcContext.isRecording

IpcContext.isRecording(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

是否录制中。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数, 返回值 true: 录制中, false: 未开启
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

setAvailableRockerDirections

IpcContext.setAvailableRockerDirections

IpcContext.setAvailableRockerDirections(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

摇杆震动反馈和方向按键。

参数

Object Object

属性	类型	默认值	必填	说明
left	boolean		否	左震动
right	boolean		否	右震动
top	boolean		否	上震动
bottom	boolean		否	下震动
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

setTrackingStatus

IpcContext.setTrackingStatus

IpcContext.setTrackingStatus(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

设置是否开启特写追踪。

参数

Object Object

属性	类型	默认值	必填	说明
status	boolean		否	是否开启特写追踪
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

getVideoInfo

IpcContext.getVideoInfo

IpcContext.getVideoInfo(Object object)

基础库 2.6.0 开始支持, 低版本需做兼容处理。

获取视频的相关信息, 如帧数、码率、宽高等。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数, 返回值中 kbps: 码率, width:宽度, height:高度
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

isMuted

IpcContext.isMuted

IpcContext.isMuted(Object object)

基础库 2.6.1 开始支持, 低版本需做兼容处理。

获取当前是否静音。

参数

Object Object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
isMuted	boolean	true: 静音, false: 未静音

👉 立即开发。