arctos SDK

arctos SDK 是一個用於實現視訊功能的 JavaScript SDK。本文件提供了有關如何安裝、使用和自定義 SDK 的信息。

你可以通過以下方式將 SDK 添加到你的項目中：

使用 npm：

（正在開發中...）

npm install @ihh-arctos/arctos-widget

CDN 引入

將以下代碼添加到你的 HTML 文件中：

<!-- 引入 SDK 的 CSS -->
<link rel="stylesheet" href="https://[your-endpoint-url]/arctos-sdk/arctos-widget.css">

<!-- 引入 SDK 的 JavaScript -->
<script async defer crossorigin="anonymous" src="https://[your-endpoint-url]/arctos-sdk/arctos-widget.js"></script>

初始化

在使用 SDK 之前，請先初始化它：

// 初始化 SDK
arctosSdkInstance = new Arctos({
  endpointUrl: 'https://[your-endpoint-url]/',
  endpointKey: '[your-endpoint-key]'
});

自定義樣式

如果你希望自定義 SDK 的樣式，可以修改 arctos-widget.css 文件。

/* 在這裡添加你的自定義樣式 */

API 參考

創建房間 (AddSession)

arctosSdkInstance.initMeetingRoom({...options})

刪除房間 (DeleteSession)

arctosSdkInstance.$meetingRoom.destroy()

獲取房間信息和記錄 ID (GetSession)

arctosSdkInstance.$meetingRoom.getSession()

獲取房間中所有參與者的信息 (GetConnections)

arctosSdkInstance.$meetingRoom.getConnections()

刪除房間中的參與者 (DeleteConnections)

arctosSdkInstance.$meetingRoom.deleteConnections({...options})

請求所有人離開房間 (DeleteConnectionsAll)

arctosSdkInstance.$meetingRoom.deleteConnectionsAll()

開始錄製視頻 (StartRecording)

arctosSdkInstance.$meetingRoom.startRecording()

停止錄製視頻 (StopRecording)

arctosSdkInstance.$meetingRoom.stopRecording()

獲取視頻文件信息 (GetRecording)

arctosSdkInstance.$meetingRoom.getRecording()

注意

accessToken 必須通過 CMS 用戶認證 API 獲取。