tencentLivePlayer
接口列表
初始化与监听
接口列表 | 功能 |
---|---|
init | 初始化 |
setPlayerListener | 设置播放监听器 |
removePlayerListener | 移除播放监听 |
destroy | 销毁播放器 |
基本控制
接口列表 | 功能 |
---|---|
start | 启动从指定URL播放音视频流 |
isPlaying | 获取当前播放状态 |
pause | 暂停播放 |
resume | 继续播放 |
stop | 停止播放音视频流 |
视频相关
接口列表 | 功能 |
---|---|
setRenderMode | 设置画面的裁剪模式 |
setRenderRotation | 设置画面的方向 |
setHwAcc | 开启硬件加速 |
switchStream | 清晰度切换 |
音频相关
接口列表 | 功能 |
---|---|
setMute | 设置是否静音 |
setVolume | 设置音量 |
setAudioRoute | 设置声音播放模式 |
setVolumeEvaluationListener | 设置音量大小评估监听 |
removeVolumeEvaluationListener | 移除音量大小评估监听 |
enableVolumeEvaluation | 启用音量大小评估 |
视频录制
接口列表 | 功能 |
---|---|
setRecordListener | 设置录制监听器 |
removeRecordListener | 移除录制监听 |
startRecord | 开始视频录制 |
stopRecord | 停止录制 |
snapshot | 播放器截图 |
直播时移
接口列表 | 功能 |
---|---|
prepareLiveSeek | 直播时移准备 |
seek | 直播时移跳转 |
resumeLive | 恢复直播服务 |
模块接口
init
初始化拉流播放器
init({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.init({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
setPlayerListener
设置播放监听
setPlayerListener(({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
代码示例
livePlayer.setPlayerListener({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
removePlayerListener
移除播放监听
removePlayerListener({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.removePlayerListener({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
destroy
销毁
destroy({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.destroy({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
start
启动从指定 URL 播放音视频流
start({params}, function(ret, err))
params
flvUrl:
- 类型: 字符串类型
- 描述: (必填项) 完整的url
rect:
- 类型: JSON对象
- 描述: (必填项) 视频显示区域的位置和大小
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.start({
rect: {
x: 0,
y: 0,
w: api.winWidth / 2,
h: api.winHeight / 2
},
flvUrl: flvUrl,
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
isPlaying
是否正在播放
isPlaying({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true, // 布尔类型, true表示操作成功
isPlaying: true
}
- 字段详情:
isPlaying:
- 类型: 布尔类型
- 描述: true表示拉流中, false表示没有拉流
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.isPlaying({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret))
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
pause
暂停播放
此接口会暂停数据拉流,不会销毁播放器,暂停后,播放器会显示最后一帧数据图像
pause({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.pause({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供1.0.0及更高版本
resume
继续播放
resume({}, function(ret, err))
callback(ret, err)
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.resume({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
stop
销毁播放器及其视图
stop({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.stop({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRenderRotation
设置画面的方向
setRenderRotation({params}, function(ret, err))
params
rotation:
- 类型: 整数类型
- 描述: (必填项) 方向
- 取值范围: [0 ~ 3]
- 0: HOME 键在右边,横屏模式
- 1: HOME 键在下面,手机直播中最常见的竖屏直播模式
- 2: HOME 键在左边,横屏模式
- 3: HOME 键在上边,竖屏直播(适合小米 MIX2)
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setRenderRotation({
rotation: 0
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRenderMode
设置画面的裁剪模式
setRenderMode({params}, function(ret, err))
params
mode:
- 类型: 整数类型
- 描述: (必填项)裁剪模式
- 取值范围: [0 ~ 1]
- 0: 图像铺满屏幕,不留黑边,如果图像宽高比不同于屏幕宽高比,部分画面内容会被裁剪掉
- 1: 图像适应屏幕,保持画面完整,但如果图像宽高比不同于屏幕宽高比,会有黑边的存在
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setRenderMode({
mode: 0
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
setHwAcc
是否开启硬件加速
setHwAcc({params}, function(ret))
params
enable:
- 类型: 布尔类型
- 描述: (必填项) true表示开启硬件加速, false表示禁用硬件加速
- 默认值: false
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setHwAcc({
enable: true
}, function(ret ,err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
switchStream
FLV 直播无缝切换
switchStream({params}, function(ret, err))
params
url:
- 类型: 字符串类型
- 描述: (必填项) 播放地址
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.switchStream({
url: http://xxxx/xxxx.flv
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setMute
设置静音
setMute({params}, function(ret, err))
params
isMute:
- 类型: 布尔类型
- 描述: (必填项) 是否静音
- 默认值: true
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setMute({
isMute: true
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setVolume
设置音量
setVolume({params}, function(ret, err))
params
volume:
- 类型: 整数类型
- 描述: (必填项) 音量大小
- 取值范围: [0 - 100]
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setVolume({
volume: 80
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setAudioRoute
设置声音播放模式(切换扬声器,听筒)
setAudioRoute({params}, function(ret, err))
params
mode:
- 类型: 整数类型
- 描述: (必填项) 声音播放模式
- 取值范围:
- 0: 扬声器,位于手机底部,声音偏大,适合外放音乐
- 1: 听筒,位于手机顶部,声音偏小,适合通话
callback(ret)
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setAudioRoute({
mode: 0
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setVolumeEvaluationListener
设置音量大小回调接口
setVolumeEvaluationListener({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
{
eventType: 'onAudioVolumeEvaluationNotify',
volume: 112
}
- 字段详情:
eventType:
- 类型: 字符串类型
- 描述: 事件名称
- 取值范围:
- onAudioVolumeEvaluationNotify: 音量回调
volume:
- 类型: 整数类型
- 描述: 音量大小
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setVolumeEvaluationListener({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
removeVolumeEvaluationListener
移除音量大小回调
removeVolumeEvaluationListener({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.removeVolumeEvaluationListener({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
enableVolumeEvaluation
启用音量大小提示
开启后会在 setVolumeEvaluationListener 中获取到 SDK 对音量大小值的评估。
enableVolumeEvaluation({params}, function(ret, err))
params
interval:
- 类型: 整数类型
- 描述: (必填项) 决定了回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.enableVolumeEvaluation({
interval: 300
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRecordListener
设置短视频录制回调
setRecordListener({params}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
{
eventType: 'onRecordProgress',
progress: 113
}
- 字段详情:
eventType:
- 类型: 字符串类型
- 描述: 事件名称
- 取值范围:
- onRecordEvent: 录制事件
- onRecordProgress: 录制进度
- onRecordComplete: 录制结束
progress:
- 类型: 整数类型
- 描述: 录制进度
result:
- 类型: JSON对象
- 描述: 录制结果
{
coverImage: 'xxxx',
videoPath: 'xxxx'
}
coverImage:
- 类型: 字符串类型
- 描述: 封面图片路径
videoPath:
- 类型: 字符串类型
- 描述: 录制的视频路径
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.setRecordListener({}, function(ret, err) {
if (ret) {
api.toast({
msg: JSON.stringify(ret),
location: 'bottom'
});
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
removeRecordListener
移除录制监听
removeRecordListener({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.removeRecordListener({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
startRecord
开始录制短视频
startRecord({params}, function(ret, err))
params
type:
- 类型: 整数类型
- 描述: (必填项) 录制类型
- 取值范围: 0
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.startRecord({
type: 0
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
stopRecord
结束录制短视频
stopRecord({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.stopRecord({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
snapshot
截屏
snapshot({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
path: '/livePlayer/snapshot/snapshot_xxx.png'
}
- 字段详情:
path:
- 类型: 字符串类型
- 描述: 生成截图的路径
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.snapshot({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
prepareLiveSeek
直播时移准备,拉取该直播流的起始播放时间。
使用时移功能需在播放开始后调用此方法,否则时移失败。
警告: 非腾讯云直播地址不能时移
prepareLiveSeek({params}, function(ret, err))
params
appId:
- 类型: 字符串类型
- 描述: (必填项) 应用Id
domain:
- 类型: 字符串类型
- 描述: (必填项) 时移域名
bizid:
- 类型: 整数类型
- 描述: (必填项) 流bizid
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.prepareLiveSeek({
appId: '32xxx212',
domain: 'xxxx',
bizid: 123
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
seek
播放跳转到音视频流某个时间
seek({params}, function(ret, err))
params
second:
- 类型: 整数类型
- 描述: (必填项) 流时间,单位为秒
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.seek({
second: 3
}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
resumeLive
停止时移播放,返回直播
resumeLive({}, function(ret, err))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true // 布尔类型, true表示操作成功
}
err:
- 类型: JSON对象
- 内部字段:
{
code: -911, // 整数类型, 错误码
msg: '错误描述' // 字符串类型, 错误信息
}
示例代码
livePlayer.resumeLive({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本