@polyvharmony/rtc-sdk 1.0.0-dev.1 → 1.0.0-dev.3

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [v1.0.0-dev.1] - 2024-10-11
+## [v1.0.0-dev.3] - 2024-10-16
 
 此项目是保利威鸿蒙 RTC SDK
 

package/Index.d.ts

@@ -1,10 +1,9 @@
-export * from "./src/main/ets/d/e";
-export * from "./src/main/ets/f/g";
-export * from "./src/main/ets/f/h";
-export * from "./src/main/ets/i/j";
-export * from "./src/main/ets/i/k";
-export * from "./src/main/ets/i/l";
-export * from "./src/main/ets/i/m";
-export * from "./src/main/ets/i/n";
-export * from "./src/main/ets/i/o";
-export * from "./src/main/ets/p";
+export * from './src/main/ets/engine/PLVRTCEngine';
+export * from './src/main/ets/engine/PLVRTCEngineEventCallback';
+export * from './src/main/ets/vo/PLVRTCClientRole';
+export * from './src/main/ets/vo/PLVRTCConfig';
+export * from './src/main/ets/vo/PLVRTCMediaState';
+export * from './src/main/ets/vo/PLVRTCRenderViewParam';
+export * from './src/main/ets/vo/PLVRTCVideoEncodeParam';
+export * from './src/main/ets/vo/PLVRTCVideoRenderParam';
+export * from './src/main/ets/PLVRTCEngineFactory';

package/obfuscation.txt

@@ -1,2 +1,2 @@
--enable-property-obfuscation
--enable-toplevel-obfuscation
+-keep-global-name
+*

package/oh-package.json5

