superlive-client-sdk-vuejs

The SuperLive Client SDK, written in Vue, helps you get started with integrating SuperLive for live streaming and live chat.

Getting Started

To get started just simple add this package into your project.

Installation

npm install superlive-client-sdk-vuejs
# or
yarn add superlive-client-sdk-vuejs

Usage

The basic usage of component.

import { createApp } from 'vue';
// 1. Import the component
import SuperLiveClientSDK from 'superlive-client-sdk-vuejs'
// 2. Import the component style 
// (Put this at the bottom to prevent styles to be overwritten by other styles)
import 'superlive-client-sdk-vuejs/style.css'

const app = createApp();

// 3. Register the component 
app.use(SuperLiveClientSDK);

Using Component

Then you can using component from SDK in the template.

<template>
    <SuperLiveClientSDK
        :production="production"
        :apiKey="apiKey"
        :hostId="hostId"
        :participantId="participantId"
    />
</template>

Props

Attribute	Description	Type	Default
production	Whether it is the production environment.	boolean	-
apiKey	The client side SDK authentication secret key. It can be generated in the Merchant Portal.	string	-
hostId	The streamer's ID which is generated during creating host via Merchant Portal or Server SDK.	string	-
participantId	The viewer's ID which is generated during creating participant via Server SDK.	string	-