https://github.com/line/planet-kit-web
https://github.com/line/planet-kit-web
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/line/planet-kit-web
- Owner: line
- Created: 2023-11-17T06:25:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-10T07:10:00.000Z (8 months ago)
- Last Synced: 2025-11-10T09:09:03.813Z (8 months ago)
- Language: PowerShell
- Size: 485 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# planet-kit-web
LINE Planet is a cloud-based real-time communications platform as a service (CPaaS) that helps you build a voice and video call environment. With LINE Planet, you can integrate call features into your service at minimum cost.
## Planet Documentation
[Planet Documentation](https://docs.lineplanet.me/) provides additional resources to help you integrate LINE Planet into your service. These resources include LINE Planet specifications, developer guides for each client platform, and server API references.
## Projects
- [planet-kit-web](planet-kit/): WebPlanetKit SDK.
- [planet-kit-virtual-background](planet-kit-virtual-background/): The virtual background plugin of WebPlanetKit.
## Installation
### Requirements
- Node
- npm or yarn
- Supported browser
- Chromium 72+ based browser
- Safari 16.4+ (beta)
- WebView (beta)
### Installing via NPM
You can use WebPlanetKit SDK in your project by installing it through npm or yarn.
```
# npm
npm install @line/planet-kit
# yarn
yarn add @line/planet-kit
```
After installation, the method for importing the WebPlanetKit SDK into your project depends on your environment.
- For real environment
```javascript
import * as PlanetKit from "@line/planet-kit";
```
- For evaluation environment
```javascript
import * as PlanetKit from "@line/planet-kit/dist/planet-kit-eval";
```
### Including the SDK with a `` tag
Alternatively, you can directly include the WebPlanetKit SDK in your code using a `<script>` tag. The SDK can be obtained from the `dist` directory in this Git repository.
After downloading the SDK, the method for integrating the WebPlanetKit SDK into your project depends on your environment.
- For real environment
```javascript
<script type="text/javascript" src="path/to/js/planet-kit.js">
```
- For evaluation environment
```javascript
```
After including the SDK, you can use it in your Javascript code as follows.
```javascript
const planetKit = new PlanetKit.Conference();
```
## API Reference
For detailed information on APIs, please refer to the following documents.
[API Reference](https://docs.lineplanet.me/api-reference/client/web/latest/index.html)
## Issues and Inquiries
Please file any issues or inquiries you have to our representative or dl_planet_help@linecorp.com.
Your opinions are always welcome.
## FAQ
You can find answers to our frequently asked questions in the [FAQ](https://docs.lineplanet.me/help/faq/) section.