2-快速集成

閱讀準備

準備好一個保利威帳號，並在直播後台中的設定 -> 開發者設定頁面中獲取帳號直播系統中的 appId（應用 ID），appSecret（應用密鑰），userId（帳號 ID）；直播->直播列表中獲取 channelId（頻道號）。若為登入回放則額外需要頻道號對應回放列表裡的 vid（回放影片 id）。

環境要求

使用方式

第一種：使用 PLVLiveScenesPluginHelper （推薦）

下載 PLVLiveScenesPluginHelper 並放入專案目錄內；如果您使用 vscode 進行開發，則可以將目錄內的 .d.ts 一併帶入，獲得更好的型別提示

使用 PLVLiveScenesPluginHelper 您將無需關心如何引入以及引入原生插件順序。

import { PLVLiveScenesPluginHelper } from "项目目录/plv-live-scense-plugin-helper";

實例化插件

建立插件實例，後續所有操作都透過該實例進行。

const plugin = PLVLiveScenesPluginHelper(options);

PLVLiveScenesPluginHelper(options)

參數 options:

enum PluginType {
  /** 纯观看插件 */
  LiveScenesPlugin = "PLV-LiveScenesPlugin",
  /** 观看 + 开播复合插件 */
  LiveScenesHostPlugin = "PLV-LiveUniPlugin",
}

initService(options)

初始化插件服務。在使用其他功能之前，必須先呼叫此方法。

參數 options:

範例:

await plugin.initService({
  viewerId: "user001",
  viewerName: "UniappDemo用户",
  viewerAvatar: "https://example.com/avatar.jpg",
});

setUserInfo(options)

為防止 APP 端被嗅探和反編譯到開發者設定資訊，強烈建議開發者設計自己的加密方式在伺服器端對 userId、 AppID、 AppSecret進行加密，並透過 https 協定的介面取得後重新解密，再將參數傳遞給 SDK。

設定使用者帳號資訊。在 initService 之後，進入直播間或回放前呼叫。

參數 options:

範例:

await plugin.setUserInfo({
  appId: "YOUR_APP_ID",
  userId: "YOUR_USER_ID",
  appSecret: "YOUR_APP_SECRET",
});

loginLiveRoom(options)

登入並進入直播房間。

參數 options:

範例:

await plugin.loginLiveRoom({
  sceneType: 1, // 云课堂场景
  channelId: "YOUR_CHANNEL_ID",
});

loginPlaybackRoom(options)

登入並進入回放房間。

參數 options:

範例:

await plugin.loginPlaybackRoom({
  sceneType: 1,
  channelId: "YOUR_CHANNEL_ID",
  videoId: "YOUR_VIDEO_ID",
  vodType: 0, // 单个视频回放
});

logoutRoomMessage(callback)

註冊一個回呼函式，當使用者退出房間時（目前僅支援 iOS）會觸發。

參數 callback:

範例:

plugin.logoutRoomMessage((res) => {
  console.log("已退出房间", res);
});

開播功能，需要整合全功能版本插件，並設定 type 為 LiveScenesHostPlugin

import {
  PLVLiveScenesPluginHelper,
  PluginType,
} from "../../tools/plv-live-scense-plugin-helper.mjs";
const plugin = PLVLiveScenesPluginHelper({
  type: PluginType.LiveScenesHostPlugin,
});

loginStreamer

登入主播端開播

參數 options:

範例:

plugin.loginStreamer({
  channelId: "YOUR_CHANNEL_ID",
  password: "YOUR_CHANNEL_PASSWORD",
  nickname: "YOUR_NAME",
});

setScreenShareGroup

設定螢幕共享（僅 iOS 需要）

參數 options:

範例:

plugin.setScreenShareGroup(YOUR_APP_GROUP);

完整使用流程

一個典型的使用流程如下：

1. 引入並實例化插件。
2. 呼叫 initService 初始化服務。
3. 呼叫 setUserInfo 設定使用者資訊。
4. 根據需要呼叫 loginLiveRoom 或 loginPlaybackRoom 進入直播或回放。

import { PLVLiveScenesPluginHelper } from "./tools/plv-live-scense-plugin-helper.js";

const plugin = PLVLiveScenesPluginHelper();

