快速集成

Preparation

Prepare a Polyv account. In the live streaming backend, navigate to Settings -> Developer Settings to obtain the appId (App ID), appSecret (App Secret), and userId (Account ID) from your account's live streaming system. From Live -> Live List, obtain the channelId (Channel ID). If logging into a playback, you additionally need the vid (Playback Video ID) from the corresponding playback list for that channel.

Environment Requirements

Usage

Method 1: Using PLVLiveScenesPluginHelper (Recommended)

Download PLVLiveScenesPluginHelper and place it in your project directory. If you are developing with VSCode, you can also include the .d.ts file from the directory for better type hints.

Using PLVLiveScenesPluginHelper eliminates the need to worry about how to import or the order of importing native plugins.

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

Instantiating the Plugin

Create a plugin instance. All subsequent operations are performed through this instance.

const plugin = PLVLiveScenesPluginHelper(options);

PLVLiveScenesPluginHelper(options)

Parameters options:

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

initService(options)

Initialize the plugin service. This method must be called before using other features.

Parameters options:

Example:

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

setUserInfo(options)

To prevent the app from being sniffed and reverse-engineered to obtain developer configuration information, it is strongly recommended that developers design their own encryption method to encrypt userId, AppID, and AppSecret on the server side. Obtain the encrypted string via an HTTPS interface, decrypt it, and then pass the parameters to the SDK.

Set user account information. Call this after initService and before entering a live room or playback.

Parameters options:

Example:

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

loginLiveRoom(options)

Log in and enter a live room.

Parameters options:

Example:

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

loginPlaybackRoom(options)

Log in and enter a playback room.

Parameters options:

Example:

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

logoutRoomMessage(callback)

Register a callback function that is triggered when a user exits the room (currently only supported on iOS).

Parameters callback:

Example:

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

The broadcasting feature requires integrating the full-featured version of the plugin and setting the type to LiveScenesHostPlugin.

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

loginStreamer

Log in from the host side to start broadcasting.

Parameters options:

Example:

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

setScreenShareGroup

Set up screen sharing (required only for iOS).

Parameters options:

Example:

plugin.setScreenShareGroup(YOUR_APP_GROUP);

Complete Usage Flow

A typical usage flow is as follows:

1. Import and instantiate the plugin.
2. Call initService to initialize the service.
3. Call setUserInfo to set user information.
4. Call loginLiveRoom or loginPlaybackRoom as needed to enter a live stream or playback.

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();

Method 2: Manually Importing Native Plugins

Manually import native plugins.

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

For the full-featured version:

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

Viewer Configuration Module - ConfigModule

ConfigModule encapsulates account information, user information, and SDK configuration functions. To play Polyv videos, developers must first register an account on the Polyv official website. After logging in, navigate to Cloud Live -> Development Settings to obtain userId, AppID, and AppSecret. Encrypt these to obtain an encrypted string, place it on your own server, then retrieve the encrypted string from the mobile app via the network, decrypt it locally in the app, and set it using the setConfig method. Unless otherwise specified, configuration module information must be configured before entering the live room.

1. setViewerInfo

Configure user information for the live room. (User attributes in the live room cannot be modified after initialization.) Method: setViewerInfo()

Example:

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

Parameters:

2. setConfig

Set account attributes for multiple scenarios. To prevent the app from being sniffed and reverse-engineered to obtain developer configuration information, it is strongly recommended that developers design their own encryption method to encrypt userId, AppID, and AppSecret on the server side. Obtain the encrypted string via an HTTPS interface, decrypt it, and then pass the parameters to the SDK. Method: setConfig()

Example:

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

Parameters:

3. setMarqueeConfig

Set configuration properties for a custom marquee. Method: setMarqueeConfig()

Example:

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

Parameters:

Viewer Playback Module - PlayConfig

playModule encapsulates the live and playback functions for Cloud Classroom and Live Commerce.

4. showFullScreenButtonOnIPad

Whether to display the full-screen button on iPad (only applicable in iPad Cloud Classroom scenarios). Must be called before entering the room.

Method: showFullScreenButtonOnIPad()

Example:

playModule.showFullScreenButtonOnIPad({show:true});

Parameters:

5. loginLiveRoom

Live login (for Cloud Classroom and Live Commerce scenarios).

Method: loginLiveRoom()

Example:

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

Parameters:

6. loginPlaybackRoom

Login to a playback live room (for Cloud Classroom and Live Commerce playback).

Method: loginPlaybackRoom()

Example:

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

Parameters:

7. exitRoomCallback (iOS only)

Callback for exiting the live room.

Method: setExitRoomCallback()

Example:

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

Host Configuration Module

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

1. setAppGroup [iOS Only]

App Group for screen sharing account configuration. Method: setAppGroup()

Example:

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

Parameters:

Host Live Module - LiveModule

Login to start broadcasting and push stream.

Method: loginStreamer()

Example:

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

Parameters: