arctos SDK

arctos SDK is a JavaScript SDK for implementing video functionality. This document provides information on how to install, use, and customize the SDK.

You can add the SDK to your project in the following ways:

Using npm:

(Under development...)

npm install @ihh-arctos/arctos-widget

CDN Import

Add the following lines to your HTML file:

<!-- 引入 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>

Initialization

Before using the SDK, please initialize it:

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

Customizing Styles

If you wish to customize the SDK's styles, you can modify the arctos-widget.css file.

/* Add your custom styles here */

API Reference

Create Room (AddSession)

arctosSdkInstance.initMeetingRoom({...options})

Delete a Room (DeleteSession)

arctosSdkInstance.$meetingRoom.destroy()

Get Room Information and recordID (GetSession)

arctosSdkInstance.$meetingRoom.getSession()

Get All Participants Information in a Room (GetConnections)

arctosSdkInstance.$meetingRoom.getConnections()

Delete Participants in a Room (DeleteConnections)

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

Request Everyone to Leave the Room (DeleteConnectionsAll)

arctosSdkInstance.$meetingRoom.deleteConnectionsAll()

Start Video Recording (StartRecording)

arctosSdkInstance.$meetingRoom.startRecording()

Stop Video Recording (StopRecording)

arctosSdkInstance.$meetingRoom.stopRecording()

Get Video File Information (GetRecording)

arctosSdkInstance.$meetingRoom.getRecording()

Note

accessToken must be obtained through the CMS User Authentication API.