微吼开放平台
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. Harmony SDK
  • 产品介绍
  • 接入指南
    • 业务流程
    • 接入指南
    • 开通账号
    • 基本概念
  • 嵌入指南
    • 直播观看嵌入指南
      • 产品介绍
      • 嵌入说明
      • 嵌入示例
      • 嵌入页消息推送
      • 微信小程序嵌入说明
      • 嵌入模式支付对接
      • 嵌入页第三方K值验证
    • 聚合站点嵌入指南
      • 聚合页嵌入指南
      • 小程序嵌入指南
      • 创建三方用户「站点专用」
      • 更新三方用户「站点专用」
    • 直播管理嵌入指南
      • 产品介绍
      • 嵌入说明
      • 嵌入示例
    • APP嵌入指南
      • 支付方式唤起说明
      • 商品配置说明
  • SDK文档
    • 示例
    • JS SDK
      • 版本更新记录
      • 全局错误码
      • 全局事件
      • 文档白板
      • 互动连麦
      • 房间消息说明
      • 暖场视频
      • 观看直播
      • SDK 对接示例
      • 快速接入
      • 产品介绍
      • 点播SDK
        • 更新记录
        • 点播上传SDK
      • web 观播 sdk
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-聊天
        • 互动-优惠券
        • 互动-点赞
      • 直播间拓展功能
        • 资料下载
        • 观看限制验证
        • 观看协议
        • 回放章节
    • iOS SDK
      • 整体介绍
      • 快速接入
      • SDK 登录
      • 暖场视频
      • 视频轮询
      • 直播彩排
      • 高级美颜
      • 云导播
      • 观看协议
      • 文档白板演示
      • 聊天功能
      • 视频直播
        • 发起视频直播
        • 观看视频直播
      • 互动直播
        • 观众互动
        • 推流摄像头
        • 互动直播API
        • 主播发起互动直播
        • 嘉宾加入互动直播
      • 无延迟直播
        • 主播发起无延迟直播
        • 观众观看无延迟直播
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-章节打点
        • 互动-公告
        • 互动-商品
        • 互动-计时器
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-优惠券
        • 互动-点赞
      • 直播间拓展能力
        • 直播间特色功能配置项
        • 文件下载
        • 修改角色昵称
        • 观看权限校验
        • 投屏
        • 虚拟人数
      • 观看回放
        • 观看回放
      • 防录屏
        • 跑马灯
      • 字段说明
        • 互动活动详情字段
        • 错误码说明
        • 常量定义
        • 活动详情字段说明
      • 版本更新说明
        • 版本更新信息
        • v2.3.0 到 v2.4.0 升级说明
        • v3.0.1 到 v3.2.0 升级说明
        • V2.9.0到v3.0.1升级说明
        • v6.3.0
        • v6.2.1
        • v3.2.0 到 v4.0.1
        • v2.7.0 到 v2.8.0、v2.9.0 升级说明
        • 6.5.0
        • v5.0.x 到 v6.0.0
        • v6.4.0
    • Adroid SDK
      • 整体介绍
      • 快速接入
      • SDK登录
      • 暖场视频
      • 视频轮巡功能
      • 直播彩排
      • 高级美颜
      • 云导播功能
      • 观看协议
      • 文档白板
      • 聊天功能
      • 房间消息
      • 信息采集说明
      • 视频直播
        • 发起视频直播
        • 观看视频直播
      • 互动直播
        • 互动直播API
        • 主播发起互动直播
        • 嘉宾加入互动直播
        • 观众观看互动直播
      • 无延迟直播
        • 主播发起无延迟直播
        • 观众观看无延迟直播
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-计时器
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-优惠券
        • 互动-点赞
      • 直播拓展功能
        • 修改角色名称
        • 文件下载
        • 投屏演示
        • 虚拟人数
        • 观看权限校验
        • 直播间特色功能配置项
      • 观看回放
        • 观看回放/点播
      • 防录屏
        • 直播水印
        • 跑马灯
      • 字段说明
        • 房间消息字段说明
        • 聊天消息字段说明
        • 活动详情字段说明
      • 更新记录
        • 更新记录
      • 版本更新说明
        • v6.4.0
        • v6.3.0
        • v6.2.3
        • v6.2.1
        • v6.2.0
        • v6.1.0
        • v6.0.0
        • v5.0.0
        • v4.1.0
        • v4.0.0
        • v3.3.0
    • Harmony SDK
      • 整体介绍
      • 快速接入
      • SDK初始化
      • 登录&登出
      • 活动基础信息
      • 观看协议
      • 观看权限校验&预约
      • 开屏海报
      • 暖场视频
      • 观看直播
      • 观看回放/点播
      • 聊天
      • 房间消息
      • 在线人数&热度
      • 文档/白板
      • 版本更新
      • 私聊
      • 播放器错误码
      • 互动工具
        • 互动-问答
        • 互动-问卷
        • 互动-公告
        • 互动-抽奖
        • 互动-签到
        • 互动-计时器
        • 互动-礼物
        • 互动-互动有礼
        • 互动-快问快答
        • 互动-口令红包
        • 互动-推屏卡片
        • 互动-商品
        • 互动-优惠卷
        • 互动-观看有礼
        • 互动-点赞
      • 防录屏
        • 播放器水印&跑马灯
      • 菜单
        • 自定义菜单
        • 文件下载
        • 概要总结
        • 回放列表
        • 邀请卡
      • 互动直播
        • 互动直播API
        • 主播发起互动直播
        • 嘉宾加入互动直播
        • 观众观看互动直播
    • 微信小程序 SDK
    • 相关协议
      • 微吼直播 SDK 隐私政策
      • 微吼直播 SDK 开发者使用规范
  • 服务端API
    • Api介绍
    • 接入必读
      • 快速接入
      • 签名示例
      • 全局状态码
      • 调用频率说明
    • 账号管理
      • 子账号角色
        • 创建子账号角色
        • 更新子账号角色信息
        • 获取子账号角色列表
        • 获取子账号角色详情
      • 子账号管理
        • 创建子账号
        • 更新子账号信息(含角色绑定)
        • 获取子账号个数
        • 获取子账号列表
        • 获取子账号详情
        • 创建子账号应用信息
      • 三方用户管理
        • 创建三方用户
        • 更新三方用户
        • 获取微吼用户ID
        • 获取第三方用户ID
    • 授权服务
      • 获取观众登录Token
      • 获取控制台登陆Token
      • 获取控制台免登录地址
    • 标签管理
      • 创建标签
      • 删除标签
      • 更新标签
      • 置顶标签
      • 获取标签列表
      • 批量查询活动标签
      • 活动标签列表排序重置
    • 活动中心
      • 活动管理
        • 创建活动
        • 创建活动(点播/定时直播)
        • 删除活动
        • 修改活动信息
        • 活动列表接口
        • 获取活动详情
        • 批量获取活动详情
        • 获取活动场次列表
        • 获取当前视频分辨率详情(定时直播)
      • 角色权限
        • 角色邀请开关
        • 角色名称修改
        • 角色密码修改
        • 角色权限修改
        • 获取活动角色配置
        • 取消嘉宾/助理身份
        • 设置主持人身份信息
        • 获取B端用户参会地址
      • 互动管理
        • 签到
          • 获取进行中的签到任务
          • 创建并配置签到推送
          • 批量删除签到记录
          • 结束签到
          • 获取签到详情
        • 快问快答
          • 获取活动下快问快答列表
          • 快问快答-推送试卷
          • 快问快答-收卷
          • 快问快答-公布成绩
          • 获取快问快答题目
        • 在线抽奖
          • 抽奖管理
            • 创建或更新抽奖信息
            • 保存或更新抽奖条件与中奖用户设置
            • 保存或更新领奖页设置
            • 复制抽奖
            • 删除抽奖
          • 奖品管理
            • 创建或更新奖品信息
            • 批量删除活动下奖品
            • 保存抽奖奖品设置
            • 获取活动下奖品信息
            • 获取活动的奖品列表
          • 获取抽奖详情信息
            • 获取抽奖条件和用户设置
            • 获取抽奖配置基本信息
            • 获取抽奖领奖页设置
            • 获取活动下抽奖列表
          • 推送抽奖
            • 推送抽奖
          • 结束抽奖
            • 结束抽奖
      • 多语言管理
        • 创建活动语种
        • 删除活动语种
        • 修改活动语种
        • 查询活动语种列表
    • 观看限制
      • 全局踢出
        • 批量移除全局踢出观众
        • 新增/编辑全局踢出观众
        • 查询全局踢出观众列表
      • 观众组管理
        • 创建观众组
        • 指定观众组添加新用户
        • 获取观众组分组列表
        • 获取观众组下用户列表
        • 批量删除观众组用户
      • 平台观看限制
        • 设置活动观看限制
        • 查询活动观看限制
      • 外部观众鉴权
        • 外部观众获取活动票据-生成ticket
      • 第三方K值鉴权
        • 设置全局K值鉴权
        • 设置单个活动K值鉴权
        • 删除活动下的k_id
        • 设置活动多K值校验
        • 查询多K值详情列表
        • 查询活动K值详情配置
    • 回放管理
      • 回放设置
        • 回放列表
      • AI创作
        • 提交智能字幕解析任务
        • 智能字幕-编辑及保存
        • 获取智能字幕详情
    • 媒资中心
      • 图片上传
        • 图片上传
      • 文档管理
        • 删除文档
        • 获取文档详情
        • 获取文档章节
        • 获取活动下的文档列表
        • 上传文档
        • 活动关联文档
      • 音视频管理
        • 视频预览
        • 音视频删除
        • 音视频修改
        • 音视频列表
        • 音视频详情
    • 商品中心
      • 商品池
        • 创建商品
        • 更新商品
        • 商品详情
        • 商品列表
        • 复制商品
        • 批量删除
      • 活动商品
        • 获取当前活动未关联商品
        • 活动关联商品
        • 活动商品列表
        • 批量删除活动商品
        • 活动商品上架设置
        • 设置活动商品排序
        • 设置活动商品销售状态
        • 设置活动商品推送状态
        • 获取活动下商品统计数据
    • 数据统计
      • 套餐数据
        • 套餐用量
          • 并发消费查询
            • 财务总览-并发-消费账单
          • 流量数据查询
            • 6.查询用户流量
            • 查询某段时间内流量使用情况
            • 财务总览-流量-消费账单
          • 时常数据查询
            • 查询每天用户时长使用量
            • 查询指定时间内时长使用情况
            • 财务总览-时长-消费账单
        • 短信用量
          • 获取一定时间内短信使用量
          • 获取指定时间内短信消耗总值
          • 财务总览-短信-消费账单-分页明细
      • 互动数据
        • 基础统计
          • 预约
            • 活动预约列表
          • 报名表单
            • 获取报名表单记录
          • 邀请排名
            • 获取邀请榜
            • 获取邀请列表
            • 获取邀请卡详情
            • 邀请详情
          • 分享排名
            • 获取分享排名记录
        • 互动统计
          • 聊天
            • 获取历史聊天记录
          • 问答
            • 获取问答记录总数
            • 获取问答记录列表
          • 点赞
            • 获取房间的点赞数量
          • 快问快答
            • 获取快问快答答题详情
          • 问卷
            • 获取活动下问卷列表
            • 获取活动下问卷使用数据概览
            • 获取问卷ID对应问卷答案
            • 获取问卷提交人数
            • 获取问卷答案详情
          • 签到
            • 获取已推送的签到记录列表
            • 获取活动下已签到的用户记录
            • 获取活动签到统计列表
            • 签到用户列表接口(聚合表查询数据)
          • 现金红包
            • 获取红包发送记录
            • 获取红包领取列表
            • 获取活动下红包统计数据
          • 口令红包
            • 获取红包明细
            • 获取活动下红包统计数据
            • 获取发送红包记录
          • 打赏
            • 获取活动打赏列表
            • 获取活动打赏统计
          • 文件下载
            • 文档下载次数
            • 已下载资料数据列表
          • 连麦
            • 获取用户上麦记录
      • 数据订阅
        • 创建订阅主题与规则
        • 删除数据订阅主题与规则
        • 查询数据订阅主题与规则
        • 查询数据订阅主题与规则明细
      • 账号维度数据
        • 获取指定时间段内并发数据
        • 活动数据列表接口
        • 数据总览
        • 获取指定日期内最高并发
      • 活动维度数据
        • 数据报告
          • 活动统计信息
          • 观看人数趋势
        • 终端信息统计
          • 活动设备信息
          • 活动浏览器信息
        • 地理位置统计
          • 省份信息统计
          • 城市信息统计
        • 获取活动热度信息
          • 活动热度信息
        • 获取活动在线人数
          • 获取当前在线人数
          • 获取指定时间段内在线人数统计
        • 获取活动并发数据
          • 每天并发趋势
          • 获取当前活动最高并发
          • 获取当前活动指定时间段内最高并发
          • 获取指定时间段内活动最大并发
        • 获取用户观看明细
          • 获取用户观看明细(新)
          • 获取用户观看明细(旧)
    • 消息回调
      • 回调事件说明
      • 回调事件列表
      • 回调事件管理
        • 回调事件查询接口
        • 回调事件修改接口
        • 回调事件创建接口
      • 回调事件汇总
        • 活动信息
          • 活动删除
          • 活动创建
          • 活动信息更新
        • 活动状态
          • 活动状态
          • 活动推流状态
          • 活动状态改变
          • 活动恢复预告
        • 回放
          • 生成回放
          • 裁剪回放
          • 回放分辨率
          • 回放下载
          • 回放重制
        • 媒资
          • 视频转码
          • 文档转码
          • 音视频转码进度
        • 订单
          • 订单状态变更
        • AI创作
          • 智能解析
        • 报名
          • 报名表单提交
        • 抽奖
          • 中奖结果通知
          • 抽奖管理
          • 复制抽奖
          • 推送抽奖
          • 结束抽奖
          • 抽奖奖品管理
        • 快问快答
          • 答题记录
        • 签到
          • 推送签到
          • 结束签到
          • 签到管理
        • 商城奖励
          • 领取奖励回调
        • 观看时长
          • 时长达标
        • 房间消息
          • 上下线消息
    • 播放器设置
    • 转推流设置
      • 活动开关播
        • 开始直播
        • 结束直播
      • 平台推流到三方
        • 获取活动下已添加推流地址列表
        • 创建三方推流地址
        • 删除三方推流地址
        • 编辑三方推流地址
        • 开启/关闭三方推流
      • 平台拉流并开播
        • 拉流并开播
      • 获取当前活动推流状态
        • 获取直播间流状态
      • 获取当前活动推流地址
        • 获取直播间推流地址
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 接入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. Harmony SDK

