初始化

功能说明

SDK初始化

实现方法

在调用API之前需要进行初始化，您需要在该步骤中填入项目的enterpriseId，如果您已经完成准备工作中的内容，则可以从管理平台获取到enterpriseId。在Application的onCreate方法中调用init方法即可初始化xylinkSDK。

我们建议一次运行过程中只初始化一次，不要频繁的调用init方法。

SDK配置接口的字段如下：

/**
 * sdk配置信息
 */
export interface XYSDKConfig {
  /**
   * 服务器地址
   */
  cloudServer: string;

  /**
   * 开放平台地址, 暂不自定义, 请传""
   */
  openapiServer: string;

  /**
   * 开放平台口令, 暂不自定义, 请传""
   */
  openapiToken: string;

  /**
   * 日志目录 必须设置有权限的路径
   */
  logFolder: string;

  /**
   * 日志文件名称
   */
  logFileName: string;

  /**
   * 平台标识，用于上传log使用, 请传 HarmonyOS
   */
  platformTag: string;

  /**
   * 应用标识, sdk请使用 XYSDKBusinessType.Sdk
   */
  appType: XYSDKBusinessType;

  /**
   * App版本号，用于上传log使用
   */
  appVersion: string;

  /**
   *  应用clientId
   */
  clientId: string;

  /**
   *  应用clientSecret
   */
  clientSecret: string;

  /**
   * 应用clientType, 请使用 harmony_sdk
   */
  clientType: string;

  /**
   *  操作系统版本
   */
  osVersion: string;

  /**
   * 硬件系统版本
   */
  hwVersion: string;

  /**
   * pem证书路径 暂不自定义, 请传""
   */
  pemFile: string;

  /**
   * 企业id
   */
  eid: string;

  /**
   * 采集方法  暂不支持, 请传0
   */
  capture: number;

  /**
   *  渲染方法 暂不支持, 请传0
   */
  render: number;

  /**
   * 是否使用统一layout  暂不自定义, 请传true
   */
  useUnityLayout: boolean;

  /**
   * app data路径  必须设置有权限的路径
   */
  appDataDir: string;

  /**
   * 是否支持能力集 暂不自定义, 请传true
   */
  supportCapabilities: boolean;

  /**
   * 定制ck
   */
  customKey: string;

  /**
   * 日志过滤规则 - 将设置的key替换为*
   */
  logFilterKey: string;

  /**
   * 日志过滤规则 - 将设置的key后num个字符替换为*
   */
  logFilterKeyNum: string;

  /**
   * 日志过滤规则 - 将设置的两个key之间的字符替换为*
   */
  logFilterKeys: string;

  /**
   * 云控配置数据文件路径，暂不自定义, 请传""
   */
  cloudConfigJsonPath: string;

  /**
   * 客户端能力集 sdk 请使用 [
   XYSDKAbilityType.DynamicErrorCode,
   XYSDKAbilityType.APIGateway,
   XYSDKAbilityType.UnsafeHttpMethod
   ]
   */
  ability: XYSDKAbilityType[]

  /**
   * 是否采用NativeCamera, 暂不自定义, 请传 false
   */
  useNativeCamera: boolean;
  /**
   * 强制接口使用网关 暂不自定义, 请传 false
   */
  forceApiGateway: boolean;
  /**
   * 登录类型 暂不自定义, 请传 ""
   */
  configLoginType: string;
  /**
   * 设备类型 pc 5, 手机 1
   */
  deviceType: number;
  /**
   * 设备标识
   */
  deviceSn: string;
}

示例代码

export class XYSDKConfigInfo implements XYSDKConfig {
  cloudServer: string = '';
  openapiServer: string = '';
  openapiToken: string = '';
  logFolder: string = '';
  useNativeCamera: boolean = false;
  configLoginType: string = "";
  forceApiGateway: boolean = false;
  logFileName: string = 'xylog';
  platformTag: string = 'HarmonyOS';
  appType: XYSDKBusinessType = XYSDKBusinessType.Sdk;
  appVersion: string = '3.3.0';
  clientId: string = '';
  clientSecret: string = '';
  clientType: string = 'harmony_sdk';
  osVersion: string = '';
  hwVersion: string = '';
  pemFile: string = '';
  eid: string = '';
  capture: number = 0;
  render: number = 0;
  useUnityLayout: boolean = true;
  appDataDir: string = '';
  supportCapabilities: boolean = true;
  customKey: string = '';
  logFilterKey: string = '';
  logFilterKeyNum: string = '';
  logFilterKeys: string = '';
  cloudConfigJsonPath: string = "";
  deviceType: number = 1;
  deviceSn: string = XYDeviceInfoUtil.getODID().replaceAll("-", "");
  ability: XYSDKAbilityType[] = [
    XYSDKAbilityType.DynamicErrorCode,
    XYSDKAbilityType.APIGateway,
    XYSDKAbilityType.UnsafeHttpMethod
  ];
}

  let xySdkConfig: XYSDKConfig = new XYSDKConfigInfo();
  xySdkConfig.cloudServer = this.host;
  xySdkConfig.clientId = this.clientId;
  xySdkConfig.clientSecret = this.clientSecret;
  xySdkConfig.eid = this.extId;
  xySdkConfig.logFolder = getContext(this).filesDir;
  xySdkConfig.appDataDir = getContext(this).filesDir;
  const error = XYRTCEngine.getInstance().init(xySdkConfig)

API参考

初始化

2024-10-09 20:38:26

导出PDF文档