async function start() {
  try {
    // 1. 初始化服务
    await plugin.initService({
      viewerId: "user001",
      viewerName: "Demo用户",
      viewerAvatar: "https://example.com/avatar.jpg",
    });

    // 2. 设置用户信息
    await plugin.setUserInfo({
      appId: "YOUR_APP_ID",
      userId: "YOUR_USER_ID",
      appSecret: "YOUR_APP_SECRET",
    });

    // 3. 登录直播间
    await plugin.loginLiveRoom({
      sceneType: 1,
      channelId: "YOUR_CHANNEL_ID",
    });

    console.log("登录成功");
  } catch (error) {
    console.error("发生错误:", error);
  }
}

start();

第二種：自行引入原生插件

自行引入原生插件

const playModule = uni.requireNativePlugin("PLV-LiveScenesPlugin-PlayModule");
const configModule = uni.requireNativePlugin(
  "PLV-LiveScenesPlugin-ConfigModule"
);

全功能版則是

var playModule = uni.requireNativePlugin("PLV-LiveUniPlugin-WatchPlayModule")
var configModule = uni.requireNativePlugin("PLV-LiveUniPlugin-WatchConfigModule")

觀看端設定模組 - ConfigModule

ConfigModule 封裝了帳號資訊、使用者資訊、SDK 設定功能。 開發者要播放保利威影片，需先到 保利威官網 註冊帳號，登入帳號後，進入雲直播 - 開發設定 取得 userId、 AppID、 AppSecret，並將加密得到加密串放到自己的伺服器，再在行動端透過網路取得加密串，app 本地解密，並設定給 setConfig 方法。設定模組資訊如果沒有特殊說明都需要在進入直播間前設定。

1. setViewerInfo

設定直播間使用者資訊。（直播間使用者的屬性在初始化後不允許修改） 方法：setViewerInfo()

範例：

configModule.setViewerInfo({ viewerId:"", viewerName: "", viewerAvatar: "", },
(result) => { })

參數：

2. setConfig

設定多場景的帳號屬性。為防止 APP 端被嗅探和反編譯到開發者設定資訊，強烈建議開發者設計自己的加密方式在伺服器端對 userId、 AppID、 AppSecret進行加密，並透過 https 協定的介面取得後重新解密，再將參數傳遞給 SDK。 方法：setConfig()

範例：

configModule.setConfig({
 appId: "",
 userId: "",
 appSecret: ""
}, (result) => {
});

參數：

3. setMarqueeConfig

設定自訂跑馬燈的設定屬性 方法：setMarqueeConfig()

範例

configModule.setMarqueeConfig({
  code: "",
}, (result) => {
})

參數：

觀看端播放模組 - PlayConfig

playModule 封裝了雲課堂、直播帶貨的直播和回放功能。

4. showFullScreenButtonOnIPad

是否在 iPad 上顯示全螢幕按鈕（僅在 iPad 雲課堂場景），需要在進入房間前呼叫

方法：showFullScreenButtonOnIPad()

範例：

playModule.showFullScreenButtonOnIPad({show:true});

參數：

5. loginLiveRoom

直播登入（雲課堂場景，帶貨直播場景登入）

方法：loginLiveRoom()

範例：

// 直播
playModule.loginLiveRoom(
  1,
  {
    channelId: "",
    liveParam4: "",
    liveParam5: "",
  },
  (result) => {}
);

參數：

6. loginPlaybackRoom

登入回放直播間（雲課堂，帶貨直播回放登入）

方法：loginPlaybackRoom()

範例：

playModule.loginPlaybackRoom(
  0,
  {
    channlId: "",
    liveParam4: "",
    liveParam5: "",
    videoId: "",
    vodType: 0,
  },
  (result) => {}
);

參數：

7. exitRoomCallback (僅 ios)

退出直播間回呼

方法：setExitRoomCallback()

範例：

playModule.setExitRoomCallback((res) => {
  Logger.info("退出房间成功");
  cb && cb(res);
});

主播端設定模組

var liveModule = uni.requireNativePlugin("PLV-LiveUniPlugin-StreamerLiveModule")
var configModule = uni.requireNativePlugin("PLV-LiveUniPlugin-StreamerConfigModule")

1. setAppGroup【僅iOS有效】

螢幕共享帳號設定的 App Group 方法：setAppGroup()

範例：

configModule.setAppGroup({
    appGroup:""
}, (result) => {
})

參數：

主播端直播模組 - LiveModule

登入開播推流

方法：loginStreamer()

範例：

playModule.loginStreamer({
    channelId: "",
    password: "",
    nickname: ""
}, (result) => {
});

參數：