快速接入

快速接入

1、申请 sdk 登录帐号#

确保您已完成 sdk 使用权限及账号的申请注册,未完成请先申请帐号

2、集成环境说明#

2.1开发环境说明#

最低支持 Harmony OS 版本:5.0.0(12)
IDE版本要求
DevEco Studio 5.1.1 Release
Build #DS-233.14475.28.36.511830
Build Version: 5.1.1.830, built on August 4, 2025
Runtime version: 17.0.12+1-b1087.25 amd64
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
Windows 11.0
GC: G1 Young Generation, G1 Old Generation
Memory: 4096M
Cores: 32
Registry:
  idea.plugins.compatible.build=IC-233.14475.28

3、绑定应用信息#

3.1、查询配置#

进入开发设置-点击查看应用(新应用可点击,创建应用)

3.2、应用初始化必要信息#

APPkey: 用于标识客户身份,在网络请求中会以某种形式传输
App Secretkey:它的作用是对客户方发起的请求进行数字签 名,保证该请求是来自指定客户的请求,并且是合法的有效的。移动端 SDK 使用
安全码SHA256:对应APP应用cer签名文件对应的SHA256编码
包名:对应APP应用包名

3.3、应用包名获取#

在应用app.json5 文件中获取bundleName,填写到鸿蒙SDK包名处并保存。
应用包名获取

