开放平台
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
  1. Harmony SDK
  • DEMO示例
  • JS SDK
    • web 点播 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初始化
    • 登录&登出
    • 活动基础信息
    • 观看协议
    • 观看权限校验&预约
    • 开屏海报
    • 暖场视频
    • 观看直播
    • 观看回放/点播
    • 聊天
    • 房间消息
    • 在线人数&热度
    • 文档/白板
    • 版本更新
    • 私聊
    • 播放器错误码
    • 互动工具
      • 互动-问答
      • 互动-问卷
      • 互动-公告
      • 互动-抽奖
      • 互动-签到
      • 互动-计时器
      • 互动-礼物
      • 互动-互动有礼
      • 互动-快问快答
      • 互动-口令红包
      • 互动-推屏卡片
      • 互动-商品
      • 互动-优惠卷
      • 互动-观看有礼
      • 互动-点赞
    • 防录屏
      • 播放器水印&跑马灯
    • 菜单
      • 自定义菜单
      • 文件下载
      • 概要总结
      • 回放列表
      • 邀请卡
  • 微信小程序 SDK
  • 相关协议
    • 微吼直播 SDK 隐私政策
    • 微吼直播 SDK 开发者使用规范
  1. Harmony SDK

SDK初始化

SDK初始化#

初始化在app启动后进行设置一次即可。

关键方法#

方法方法描述
VHSaaSDK.getInstance().initSDK初始化
VHSaaSDK.getInstance().setRSAPrivateKeyRSA签名私钥设置

初始化接口#

接口 API#

public init(context: Context, appKey: string, appSecretKey: string, signature: string, packageName: string,callback:VHCallBack)

接口入参#

参数名称是否必须示例备注
context是xxx上下文
appKey是xxxvhall 后台注册生成的 APPkey
appSecretKey是xxxvhall 后台注册生成的 App Secretkey
signature是安全码。如果为空SDK内部自动进行获取app应用cer签名文件的SHA256值
packageName是com.vhall.live包名。如果为空SDK内部自动进行获取app应用包名
callback是回调

接口使用示例#

import { bundleManager } from '@kit.AbilityKit'
import { VHSaaSDK, VHCallBack } from '@vhall/vhall_live'

@Entry
@Component
struct Index {

    
  @State app_key: string = '312ffdajkdlsa89031e39934';
  @State app_secret_key: string = 'b0902b84e0c64125211a72d2718261d3';
  @State signature: string = '';
  @State packageName: string = '';
  //私钥 注意需要去掉-----BEGIN PUBLIC KEY-----与  -----END PUBLIC KEY----- 仅保留字符串值
  @State priKeyStr: string = "MIIEvAIBADANBgkEfKKwGwYYBNaAB8......Ii0xU20o0Emccr5OEai8g==";

  aboutToAppear(): void {
    
    VHSaaSDK.getInstance().getVersion();
    VHSaaSDK.getInstance().setRSAPrivateKey(this.priKeyStr);//在初始化之前使用,如果使用RSA进行参数加密时需要设置私钥
   //如果包名(package)或签名(sign)为空,SDK内部会自行获取应用信息进行接口请求校验VHSaaSDK.getInstance().init(this.getUIContext().getHostContext()?.getApplicationContext()! as Context, this.app_key,
        this.app_secret_key, this.sign, this.package,{
      // 成功
        onSuccess: (data: string | object) => {},

        // 失败
        onFailure: (errorCode: number, errorMsg: string) => {
        }
    });

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

}

RSA签名私钥设置#

如果控制台配置了接口签名为RSA签名必须在初始接口前进行参数设置

接口 API#

  public setRSAPrivateKey(priKey: string) 

接口参数#

参数字段描述
priKey私钥(从控制台 开发者设置获取)注意需要去掉-----BEGIN PUBLIC KEY-----与 -----END PUBLIC KEY----- 仅保留字符串值
修改于 2025-11-18 03:18:32
上一页
快速接入
下一页
登录&登出
Built with