txLiveSmartPlus
模块接口
setLicence
设置授权
setLicence({params}, callback(ret, err))
params
licenceUrl：
- 类型：字符串
- 描述：（必填项）从腾讯云平台获取的LicenseUrl。参考腾讯官方申请说明
licenseKey：
- 类型：字符串
- 描述：（必填项）从腾讯云平台获取的Key。参考腾讯官方申请说明
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -2,
msg: "",
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.setLicence({
licenceUrl : 'http://license.vod2.myqcloud.com/license/v1/TXUgcSDK.licence',
licenseKey : '0a8ee791929052b2dce775c308e'
},function(ret, err){
alert(JSON.stringify(ret) +" "+ JSON.stringify(err));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
initPusher
初始化推流对象
initPusher({params})
params
liveMode：
- 类型：数字型
- 描述：（必填项）推流协议类型(0:RTC 1:RTMP).
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.initPusher();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
unInitPusher
释放推流对象
unInitPusher()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.unInitPusher();
可用性
iOS、Android系统
可提供的1.0.0及更高版本
addEventListener
添加推流事件监听
addEventListener(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
evenType : '',//onError 直播推流器错误通知，推流器出现错误时
//onWarning 直播推流器警告通知
//onCaptureFirstAudioFrame 首帧音频采集完成的回调通知
//onCaptureFirstVideoFrame 首帧视频采集完成的回调通知
//onMicrophoneVolumeUpdate 麦克风采集音量值回调
//onPushStatusUpdate 推流器连接状态回调通知
//onStatisticsUpdate 直播推流器统计数据回调
//onSnapshotComplete 截图回调
//onSetMixTranscodingConfig 混流事件回调
code : '',
msg : '',
extraInfo : {},
volume : '',
imagePath : '',
status : '',
appCpu : '',
audioBitrate : '',
fps : '',
height : '',
systemCpu : '',
videoBitrate : '',
width : '',
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.addEventListener(function(ret, err){
alert(JSON.stringify(ret)+" "+JSON.stringify(err));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
removeEventListener
移除推流事件监听
removeEventListener()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.removeEventListener();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
openPushView
打开推流预览视图
openPushView({params}, callback(ret, err))
params
rect：
- 类型：JSON 对象
- 描述：（必填项）模块的位置及尺寸
- 备注：iOS,Android 必须传此参数。
- 内部字段：
{
x: 0, //（必填项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（必填项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（必填项）数字类型；模块的宽度；默认值：所属的 Window 或 Frame 的宽度
h: 250 //（必填项）数字类型；模块的高度；默认值：250
}
fixedOn：
- 类型：字符串
- 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window
fixed：
- 类型：布尔
- 描述：（可选项）模块是否随所属 Window 或 Frame 滚动
- 默认值：true（不随之滚动）
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.openPushView({
rect: {
x: 0,
y: 0,
w: api.frameWidth,
h: api.frameHeight / 3
},
fixedOn: api.frameName,
fixed: true,
},function(ret, err){
alert(JSON.stringify(ret)+" "+JSON.stringify(err));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
hidePushView
隐藏推流相机视图
hidePushView(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.hidePushView(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
showPushView
显示推流相机视图
showPushView(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.showPushView(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
closePushView
关闭推流预览视图
closePushView(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.closePushView(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startCamera
打开本地摄像头
startCamera({params})
params
frontCamera：
- 类型：布尔型
- 描述：（可选项）是否为前置摄像头(true: 切换到前置摄像头 false: 切换到后置摄像头)
- 默认值：true
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : '',
msg : ''
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.startCamera();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopCamera
关闭本地摄像头
stopCamera()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : '',
msg : ''
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopCamera();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setEncoderMirror
观众端的镜像效果
setEncoderMirror({params})
params
enable：
- 类型：布尔型
- 描述：（可选项）是否镜像 (true:播放端看到的是镜像画面 false:播放端看到的是非镜像画面)
- 默认值：true
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : '',
msg : ''
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setEncoderMirror();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startMicrophone
打开麦克风
startMicrophone()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : '',
msg : '',
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.startMicrophone();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopMicrophone
关闭麦克风
stopMicrophone()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopMicrophone();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startPush
开始音视频数据推流
startPush({params})
params
pushUrl：
- 类型：字符串型
- 描述：（必填项）推流的目标地址，支持任意推流服务端。
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.startPush({
pushUrl : 'trtc://cloud.tencent.com/push/streamid?sdkappid=1400188888&userId=A&usersig=xxxxx'
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopPush
停止音视频数据推流
stopPush()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopPush();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startScreenCapture
开启屏幕采集
startScreenCapture()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.startScreenCapture();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopScreenCapture
关闭屏幕采集
stopScreenCapture()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopScreenCapture();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
snapShotPush
截取推流过程中的本地画面
snapShotPush()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.snapShotPush();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
isPushing
当前推流器是否正在推流中
isPushing()
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
isPushing : '',
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.isPushing();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
showPushDebugView
显示仪表盘
showPushDebugView({params})
params
isShow：
- 类型：布尔型
- 描述：（可选项）指定是否显示仪表盘
- 默认值：false
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.showPushDebugView();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setRenderMirror
设置本地摄像头预览镜像。
setRenderMirror({params})
params
mirrorType：
- 类型：数字型
- 描述：（可选项）摄像头镜像类型(0:默认镜像类型. 在这种情况下，前置摄像头的画面是镜像的，后置摄像头的画面不是镜像的 1:前置摄像头 和 后置摄像头，都切换为镜像模式 2:前置摄像头 和 后置摄像头，都切换为非镜像模式)。
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setRenderMirror({
mirrorType : 0,
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setVideoQuality
设置推流视频分辨率，以及宽高比模式（横屏 / 竖屏）。
setVideoQuality({params})
params
resolution：
- 类型：数字型
- 描述：（必填项）视频分辨率(0:160x160 1:270x270 2:480x480 3:320x240 4:480x360 5:640x480 6:320x180 7:480x270 8:640x360 9:960x540 10:1280x720 11:1920x1080)。
- 默认值：9
resolutionMode：
- 类型：数字型
- 描述：（可选项）视频宽高比模式(0:竖屏 1:横屏)。
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setVideoQuality();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setPushRenderRotation
设置本地摄像头预览画面的旋转角度
setPushRenderRotation({params})
params
rotation：
- 类型：数字型
- 描述：（必填项）预览画面的旋转角度（0 90 180 270）
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setPushRenderRotation();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setAudioQuality
设置推流音频质量
setAudioQuality({params})
params
quality：
- 类型：数字型
- 描述：（必填项）音频质量（0:通用 1:语音 2:音乐）
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setAudioQuality();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
switchCamera
切换摄像头
switchCamera({params})
params
frontCamera：
- 类型：布尔型
- 描述：（必填项）是否前置摄像头 ( true：前置；false：后置)
- 默认值：true
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.switchCamera({
frontCamera : true
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
enableCameraTorch
开关闪光灯
enableCameraTorch({params})
params
enable：
- 类型：布尔型
- 描述：（必填项）是否开关闪光灯 ( true：开启；false：关闭)
- 默认值：true
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.enableCameraTorch({
enable : true
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setCameraZoomRatio
设置当前摄像头的缩放比例
setCameraZoomRatio({params})
params
zoomRatio：
- 类型：数字型
- 描述：（必填项）取值范围1 - 5，取值为1表示最远视角（正常镜头），取值为5表示最近视角（放大镜头）。
- 最大值推荐为5，若超过5，视频数据会变得模糊不清。默认值为1。
- 默认值：1
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setCameraZoomRatio({
zoomRatio : 5
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setCameraFocusPosition
设置摄像头焦点
setCameraFocusPosition({params})
params
x：
- 类型：浮点型
- 描述：（必填项）焦点坐标x
- 默认值：0
y：
- 类型：浮点型
- 描述：（必填项）焦点坐标y
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setCameraFocusPosition({
x : 0,
y : 0
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setBeautyStyle
设置美颜（磨皮）算法
setBeautyStyle({params})
params
style：
- 类型：数字型
- 描述：（必填项）美颜风格，光滑或者自然，光滑风格磨皮更加明显，适合娱乐场景。(0：光滑 1：自然 2：朦胧)。
- 默认值：0(光滑)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setBeautyStyle({
style : 0,
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setBeautyLevel
设置美颜级别
setBeautyLevel({params})
params
beautyLevel：
- 类型：浮点型
- 描述：（可选项）美颜级别，取值范围0 - 9； 0表示关闭，1 - 9值越大，效果越明显。
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setBeautyLevel({
beautyLevel : 0,
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setWhitenessLevel
设置美白级别
setWhitenessLevel({params})
params
whiteningLevel：
- 类型：浮点型
- 描述：（可选项）美白级别，取值范围 0 - 9； 0 表示关闭， 1 - 9值越大，效果越明显。
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setWhitenessLevel({
whiteningLevel : 0,
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setRuddyLevel
设置红润级别
setRuddyLevel({params})
params
ruddyLevel：
- 类型：浮点型
- 描述：（可选项）红润级别，取值范围 0 - 9； 0 表示关闭， 1 - 9值越大，效果越明显。
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setRuddyLevel({
ruddyLevel : 0,
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setFilter
色彩滤镜效果
setFilter({params})
params
filterIndex：
- 类型：数字型
- 描述：（必填项）滤镜类型(0:无 1:标准 2:樱红 3:云裳 4:纯真 5:白兰 6:元气 7:超脱 8:香氛 9:美白 10:浪漫 11:清新 12:唯美 13:粉嫩 14:怀旧 15:蓝调 16:清凉 17:日系)
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setFilter({
filterIndex : 1
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setFilterStrength
设置滤镜浓度
setFilterStrength({params})
params
strength：
- 类型：浮点型
- 描述：（可选项）从0到1，越大滤镜效果越明显，默认值为0.5。。
- 默认值：0.5
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setFilterStrength({
strength : 0.6
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
enableVoiceEarMonitor
开启耳返
enableVoiceEarMonitor({params})
params
enable：
- 类型：布尔型
- 描述：（可选项）仅在戴耳机时有效，暂时仅支持部分采集延迟较低的机型(true：开启；false：关闭)。
- 默认值：false
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.enableVoiceEarMonitor();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setVoiceEarMonitorVolume
设置耳返音量
setVoiceEarMonitorVolume({params})
params
volume：
- 类型：数字型
- 描述：（可选项）volume 音量大小，100为原始音量，范围是：[0 ~ 150]，默认值为100。
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setVoiceEarMonitorVolume({
volume : 100
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setVoiceReverbType
设置人声的混响效果（KTV、小房间、大会堂、低沉、洪亮...）
setVoiceReverbType({params})
params
reverbType：
- 类型：浮点型
- 描述：（可选项）设置混响效果 (0:关闭混响 1:KTV 2:小房间 3:大会堂 4:低沉 5:洪亮 6: 金属声 7:磁性)
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setVoiceReverbType({
reverbType : 2
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setVoiceChangerType
设置人声的变声特效（萝莉、大叔、重金属、外国人...）
setVoiceChangerType({params})
params
voiceType：
- 类型：浮点型
- 描述：（可选项）设置变声类型 (0:关闭变声 1:熊孩子 2:萝莉 3: 大叔 4:重金属 5:感冒 6:外国人 7:困兽 8:死肥仔 9:强电流 10:重机械 11:空灵)
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setVoiceChangerType({
voiceType : 7
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setVoiceVolume
设置麦克风采集人声的音量
setVoiceVolume({params})
params
volume：
- 类型：数字型
- 描述：（可选项）volume 音量大小，100为原始音量，范围是：[0 ~ 150]，默认值为100
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setVoiceVolume({
volume : 100
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startPlayMusic
开始播放背景音乐
startPlayMusic({params},callback(ret, err))
params
path：
- 类型：字符串型
- 描述：（必填项）音频路径（支持fs://路径等）
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
evenType : 'onStart'//开始播放 onStart
//播放完成 onComplete
//播放进度 onProgress
bgmId : '',
errCode ; '',
progressMs : '',
durationMs : ''
}
err：
- 类型：JSON 对象
- 内部字段：
{
code : -1,
msg : ''
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.startPlayMusic({
path : 'fs://123.mp3'
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopPlayMusic
停止播放背景音乐
stopPlayMusic({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopPlayMusic({
bgmId : 12330
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
pausePlayMusic
暂停播放背景音乐
pausePlayMusic({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.pausePlayMusic({
bgmId : '',
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
resumePlayMusic
继续播放背景音乐
resumePlayMusic({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.resumePlayMusic({
bgmId : '',
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setMusicPublishVolume
设置背景音乐的远端音量大小，即主播可以通过此接口设置远端观众能听到的背景音乐的音量大小。
setMusicPublishVolume({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
volume：
- 类型：数字型
- 描述：（可选项）volume 音量大小，100为原始音量，范围是：[0 ~ 150]
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setMusicPublishVolume({
bgmId : '',
volume : '',
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setMusicPlayoutVolume
设置背景音乐的本地音量大小，即主播可以通过此接口设置主播自己本地的背景音乐的音量大小。
setMusicPlayoutVolume({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
volume：
- 类型：数字型
- 描述：（可选项）volume 音量大小，100为原始音量，范围是：[0 ~ 150]
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setMusicPlayoutVolume({
bgmId : '',
volume : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setMusicPitch
调整背景音乐的音调高低
setMusicPitch({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
pitch：
- 类型：浮点型
- 描述：（可选项）pitch 音调，默认值是0.0f，范围是：[-1 ~ 1] 之间的浮点数
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setMusicPitch({
bgmId : '',
pitch : '',
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setMusicSpeedRate
调整背景音乐的变速效果
setMusicSpeedRate({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
speedRate：
- 类型：浮点型
- 描述：（可选项）speedRate 速度，默认值是1.0f，范围是：[0.5 ~ 2] 之间的浮点数；
- 默认值：1.0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setMusicSpeedRate();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
getMusicCurrentPosInMS
获取背景音乐当前的播放进度（单位：毫秒）
getMusicCurrentPosInMS({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.getMusicCurrentPosInMS({
bgmId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
seekMusicToPosInMS
设置背景音乐的播放进度（单位：毫秒）
seekMusicToPosInMS({params})
params
bgmId：
- 类型：数字型
- 描述：（必填项）音乐ID
process：
- 类型：数字型
- 描述：（必填项）需要设置的进度值
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.seekMusicToPosInMS({
bgmId : '',
process : 0
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setAllMusicVolume
设置全局背景音乐的本地和远端音量的大小
setAllMusicVolume({params})
params
volume：
- 类型：数字型
- 描述：（可选项）音量大小，100为原始音量，范围是：[0 ~ 150]
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setAllMusicVolume({
volume : 100
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
getMusicDurationInMS
获取景音乐文件的总时长（单位：毫秒）
getMusicDurationInMS({params})
params
path：
- 类型：字符串型
- 描述：（必填项）音频路径（支持fs://路径等）
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.getMusicDurationInMS({
......
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
openPlayerView
播放远端画面
openPlayerView({params},callback(ret, err))
params
rect：
- 类型：JSON 对象
- 描述：（必填项）模块的位置及尺寸
- 备注：iOS,Android 必须传此参数。
- 内部字段：
{
x: 0, //（必填项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（必填项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（必填项）数字类型；模块的宽度；默认值：所属的 Window 或 Frame 的宽度
h: 250 //（必填项）数字类型；模块的高度；默认值：250
}
fixedOn：
- 类型：字符串
- 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window
fixed：
- 类型：布尔
- 描述：（可选项）模块是否随所属 Window 或 Frame 滚动
- 默认值：true（不随之滚动）
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
evenType : 'onShow',//onShow
//onError 播放器错误通知
//onWarning 播放器警告通知
//onVideoPlayStatusUpdate 播放器视频状态变化通知。
//onAudioPlayStatusUpdate 播放器音频状态变化通知。
//onPlayoutVolumeUpdate 播放器音量大小回调
//onStatisticsUpdate 播放器统计数据回调。
//onSnapshotComplete 截图回调
//onReceiveSeiMessage 接收消息回调
code : '',
msg : '',
extraInfo : '',
volume : '',
status : '',
imagePath : '',
reason : '',
volume : '',
appCpu : '',
audioBitrate : '',
fps : '',
height : '',
systemCpu : '',
videoBitrate : '',
width : '',
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.openPlayerView({
rect:
{
x: 0,
y: 300,
w: 320,
h: 250
},
fixedOn: api.frameName,
playerId : 'playerId',
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
hidePlayerView
隐藏远端画面播放
hidePlayerView({params},callback(ret, err))
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.hidePlayerView({
playerId : ''
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
showPlayerView
显示远端画面播放
showPlayerView({params},callback(ret, err))
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.showPlayerView({
playerId : ''
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
closePlayerView
停止远端画面播放
closePlayerView({params},callback(ret, err))
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.closePlayerView({
playerId : ''
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
startPlay
开始播放
startPlay({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
playUrl：
- 类型：字符串型
- 描述：（必填项）音视频流的播放地址，支持 RTMP, HTTP-FLV, TRTC。
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.startPlay({
playerId : '',
playUrl : 'trtc://cloud.tencent.com/play/streamid?sdkappid=1400188888&userId=A&usersig=xxx'
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
stopPlay
停止播放
stopPlay({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.stopPlay({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
pauseVideo
暂停播放器的视频流
pauseVideo({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.pauseVideo({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
resumeVideo
恢复播放器的视频流
resumeVideo({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.resumeVideo({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
pauseAudio
暂停播放器的音频流
pauseAudio({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.pauseAudio({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
resumeAudio
恢复播放器的音频流
resumeAudio({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.resumeAudio({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
isPlaying
播放器是否正在播放中
isPlaying({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
isPlaying : '',
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.isPlaying({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setPlayerRenderRotation
设置播放器画面的旋转角度
setPlayerRenderRotation({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
rotation：
- 类型：数字型
- 描述：（必填项）预览画面的旋转角度（0 90 180 270）
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setPlayerRenderRotation({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setRenderFillMode
设置画面的填充模式
setRenderFillMode({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
fillMode：
- 类型：数字型
- 描述：（必填项）画面填充模式（0:图像适应屏幕，保持画面完整，但如果图像宽高比不同于屏幕宽高比，会有黑边的存在 1:图像铺满屏幕，不留黑边，如果图像宽高比不同于屏幕宽高比，部分画面内容会被裁剪掉）
- 默认值：0
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setRenderFillMode({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setPlayoutVolume
设置播放器音量
setPlayoutVolume({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
volume：
- 类型：数字型
- 描述：（必填项）volume 音量大小，取值范围0 - 100。
- 默认值：100
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setPlayoutVolume({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
enableVolumeEvaluation
启用播放音量大小提示。
enableVolumeEvaluation({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
intervalMs：
- 类型：数字型
- 描述：（必填项）intervalMs 决定了音量大小回调的触发间隔，单位为 ms，最小间隔为 100ms，如果小于等于0则会关闭回调，建议设置为 300ms。
- 默认值：0(不开启)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.enableVolumeEvaluation({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
snapShotPlayer
截取播放过程中的视频画面。
snapShotPlayer({params})
params
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.snapShotPlayer({
playerId : ''
});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
showPlayerDebugView
是否显示播放器状态信息的调试浮层。
showPlayerDebugView({params})
params
isShow：
- 类型：布尔型
- 描述：（可选项）是否显示
- 默认值：false
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.showPlayerDebugView();
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setMixTranscodingConfig
设置混流参数配置
setMixTranscodingConfig({params})
params
codingConfig：
- 类型：JSON型
- 描述：（可选项）配置信息
- 内部字段：
{
videoWidth: 720,
videoHeight: 1280,
videoBitrate: 1500,
videoFramerate: 20,
videoGOP: 2,
audioSampleRate: 48000,
audioBitrate: 64,
audioChannels:2,
backgroundColor:0x000000,
backgroundImage:'',
outputStreamId:'',
}
mixStream：
- 类型：JSON型
- 描述：（可选项）主播流配置
- 内部字段：
{
userId : '',
x : 0,
y : 0,
width: 720,
height: 1280,
zOrder: 0,
}
remoteList：
- 类型：JSON型
- 描述：（可选项）混流信息
- 内部字段：
[{
userId : '',
streamId : '',
x : 0,
y : 0,
width: 180,
height: 240,
zOrder: 1,
}]
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.setMixTranscodingConfig({......});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
sendSeiMessage
推流端发送消息
sendSeiMessage({params})
params
payloadType：
- 类型：数字型
- 描述：（可选项）数据类型，支持 5、242。推荐填：242
- 默认值：242
message：
- 类型：字符串型
- 描述：（可选项）待发送的数据
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.sendSeiMessage({......});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
enableReceiveSeiMessage
用户端是否开启接收消息
enableReceiveSeiMessage({params})
params
payloadType：
- 类型：数字型
- 描述：（可选项）指定接收 SEI 消息的 payloadType，支持 5、242，请与发送端的 payloadType 保持一致。
- 默认值：242
enable：
- 类型：布尔型
- 描述：（可选项）YES: 开启接收 SEI 消息; NO: 关闭接收 SEI 消息
- 默认值：true
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var demo = api.require('txLiveSmartPlus');
var ret = demo.enableReceiveSeiMessage({......});
alert(JSON.stringify(ret));
可用性
iOS、Android系统
可提供的1.0.0及更高版本
openPushViewRect
重设推流预览视图大小
openPushViewRect({params}, callback(ret, err))
params
rect：
- 类型：JSON 对象
- 描述：（必填项）模块的位置及尺寸
- 备注：iOS,Android 必须传此参数。
- 内部字段：
{
x: 0, //（必填项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（必填项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（必填项）数字类型；模块的宽度；默认值：所属的 Window 或 Frame 的宽度
h: 250 //（必填项）数字类型；模块的高度；默认值：250
}
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.openPushViewRect({
rect: {
x: 0,
y: 0,
w: api.frameWidth,
h: api.frameHeight / 3
},
},function(ret, err){
alert(JSON.stringify(ret)+" "+JSON.stringify(err));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
openPlayerViewRect
重设播放远端画面大小
openPlayerViewRect({params},callback(ret, err))
params
rect：
- 类型：JSON 对象
- 描述：（必填项）模块的位置及尺寸
- 备注：iOS,Android 必须传此参数。
- 内部字段：
{
x: 0, //（必填项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（必填项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（必填项）数字类型；模块的宽度；默认值：所属的 Window 或 Frame 的宽度
h: 250 //（必填项）数字类型；模块的高度；默认值：250
}
playerId：
- 类型：字符串
- 描述：（可选项）播放器ID
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code : -1,
msg: ""
}
示例代码
var demo = api.require('txLiveSmartPlus');
demo.openPlayerViewRect({
rect:
{
x: 0,
y: 300,
w: 320,
h: 250
},
playerId : 'playerId',
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本