txLive

openPusher liveBtnsPerformClickById stopPush setPlayBtnsVisibility stopPlay hidePlayer resumePush

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

txLive 模块封装了腾讯云直播服务 可参考腾讯云直播集成方案

使用注意: 必须在config.xml里面配置

使用时请注意: 1.免费申请的license(基础版，有效期28天),体验测试， 2.当您的测试License过期了，您需要进入 点播控制台 点击购买正式License

使用此模块之前建议先配置 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：txLive
  • 参数：licenceURL、licenceKey
  • 配置示例:

  • 字段描述:

    licenceURL：（必须配置）从腾讯云平台获取的LicenseUrl。参考腾讯官方申请说明

    licenceKey：（必须配置）从腾讯云平台获取的Key。

openPusher

打开推流界面

openPusher({params});

x:

  • 类型：数字
  • 描述：（可选项）
  • 默认值：0

y:

  • 类型：数字
  • 描述：（可选项）
  • 默认值：0

w：

  • 类型：数字
  • 描述：（可选项）
  • 默认值：屏幕宽度

h：

  • 类型：数字
  • 描述：（可选项）
  • 默认值：屏幕高度

url：

  • 类型：字符串

autoPush:

  • 类型：布尔类型
  • 描述：是否自动推流

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：模块依附于当前 window

fixed：

  • 类型：布尔
  • 描述：（可选项）是否将模块视图固定到窗口上（不跟随窗口上下滚动）
  • 默认：true

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.openPusher({
  3.             x : 0,
  4.             y : 0,
  5.             h : height,
  6.             w : width,
  7.             url : "rtmp://xxxxx.livepush.myqcloud.com/xxxxxxx"
  8.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setLiveBtnsVisibility

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

setLiveBtnsVisibility({params})

params

btnid：

  • 类型：字符串
  • 描述：界面的可见按钮ID,

  • 取值范围：

    • btnPlay 播放,
    • btnCameraChange 摄像头切换
    • autofocus 自动对焦,(仅支持安卓)
    • btnHWEncode 硬件解码,
    • btnFaceBeauty 美颜,
    • btnLog 日志,
    • btnResolution 清晰度,
    • btnScreenOrientation 横竖屏切换
    • btnMirror 镜像(仅支持iOS)

show：

  • 类型：数字
  • 描述：按钮可见状态0为隐藏1为显示

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.setLiveBtnsVisibility({
  3.             "btnid" : "btnLog",
  4.             "show" : 1
  5.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

liveBtnsPerformClickById

liveBtnsPerformClickById({params})

params

btnid：

  • 类型：字符串
  • 描述：界面的可见按钮ID,

  • 取值范围：

    • btnPlay 播放
    • btnCameraChange 摄像头切换
    • btnHWEncode 硬件解码
    • btnFaceBeauty 美颜
    • btnLog 日志
    • btnResolution 清晰度,
    • btnScreenOrientation 横竖屏切换
    • btnMirror 镜像(仅支持iOS)
    • btnBitrate 码流 (iOS不支持)
    • btnFlash 闪光灯(iOS不支持)

示例代码

  1. var txLive = api.require('txLive');
  3.             "btnid" : "btnLog"
  4.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

startPush

开始推流

注意:目前只有iOS支持回调

startPush(callback(ret, err));

callback(ret)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     returnBack:0,   //数字；0: 启动成功；-1: 启动失败；-5：license 校验失败。
  3. }

示例代码

iOS系统，Android系统

可提供的1.0.0及更高版本

stopPush

结束视频推流

stopPush();

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.stopPush();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openPlayer

播放视频

openPlayer({params})

params

x：

  • 类型：数字
  • 描述：（可选项）
  • 默认值：0

y：

  • 类型：数字
  • 描述：（可选项）
  • 默认值：0

w：

  • 类型：数字
  • 默认值：屏幕宽度

h：

  • 类型：数字
  • 描述：（可选项）
  • 默认值：屏幕高度

url：

  • 类型：字符串
  • 描述：必填项，播放视频地址

type:

  • 类型：数字类型
  • 描述：播放类型（仅支持Android）
  • 默认：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

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.openPlayer({
  3.             x : 0,
  4.             y : 0,
  5.             url : "视频播放地址"
  6.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setPlayBtnsVisibility

设置播放界面按钮

params

btnid：

  • 类型：字符串
  • 描述：界面的可见按钮ID,
    • btnPlay 播放,
    • playbtnbox 整个播放控制栏,
    • play_progress 进度条（Android 不支持）,
    • btnHWDecode 硬件解码,
    • btnRenderMode 渲染方式,
    • btnLog 日志,
    • btnScreenOrientation 横竖屏切换
    • btnCacheStrategy 缓存设置，播放直播流时不可用

show：

  • 类型：数字
  • 描述：按钮可见状态0为隐藏1为显示

示例代码

  1. var txLive = api.require('txLive');
  3.             "btnid" : "btnLog",
  4.             "show" : 1
  5.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

startPlay

开始播放视频

startPlay()

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.startPlay();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

stopPlay

停止播放视频

stopPlay()

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

playBtnsPerformClickById

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

playBtnsPerformClickById({params})

params

btnid：

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

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.playBtnsPerformClickById({
  3.             "btnid" : "btnLog"
  4.         });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hidePlayer

隐藏视频

hidePlayer()

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.hidePlayer();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showPlayer

显示视频

showPlayer()

示例代码

  1. var txLive = api.require('txLive');
  2. txLive.showPlayer();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

resumePush

恢复推流

resumePush()

示例代码

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

可用性

iOS系统

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。