3.4、安全码SHA256#

SDK进行接口验签需要使用签名信息,签名信息获取方法如下。
根据您APP配置的签名,找到cer文件
应用包名获取
将cer文件进行拷贝,然后保留最后一个-----BEGIN CERTIFICATE-----到-----END CERTIFICATE-----内容,删除之前面两个CERTIFICATE。
截取
使用命令行获取签名文件的SHA256信息。示例中使用openssl 进行获取。
截取
将0E:E5:2E:78:16:1D:4B:59:13:58:DC:08:0E:43:68:4F:73:06:AB:A0:43:B0:1E:16:72:9C:B6:CD:84:B2:F8:FC值粘贴到Harmony-SDK 签名值的安全码SHA256处并保存。

4、SDK 集成准备#

4.1、使用 ohpm引入SDK#

在集成SDK模块的oh-package.json5文件中引入@vhall/vhall_live
{
  "name": "watchkit",
  "version": "1.0.0",
  "description": "Please describe the basic information.",
  "main": "Index.ets",
  "author": "",
  "license": "Apache-2.0",
  "dependencies": {
    "@vhall/vhall_live": "1.0.0", // 根据最新发布的版本引入版本号
    "@ohos/danmakuflamemaster": "2.0.1",
    "@esky/barrage": "1.0.6"
  }
}
执行ohpm install @vhall/vhall_live

