@polyvharmony/rtc-sdk 1.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [v1.0.0-beta.1] - 2024-10-22
+
+此项目是保利威鸿蒙 RTC SDK
+
+完整的项目介绍见 [鸿蒙多场景项目](https://github.com/polyv/polyv-harmony-livescenes-sdk-demo)

package/Index.d.ts

@@ -0,0 +1,9 @@
+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/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+Copyright (c) 2024, contributors of the POLYV project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+POLYV 鸿蒙 RTC 项目
+===
+
+### 1 简介
+此项目是保利威鸿蒙 RTC SDK
+
+完整的项目介绍见 [鸿蒙多场景项目](https://github.com/polyv/polyv-harmony-livescenes-sdk-demo)
+
+### 2 下载安装
+
+```shell
+ohpm install @polyvharmony/rtc-sdk
+```

package/ResourceTable.txt

@@ -0,0 +1 @@
+string page_show 0x03000000

package/obfuscation.txt

@@ -0,0 +1,2 @@
+-keep-global-name
+*

package/oh-package.json5

@@ -0,0 +1 @@
+{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-beta.1","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-beta.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

@@ -0,0 +1 @@
+{"name":"@polyvharmony/rtc-sdk","version":"1.0.0-beta.1","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-beta.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,46 @@
+import { PLVRTCConfig } from "../vo/PLVRTCConfig";
+import { PLVRTCMediaState } from "../vo/PLVRTCMediaState";
+import { PLVRTCNetworkQuality } from "../vo/PLVRTCNetworkQuality";
+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;
+    /**
+     * 网络质量回调
+     */
+    onNetworkQuality(linkmicId: string, upQuality: PLVRTCNetworkQuality, downQuality: PLVRTCNetworkQuality): void;
+    /**
+     * 回调 通过RTC强制下麦
+     */
+    onKickOut(code: number): 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/vo/PLVRTCClientRole.d.ts

@@ -0,0 +1,10 @@
+export declare enum PLVRTCClientRole {
+    /**
+     * 观众 - 只拉流
+     */
+    AUDIENCE = 0,
+    /**
+     * 主播 - 拉流&推流
+     */
+    BROADCASTER = 1
+}

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,7 @@
+export declare class PLVRTCMediaState {
+    readonly linkmicId: string;
+    readonly audioEnable: boolean;
+    readonly videoEnable: boolean;
+    readonly audioVolume: number;
+    constructor(linkmicId: string, audioEnable: boolean, videoEnable: boolean, audioVolume: number);
+}

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

@@ -0,0 +1,30 @@
+export declare enum PLVRTCNetworkQuality {
+    /**
+     * 质量极好
+     */
+    EXCELLENT = 0,
+    /**
+     * 用户主观感觉和极好差不多，但码率可能略低于极好
+     */
+    GOOD = 1,
+    /**
+     * 用户主观感受有瑕疵但不影响沟通
+     */
+    POOR = 2,
+    /**
+     * 勉强能沟通但不顺畅
+     */
+    BAD = 3,
+    /**
+     * 网络质量非常差，基本不能沟通
+     */
+    VERY_BAD = 4,
+    /**
+     * 网络连接断开，完全无法沟通
+     */
+    DISCONNECT = 5,
+    /**
+     * 未知网络
+     */
+    UNKNOWN = 6
+}

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/module.json

@@ -0,0 +1,27 @@
+{
+	"app": {
+		"bundleName": "net.polyv.rtc",
+		"versionCode": 10000,
+		"versionName": "1.0.0",
+		"minAPIVersion": 50000012,
+		"targetAPIVersion": 50000012,
+		"apiReleaseType": "Release",
+		"compileSdkVersion": "5.0.0.71",
+		"compileSdkType": "HarmonyOS",
+		"appEnvironments": [],
+		"bundleType": "app"
+	},
+	"module": {
+		"name": "rtc_sdk",
+		"type": "har",
+		"deviceTypes": [
+			"default",
+			"tablet"
+		],
+		"packageName": "@polyvharmony/rtc-sdk",
+		"installationFree": false,
+		"virtualMachine": "ark12.0.2.0",
+		"compileMode": "esmodule",
+		"dependencies": []
+	}
+}

package/src/main/resources/base/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from package"
+    }
+  ]
+}

package/src/main/resources/en_US/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from package"
+    }
+  ]
+}

package/src/main/resources/zh_CN/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from package"
+    }
+  ]
+}