HtLifeLiveSdk

功能

生活直播SDK接口类

介绍

• 主要负责生活直播相关功能的封装，除直播视频基础功能外，对外提供生活直播特有的交互功能接口
• 该接口类是一个单例

• 接口简介

  SDK基础方法

  API	描述
  getInstance	静态方法，获取HtLifeLiveSdk单例
  init	初始化
  isInited	判断sdk是否已初始化完成
  onPause	暂时播放
  onResume	开始或重新加载
  onStop	stop方法
  release	释放注销对象
  reload	刷新重新加载

  播放配置接口

  API	描述
  getCourseInfo	获取课程信息
  getInitLiveStatus	获取初始化直播状态
  getNetworkList	异步获取直播网络线路列表
  getRoomInfo	获取房间信息
  setVideoScaleMode	设置摄像头视频显示模式
  setVideoViewContainer	设置视频容器
  setWhiteboardViewContainer	设置白板容器
  setDesktopVideoContainer	设置视频分享/插播容器
  setWarmUpVideoContainer	设置暖场容器
  setNetwork	设置直播网络线路
  sendFlower	发送鲜花
  emit	发送消息
  off	注销监听指令
  on	指令监听

  生活直播配置接口

  API	描述
  getLifeConfig	获取生活直播配置信息
  setInvitationListPageSize	设置邀请榜单分页条数
  report	举报
  sendLike	发送点赞
  getFirstPageInvitationList	获取邀请榜单首页列表
  getNextPageInvitationList	获取邀请榜单下页列表
  getFilledQuestionnaire	获取已填写信息采集信息
  submitQuestionnaire	提交信息采集信息

  事件接口

  API	描述
  setLiveListener	设置直播事件监听
  setHtDispatchChatMessageListener	设置获取聊天信息事件监听
  setHtDispatchFlowerListener	设置鲜花信息事件监听
  setHtDispatchNoticeListener	设置获取公告事件监听
  setHtDispatchQuestionListener	设置问答信息事件监听
  setHtDispatchRollAnnounceListener	设置获取滚动通知事件监听
  setHtDispatchRoomMemberNumListener	设置观看人数事件监听
  setHtLotteryListener	设置抽奖事件监听
  setOnMemberJoinListener	调用房间成员用户进入直播监听
  setOnVideoChangeListener	设置视频切换事件监听
  setOnLikeListener	设置点赞监听