4.2、项目必要配置信息#

在引入应用module.json5 配置网络权限
{
  "module": {
    "name": "watchKit",
    "type": "har",
    "requestPermissions": [
      {"name": "ohos.permission.INTERNET"},
      {
        "name": "ohos.permission.READ_MEDIA",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        },
        "reason":"$string:read_media"
      },
      {
        "name": "ohos.permission.WRITE_MEDIA",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        },
        "reason":"$string:write_media"
      },
      {
        "name": "ohos.permission.WRITE_IMAGEVIDEO",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        },
        "reason":"$string:write_imagevideo"
      },
    ],
    "deviceTypes": [
      "default"
    ],
    "routerMap": "$profile:route_map"
  }
}

4.3、SDK引入获取版本号#

//导入包
import { VHSaaSDK, VHCallBack } from '@vhall/vhall_live'

@Entry
@Component
struct Index {

  aboutToAppear(): void {
    //获取SDK版本号
    VHSaaSDK.getInstance().getVersion();
  }

  build() {
    Navigation(this.pathStack) {
      
    }
    .hideToolBar(true)
    .hideTitleBar(true)
    .width('100%')
    .height('100%')
    .mode(NavigationMode.Stack)
    .id('Login')
  }

}

5、基本流程示例#

主要通过示例展示进入直播前用户需要进行初始化、活动配置信息获取、直播前状态处理。
获取初始化流程展示
上一页
整体介绍
下一页
SDK初始化
Built with