觀看頁核心

本文檔主要提供觀看頁小程式 SDK 提供的核心方法 API 說明。

在設計模式上，觀看頁核心實例是單例設計，所以 SDK 提供單獨的方法來建立和銷毀實例

一、建立觀看頁核心實例

API 方法： createWatchCore(appConfig: AppConfig): PolyvWatchCore

參數說明：

• appConfig：配置選項，AppConfig 類型，必傳，詳細類型說明如下

範例程式碼：

import { createWatchCore } from '@polyv/live-watch-miniprogram-sdk';
const watchCore = createWatchCore({
  channelId: '频道号'
});

二、銷毀觀看頁核心實例

API 方法： destroyWatchCore(): void

注意：一般情況下不建議開發者主動去呼叫該方法，建議是隨瀏覽器標籤頁關閉時，自動被瀏覽器銷毀回收即可。

範例程式碼：

import { destroyWatchCore } from '@polyv/live-watch-miniprogram-sdk';
destroyWatchCore()

三、核心方法

3.1 設定授權 token

API 方法： setXAuthToken(xAuthToken: string): void

參數說明：

• xAuthToken：授權 token，string 類型，必傳

3.2 安裝觀看頁核心

觀看頁核心方法，用於安裝觀看頁核心並載入頻道資訊，安裝完成後回呼 Promise 及 PolyvWatchCoreEvents.WatchCoreSetuped 事件。

API 方法： setup(): Promise<SetupResult>

回傳值說明： Promise<SetupResult> 類型

範例：

import { createWatchCore } from '@polyv/live-watch-miniprogram-sdk';

const watchCore = createWatchCore({
  channelId: '频道号'
});
watchCore.setup();

3.3 連線聊天室

觀看頁核心方法，用於在進入直播觀看頁之前連線聊天室，連線完成後回呼 Promise 及 PolyvWatchCoreEvents.WatchCoreConnected 事件。

API 方法： connect(): Promise<void>

範例：

await watchCore.connect();
console.log('连接成功，显示直播观看页');