@@ -1 +1 @@
-{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-dev.1","description":"rtc-sdk","author":"POLYV","repository":"https://github.com/polyv/polyv-harmony-livescenes-sdk-demo","license":"MIT","dependencies":{"@polyvharmony/media-player-foundation":"2.2.0"},"types":"Index.d.ts","artifactType":"obfuscation","metadata":{"byteCodeHar":true,"sourceRoots":["./src/main"],"debug":false,"declarationEntry":[],"useNormalizedOHMUrl":true},"compatibleSdkVersion":12,"compatibleSdkType":"HarmonyOS","obfuscated":true}
+{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-dev.3","description":"rtc-sdk","author":"POLYV","repository":"https://github.com/polyv/polyv-harmony-livescenes-sdk-demo","license":"MIT","dependencies":{"@polyvharmony/media-player-foundation":"2.3.1-dev.1"},"types":"Index.d.ts","artifactType":"obfuscation","metadata":{"byteCodeHar":true,"sourceRoots":["./src/main"],"debug":false,"declarationEntry":[],"useNormalizedOHMUrl":true},"compatibleSdkVersion":12,"compatibleSdkType":"HarmonyOS","obfuscated":true}

package/package.json

@@ -1 +1 @@
-{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-dev.1","description":"rtc-sdk","author":"POLYV","repository":"https://github.com/polyv/polyv-harmony-livescenes-sdk-demo","license":"MIT","dependencies":{"@polyvharmony/media-player-foundation":"2.2.0"},"types":"Index.d.ts","artifactType":"obfuscation","metadata":{"byteCodeHar":true,"sourceRoots":["./src/main"],"debug":false,"declarationEntry":[],"useNormalizedOHMUrl":true},"compatibleSdkVersion":12,"compatibleSdkType":"HarmonyOS","obfuscated":true}
+{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-dev.3","description":"rtc-sdk","author":"POLYV","repository":"https://github.com/polyv/polyv-harmony-livescenes-sdk-demo","license":"MIT","dependencies":{"@polyvharmony/media-player-foundation":"2.3.1-dev.1"},"types":"Index.d.ts","artifactType":"obfuscation","metadata":{"byteCodeHar":true,"sourceRoots":["./src/main"],"debug":false,"declarationEntry":[],"useNormalizedOHMUrl":true},"compatibleSdkVersion":12,"compatibleSdkType":"HarmonyOS","obfuscated":true}

package/src/main/ets/PLVRTCEngineFactory.d.ts

@@ -0,0 +1,9 @@
+import { PLVRTCEngine } from "./engine/PLVRTCEngine";
+import { PLVRTCConfig } from "./vo/PLVRTCConfig";
+import { PLVRTCEngineEventCallback } from "./engine/PLVRTCEngineEventCallback";
+export declare abstract class PLVRTCEngineFactory {
+    private static readonly factoryImpls;
+    static register(factory: PLVRTCEngineFactory): void;
+    static create(rtcConfig: PLVRTCConfig, eventCallback: PLVRTCEngineEventCallback): PLVRTCEngine;
+    abstract create(rtcConfig: PLVRTCConfig, eventCallback: PLVRTCEngineEventCallback): PLVRTCEngine | null;
+}

package/src/main/ets/engine/PLVRTCEngine.d.ts

@@ -0,0 +1,75 @@
+import { PLVRTCAppToken, PLVRTCConfig } from "../vo/PLVRTCConfig";
+import { PLVRTCVideoEncodeParam } from "../vo/PLVRTCVideoEncodeParam";
+import { PLVRTCVideoRenderParam } from "../vo/PLVRTCVideoRenderParam";
+import { PLVRTCRenderViewParam } from "../vo/PLVRTCRenderViewParam";
+import { PLVRTCEngineEventCallback } from "./PLVRTCEngineEventCallback";
+import { PLVRTCClientRole } from "../vo/PLVRTCClientRole";
+export declare abstract class PLVRTCEngine {
+    readonly rtcConfig: PLVRTCConfig;
+    readonly eventCallback: PLVRTCEngineEventCallback;
+    constructor(rtcConfig: PLVRTCConfig, eventCallback: PLVRTCEngineEventCallback);
+    /**
+     * 加入频道
+     */
+    abstract joinChannel(channelId: string): number;
+    /**
+     * 离开频道
+     */
+    abstract leaveChannel(): number;
+    /**
+     * 更新token
+     */
+    abstract renewToken(appToken: PLVRTCAppToken): number;
+    /**
+     * 音频模块开关
+     */
+    abstract enableAudio(enable: boolean): number;
+    /**
+     * 本地音频采集开关
+     */
+    abstract enableLocalAudioCapture(enable: boolean): number;
+    /**
+     * 是否将本地音频发布到远端
+     */
+    abstract enableLocalAudioPublish(enable: boolean): number;
+    /**
+     * 视频模块开关
+     */
+    abstract enableVideo(enable: boolean): number;
+    /**
+     * 本地视频采集开关
+     */
+    abstract enableLocalVideoCapture(enable: boolean): number;
+    /**
+     * 是否将本地视频发布到远端
+     */
+    abstract enableLocalVideoPublish(enable: boolean): number;
+    /**
+     * 设置本地视频编码参数
+     */
+    abstract setLocalVideoEncodeParam(videoEncodeParam: PLVRTCVideoEncodeParam): number;
+    /**
+     * 创建渲染视图 XComponent 配置参数
+     */
+    abstract createRenderViewParam(linkmicId: string): PLVRTCRenderViewParam;
+    /**
+     * 设置视频渲染 本地&远端
+     */
+    abstract setVideoRender(renderParam: PLVRTCVideoRenderParam): number;
+    /**
+     * 设置是否订阅远端音频
+     */
+    abstract setRemoteAudioRender(linkmicId: string, isRender: boolean): number;
+    /**
+     * 切换角色
+     */
+    abstract switchRole(role: PLVRTCClientRole): number;
+    /**
+     * 切换前后摄像头
+     */
+    abstract switchCamera(): number;
+    /**
+     * 销毁
+     */
+    abstract destroy(): number;
+}

package/src/main/ets/engine/PLVRTCEngineEventCallback.d.ts

@@ -0,0 +1,37 @@
+import { PLVRTCConfig } from "../vo/PLVRTCConfig";
+import { PLVRTCMediaState } from "../vo/PLVRTCMediaState";
+export declare abstract class PLVRTCEngineEventCallback {
+    /**
+     * 成功加入频道
+     */
+    onJoinChannelSuccess(rtcConfig: PLVRTCConfig, channelId: string): void;
+    /**
+     * 断网重连重新加入频道
+     */
+    onRejoinChannelSuccess(rtcConfig: PLVRTCConfig, channelId: string): void;
+    /**
+     * 离开频道
+     */
+    onLeaveChannel(rtcConfig: PLVRTCConfig, channelId: string): void;
+    /**
+     * 远端用户加入频道
+     */
+    onRemoteUserJoin(channelId: string, mediaState: PLVRTCMediaState): void;
+    /**
+     * 远端用户音视频状态变化
+     */
+    onRemoteUserMediaStateChanged(channelId: string, mediaState: PLVRTCMediaState): void;
+    /**
+     * 远端用户离开频道
+     */
+    onRemoteUserLeave(channelId: string, mediaState: PLVRTCMediaState): void;
+    /**
+     * token 过期回调
+     * @see PLVRTCEngine#renewToken
+     */
+    onTokenExpired(channelId: string | undefined, rtcConfig: PLVRTCConfig): void;
+    /**
+     * 错误回调
+     */
+    onError(code: number, message: string): void;
+}

package/src/main/ets/noop/PLVRTCEngineNoOp.d.ts

@@ -0,0 +1,24 @@
+import { PLVRTCEngine } from "../engine/PLVRTCEngine";
+import { PLVRTCRenderViewParam } from "../vo/PLVRTCRenderViewParam";
+import { PLVRTCAppToken } from "../vo/PLVRTCConfig";
+import { PLVRTCVideoEncodeParam } from "../vo/PLVRTCVideoEncodeParam";
+import { PLVRTCVideoRenderParam } from "../vo/PLVRTCVideoRenderParam";
+import { PLVRTCClientRole } from "../vo/PLVRTCClientRole";
+export declare class PLVRTCEngineNoOp extends PLVRTCEngine {
+    createRenderViewParam(linkmicId: string): PLVRTCRenderViewParam;
+    enableAudio(enable: boolean): number;
+    enableLocalAudioCapture(enable: boolean): number;
+    enableLocalAudioPublish(enable: boolean): number;
+    enableLocalVideoCapture(enable: boolean): number;
+    enableLocalVideoPublish(enable: boolean): number;
+    enableVideo(enable: boolean): number;
+    joinChannel(channelId: string): number;
+    renewToken(appToken: PLVRTCAppToken): number;
+    setLocalVideoEncodeParam(videoEncodeParam: PLVRTCVideoEncodeParam): number;
+    setRemoteAudioRender(linkmicId: string, isRender: boolean): number;
+    setVideoRender(renderParam: PLVRTCVideoRenderParam): number;
+    switchRole(role: PLVRTCClientRole): number;
+    switchCamera(): number;
+    destroy(): number;
+    leaveChannel(): number;
+}

package/src/main/ets/{i/j.d.ts → vo/PLVRTCClientRole.d.ts}

@@ -1,4 +1,4 @@
-export declare enum h1 {
+export declare enum PLVRTCClientRole {
     /**
      * 观众 - 只拉流
      */

package/src/main/ets/vo/PLVRTCConfig.d.ts

@@ -0,0 +1,16 @@
+export declare class PLVRTCConfig {
+    rtcType: "artc" | null;
+    context: any;
+    rtcToken: PLVRTCAppToken | null;
+    /**
+     * 连麦ID
+     *
+     * [ARTC] 取值为32位整数
+     */
+    linkmicId: string | null;
+}
+export type PLVRTCAppToken = PLVARTCAppToken;
+export type PLVARTCAppToken = {
+    appId: string;
+    token: string;
+};

package/src/main/ets/vo/PLVRTCMediaState.d.ts

@@ -0,0 +1,6 @@
+export declare class PLVRTCMediaState {
+    readonly linkmicId: string;
+    readonly audioEnable: boolean;
+    readonly videoEnable: boolean;
+    constructor(linkmicId: string, audioEnable: boolean, videoEnable: boolean);
+}

package/src/main/ets/vo/PLVRTCRenderViewParam.d.ts

@@ -0,0 +1,6 @@
+export declare class PLVRTCRenderViewParam {
+    readonly linkmicId: string;
+    readonly componentId: string;
+    readonly componentLibraryName: string;
+    constructor(linkmicId: string, componentId: string, componentLibraryName: string);
+}

package/src/main/ets/vo/PLVRTCVideoEncodeParam.d.ts

@@ -0,0 +1,19 @@
+export declare class PLVRTCVideoEncodeParam {
+    width: number;
+    height: number;
+    frameRate: number;
+    targetBitRate: number | undefined;
+    minBitRate: number | undefined;
+    pushDowngradePreference: PLVPushDowngradePreference;
+    pushOrientation: PLVPushOrientation;
+    pushMirror: boolean;
+}
+export declare enum PLVPushDowngradePreference {
+    PREFER_BETTER_QUALITY = 0,
+    PREFER_BETTER_FLUENCY = 1
+}
+export declare enum PLVPushOrientation {
+    AUTO = 0,
+    LANDSCAPE = 1,
+    PORTRAIT = 2
+}

package/src/main/ets/vo/PLVRTCVideoRenderParam.d.ts

@@ -0,0 +1,10 @@
+export declare class PLVRTCVideoRenderParam {
+    linkmicId: string | null;
+    viewId: string | null;
+    renderFitMode: PLVVideoRenderFitMode;
+    renderMirror: boolean;
+}
+export declare enum PLVVideoRenderFitMode {
+    HIDDEN = 0,
+    FIT = 1
+}

package/src/main/ets/d/e.d.ts

@@ -1 +0,0 @@
-export declare function m(tag?: string): MethodDecorator;

package/src/main/ets/f/g.d.ts

@@ -1,75 +0,0 @@
-import { b1, c1 } from "../i/k";
-import { d1 } from "../i/n";
-import { e1 } from "../i/o";
-import { f1 } from "../i/m";
-import { g1 } from "./h";
-import { h1 } from "../i/j";
-export declare abstract class i1 {
-    readonly o: c1;
-    readonly t: g1;
-    constructor(r3: c1, s3: g1);
-    /**
-     * 加入频道
-     */
-    abstract u(p1: string): number;
-    /**
-     * 离开频道
-     */
-    abstract a1(): number;
-    /**
-     * 更新token
-     */
-    abstract j1(o1: b1): number;
-    /**
-     * 音频模块开关
-     */
-    abstract l1(enable: boolean): number;
-    /**
-     * 本地音频采集开关
-     */
-    abstract m1(enable: boolean): number;
-    /**
-     * 是否将本地音频发布到远端
-     */
-    abstract n1(enable: boolean): number;
-    /**
-     * 视频模块开关
-     */
-    abstract o1(enable: boolean): number;
-    /**
-     * 本地视频采集开关
-     */
-    abstract q1(enable: boolean): number;
-    /**
-     * 是否将本地视频发布到远端
-     */
-    abstract s1(enable: boolean): number;
-    /**
-     * 设置本地视频编码参数
-     */
-    abstract t1(n1: d1): number;
-    /**
-     * 创建渲染视图 XComponent 配置参数
-     */
-    abstract u1(m1: string): f1;
-    /**
-     * 设置视频渲染 本地&远端
-     */
-    abstract v1(l1: e1): number;
-    /**
-     * 设置是否订阅远端音频
-     */
-    abstract w1(j1: string, k1: boolean): number;
-    /**
-     * 切换角色
-     */
-    abstract z1(role: h1): number;
-    /**
-     * 切换前后摄像头
-     */
-    abstract a2(): number;
-    /**
-     * 销毁
-     */
-    abstract destroy(): number;
-}

package/src/main/ets/f/h.d.ts

@@ -1,37 +0,0 @@
-import { c1 } from "../i/k";
-import { b2 } from "../i/l";
-export declare abstract class g1 {
-    /**
-     * 成功加入频道
-     */
-    c2(o2: c1, q2: string): void;
-    /**
-     * 断网重连重新加入频道
-     */
-    d2(m2: c1, n2: string): void;
-    /**
-     * 离开频道
-     */
-    e2(k2: c1, l2: string): void;
-    /**
-     * 远端用户加入频道
-     */
-    f2(i2: string, j2: b2): void;
-    /**
-     * 远端用户音视频状态变化
-     */
-    g2(g2: string, h2: b2): void;
-    /**
-     * 远端用户离开频道
-     */
-    h2(e2: string, f2: b2): void;
-    /**
-     * token 过期回调
-     * @see PLVRTCEngine#renewToken
-     */
-    i2(c2: string | undefined, d2: c1): void;
-    /**
-     * 错误回调
-     */
-    onError(code: number, message: string): void;
-}

package/src/main/ets/i/k.d.ts

@@ -1,16 +0,0 @@
-export declare class c1 {
-    l2: "artc" | null;
-    context: any;
-    m2: b1 | null;
-    /**
-     * 连麦ID
-     *
-     * [ARTC] 取值为32位整数
-     */
-    n2: string | null;
-}
-export type b1 = l3;
-export type l3 = {
-    appId: string;
-    token: string;
-};

package/src/main/ets/i/l.d.ts

@@ -1,6 +0,0 @@
-export declare class b2 {
-    readonly n2: string;
-    readonly o2: boolean;
-    readonly q2: boolean;
-    constructor(v3: string, w3: boolean, x3: boolean);
-}

package/src/main/ets/i/m.d.ts

@@ -1,6 +0,0 @@
-export declare class f1 {
-    readonly n2: string;
-    readonly componentId: string;
-    readonly t2: string;
-    constructor(t3: string, componentId: string, u3: string);
-}

package/src/main/ets/i/n.d.ts

@@ -1,19 +0,0 @@
-export declare class d1 {
-    width: number;
-    height: number;
-    frameRate: number;
-    u2: number | undefined;
-    v2: number | undefined;
-    w2: m3;
-    z2: n3;
-    a3: boolean;
-}
-export declare enum m3 {
-    PREFER_BETTER_QUALITY = 0,
-    PREFER_BETTER_FLUENCY = 1
-}
-export declare enum n3 {
-    AUTO = 0,
-    LANDSCAPE = 1,
-    PORTRAIT = 2
-}

package/src/main/ets/i/o.d.ts

@@ -1,10 +0,0 @@
-export declare class e1 {
-    n2: string | null;
-    b3: string | null;
-    d3: q3;
-    e3: boolean;
-}
-export declare enum q3 {
-    HIDDEN = 0,
-    FIT = 1
-}

package/src/main/ets/p.d.ts

@@ -1,9 +0,0 @@
-import { i1 } from "./f/g";
-import { c1 } from "./i/k";
-import { g1 } from "./f/h";
-export declare abstract class c3 {
-    private static readonly j2;
-    static register(j3: c3): void;
-    static create(f3: c1, g3: g1): i1;
-    abstract create(f3: c1, g3: g1): i1 | null;
-}

package/src/main/ets/q/r.d.ts

@@ -1,24 +0,0 @@
-import { i1 } from "../f/g";
-import { f1 } from "../i/m";
-import { b1 } from "../i/k";
-import { d1 } from "../i/n";
-import { e1 } from "../i/o";
-import { h1 } from "../i/j";
-export declare class s2 extends i1 {
-    u1(b3: string): f1;
-    l1(enable: boolean): number;
-    m1(enable: boolean): number;
-    n1(enable: boolean): number;
-    q1(enable: boolean): number;
-    s1(enable: boolean): number;
-    o1(enable: boolean): number;
-    u(a3: string): number;
-    j1(z2: b1): number;
-    t1(w2: d1): number;
-    w1(u2: string, v2: boolean): number;
-    v1(t2: e1): number;
-    z1(role: h1): number;
-    a2(): number;
-    destroy(): number;
-    a1(): number;
-}