• 接口详细

  • emit

    发送消息

    public void emit(String cmd,JSONObject data,Callback callback)
    参数:
        `cmd` - 发送消息类型
        `data` - 发送消息内容
        `callback` - 发送回调

    • emit

    发送消息

    public void emit(String cmd,String msg, Callback callback)
    参数:
        `cmd` - 发送消息类型
        `msg` - 消息内容
        `callback` - 发送回调

    • getCourseInfo

      获取课程信息

    public CourseInfo getCourseInfo()

    • getFirstPageInvitationList

      获取邀请榜单首页列表

    public void getFirstPageInvitationList(Callback> callback)

  • getInitLiveStatus

    获取初始化直播状态

    public String getInitLiveStatus()

    • getInstance

      获取HtLifeLiveSdk实例

    public static HtLifeLiveSdk getInstance()

    • getLifeConfig

      获取生活直播配置信息

    public LifeConfig getLifeConfig()

  • getNetworkList

    异步获取直播网络线路列表

    public void getNetworkList(OnGetNetworkChoicesCallback callback
    参数:
        `callback` - 回调

    • getNextPageInvitationList

      获取邀请榜单下页列表

    public void getNextPageInvitationList(Callback<List<InvitationItem>> callback)

    • getFilledQuestionnaire

      获取已填写信息采集信息

    public void void getFilledQuestionnaire(Callback<Questionnaire> callback)

    • submitQuestionnaire

      提交信息采集信息

    public void void submitQuestionnaire(Map<String,String> map,Callback<Void> callback)

    • sendSMSVerificationCode

      发送短信验证码

    public void void sendSMSVerificationCode(String phone,Callback<String> callback)            

• getRoomInfo

  获取房间信息

   public com.talkfun.sdk.module.RoomInfo getRoomInfo()

  • init

    初始化

    public void init(Context context,InitParams params) 参数: context - 上下文 params - 初始化参数

  • isInited

    sdk是否已初始化完成

    public boolean isInited()

  • off

    注销注册所有事件监听

    public void off()

  • off

    注销监听指令

    public void off(java.lang.String cmd)

    参数:

    cmd - 指令

• off

  注销监听指令

  public void off(String cmd,Emitter.Listener listener)
      参数:
      `cmd` - 指令
      `listener` - 事件监听

  • on

    指令监听

    public void on(String cmd,Emitter.Listener listener) 参数: cmd - 指令 listener - 回调监听

  • onPause

    暂停播放 可对应Activity#onPause()方法或在合适的时机调用，执行暂停播放

   public void onPause()

  • onResume

    开始或重新加载

  • 调用该方法时去加载数据或重新加载数据

  • 如在Activity中调用，可对应Activity#onResume()方法

  • 否则在初始化完成后或在合适的时机调用

    public void onResume()

  • onStop

    对应Activity#onStop()方法，sdk暂无实现，暂停播放操作在onPause()方法

    public void onStop()

• release

  释放注销对象

   public void release()

  • reload

    刷新重新加载

     public void reload()

  • report

    举报

     public void report(String content,Callback callback)
     参数:
         `content` -　举报内容
         `callback` - 回调

  • sendFlower

    发送鲜花

     public void sendFlower()

  • sendLike

    发送点赞

     public void sendLike(int count,Callback<Integer> callback)
     参数:
         `count` - 点赞数
         `callback` - 回调

  • setHtDispatchChatMessageListener

    设置获取聊天信息事件监听

    public void setHtDispatchChatMessageListener(HtDispatchChatMessageListener listener) 参数: listener - 聊天信息监听回调

  • setHtDispatchFlowerListener

    设置鲜花信息事件监听

    public void setHtDispatchFlowerListener(HtDispatchFlowerListener listener) 参数: listener - 鲜花信息监听

  • setHtDispatchNoticeListener

    设置获取公告事件监听

    public void setHtDispatchNoticeListener(HtDispatchNoticeListener noticeListener) 参数: noticeListener -公告事件监听

  • setHtDispatchQuestionListener

    设置问答信息事件监听

    public void setHtDispatchQuestionListener(com.talkfun.sdk.event.HtDispatchQuestionListener questionListener) 参数: questionListener - 问答信息监听

  • setHtDispatchRollAnnounceListener

    设置获取滚动通知事件监听

    public void setHtDispatchRollAnnounceListener(HtDispatchRollAnnounceListener rollAnnounceListener) 参数: rollAnnounceListener - 滚动通知监听

  • setHtDispatchRollAnnounceListener

    设置观看人数事件监听

    public void setHtDispatchRoomMemberNumListener(com.talkfun.sdk.event.HtDispatchRoomMemberNumListener memberNumListener) 参数: memberNumListener - 观看人数事件监听

  • setHtLotteryListener

    设置抽奖事件监听

    public void setHtLotteryListener(HtLotteryListener listener) 参数: listener - 抽奖事件监听

  • setInvitationListPageSize

    设置邀请榜单分页条数

    public void setInvitationListPageSize(int size) 参数: size - 分页条数

• setLiveListener

  设置直播事件监听

   public void setLiveListener(LiveInListener listener)
       参数:
       `listener` - 直播事件监听

  • setNetwork

    设置直播网络线路

     public void setNetwork(int linePosition,NetItem item,OnSetNetworkCallback callback)
     参数:
         `linePosition` - 线路索引
         `item` - 线路子项
        `callback` - 回调

  • setOnLikeListener

    设置点赞监听

     public void setOnLikeListener(OnLikeListener listener)
     参数:
         `listener` -点赞监听

  • setOnMemberJoinListener

    调用房间成员用户进入直播监听

    public void setOnMemberJoinListener(OnMemberJoinListener listener) 参数: listener - 用户进入直播监听

  • setOnVideoChangeListener

    设置视频切换事件监听

    public void setOnVideoChangeListener(OnVideoChangeListener listener) 参数: listener -视频切换事件监听

  • setVideoScaleMode

    设置摄像头视频显示模式

     public void setVideoScaleMode(int mode)
     参数:
         `mode` - VideoScaleMode.ASPECT\_RATIO\_ORIGIN 对比例拉伸
                 VideoScaleMode.FILL\_PARENT 铺满拉伸

  • setVideoViewContainer

    设置视频容器

     public void setVideoViewContainer(ViewGroup container)
     参数:
         `container` - 视频容器

  • setWhiteboardViewContainer

    设置白板容器

     public void setWhiteboardViewContainer(android.view.ViewGroup container)
     参数:
         `container` - 白板容器

    • setDesktopVideoContainer

      设置视频分享/插播容器

      public void setDesktopVideoContainer(android.view.ViewGroup container) 参数: container - 桌面分享/插播容器

    • setWarmUpVideoContainer

      设置暖场视频容器

      public void setWarmUpVideoContainer(android.view.ViewGroup container) 参数: container - 暖场视频容器