api接口整理

目录

 

setLiveBtnsVisibility 3

liveBtnsPerformClickById 4

startPush 4

stopPush 5

openPlayer 6

setPlayBtnsVisibility 7

startPlay 7

stopPlay 8

playBtnsPerformClickById 8

hidePlayer 8

showPlayer 9

 

 

 

 

官方文档：https://docs.apicloud.com/Client-API/Open-SDK/txLive

实例项目：https://github.com/Xingtao/FFdynamic

参考后台管理项目：http://oubo1.ozhong.com/admin

方维互动直播系统全套源码+app源码（含android+ios）+全套配置文档

：http://www.pansoso.com/a/1341251/

官方sdk接口：https://docs.apicloud.com/Client-API/Open-SDK/txLive

 

 

https://download.youkuaiyun.com/download/yllaji/10719552

 

openPusher 

打开推送流 

openPusher({params});

参数	类型	描述	默认值
x	数字	（可选项）	0
y	数字	（可选项）	0
w	数字	（可选项）	屏幕宽度
h	数字	（可选项）	屏幕高度
url	字符串	必填项，推流的rtmp地址
fixedOn	字符串	（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）	模块依附于当前 window
fixed	布尔	（可选项）是否将模块视图固定到窗口上（不跟随窗口上下滚动）	true

示例代码

var txLive = api.require('txLive');

txLive.openPusher({

            x : 0,

            y : 0,

            h : height,

            w : width,

            url : "rtmp://xxxxx.livepush.myqcloud.com/xxxxxxx"

        });

setLiveBtnsVisibility

控制推流界面按钮可见状态

setLiveBtnsVisibility({params})

参数	类型	描述	取值范围：
btnid	字符串	界面的可见按钮ID,	btnPlay 播放, btnCameraChange 摄像头切换 autofocus 自动对焦,(仅支持安卓) btnHWEncode 硬件解码, btnFaceBeauty 美颜, btnLog 日志, btnResolution 清晰度, btnScreenOrientation 横竖屏切换 btnMirror 镜像(仅支持iOS)
show	数字	按钮可见状态0为隐藏1为显示

示例代码

var txLive = api.require('txLive');

txLive.setLiveBtnsVisibility({

            "btnid" : "btnLog",

            "show" : 1

        });

liveBtnsPerformClickById

通过按钮id来模拟点击按钮

liveBtnsPerformClickById({params})

参数	类型	描述	取值范围：
btnid	字符串	界面的可见按钮ID,	btnPlay 播放, btnCameraChange 摄像头切换 autofocus 自动对焦,(仅支持安卓) btnHWEncode 硬件解码, btnFaceBeauty 美颜, btnLog 日志, btnResolution 清晰度, btnScreenOrientation 横竖屏切换 btnMirror 镜像(仅支持iOS)

 

 

示例代码

var txLive = api.require('txLive');

txLive.liveBtnsPerformClickById({

            "btnid" : "btnLog"

 });

 

startPush

开始推流

startPush();

示例代码

var txLive = api.require('txLive');

txLive.startPush();

 

stopPush

结束视频推流

stopPush();

示例代码

var txLive = api.require('txLive');

txLive.stopPush();

 

 

 

 

openPlayer

播放视频

openPlayer({params})

参数	类型	描述	默认值
x	数字	（可选项）	0
y	数字	（可选项）	0
w	数字	（可选项）	屏幕宽度
h	数字	（可选项）	屏幕高度
url	字符串	必填项，播放视频地址
type	数字	1	0 => PLAY_TYPE_LIVE_FLV 1 => PLAY_TYPE_LIVE_RTMP 2 => PLAY_TYPE_LIVE_RTMP_ACC 3 => PLAY_TYPE_LOCAL_VIDEO 4 => PLAY_TYPE_VOD_FLV 5 => PLAY_TYPE_VOD_HLS 6 => PLAY_TYPE_VOD_MP4
fixedOn	字符串	（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）	模块依附于当前 window
fixed	布尔	（可选项）是否将模块视图固定到窗口上（不跟随窗口上下滚动）	true

示例代码

var txLive = api.require('txLive');

txLive.openPlayer({x : 0, y : 0,url : "视频播放地址"});

 

setPlayBtnsVisibility

设置播放界面按钮

setPlayBtnsVisibility();

参数	类型	描述	取值范围：
btnid	字符串	界面的可见按钮ID,	btnPlay 播放, playbtnbox 整个播放控制栏, play_progress 进度条（Android 不支持）, btnHWDecode 硬件解码, btnRenderMode 渲染方式, btnLog 日志, btnScreenOrientation 横竖屏切换 btnCacheStrategy 缓存设置，播放直播流时不可用
show	数字	按钮可见状态0为隐藏1为显示

示例代码

var txLive = api.require('txLive');

txLive.setPlayBtnsVisibility({"btnid" : "btnLog","show" : 1});

 

startPlay

开始播放视频

startPlay()

示例代码

var txLive = api.require('txLive');

txLive.startPlay();

 

stopPlay

停止播放视频

stopPlay()

示例代码

var txLive = api.require('txLive');

txLive.stopPlay();

 

playBtnsPerformClickById

通过按钮id来模拟点击按钮

playBtnsPerformClickById({params})

参数	类型	描述	取值范围：
btnid	字符串	界面的可见按钮ID,	btnPlay 播放, btnLog 日志, btnHWDecode 硬件解码, btnScreenOrientation 横竖屏切换, btnRenderMode ,填充适应切换 btnBitrate 码流,

示例代码

var txLive = api.require('txLive');

txLive.playBtnsPerformClickById({

            "btnid" : "btnLog"

        });

hidePlayer

隐藏视频

hidePlayer()

示例代码

var txLive = api.require('txLive');

txLive.hidePlayer();

 

 

 

showPlayer

显示视频

showPlayer()

示例代码

var txLive = api.require('txLive');

txLive.showPlayer();