Skip to content

Resgrid/capacitor-plugin-resgrid

Repository files navigation

capacitor-plugin-resgrid

Capacitor plugin for using parts of the Resgrid system

Install

npm install capacitor-plugin-resgrid
npx cap sync

API

start(...)

start(options: ResgridPluginStartOptions) => Promise<void>
Param Type
options ResgridPluginStartOptions

stop()

stop() => Promise<void>

showModal()

showModal() => Promise<void>

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<any>


requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<any>


Interfaces

ResgridPluginStartOptions

Prop Type Description
token string
url string
type number Type of headset to use. 0 = Audio Only, 1 = Video
title string
defaultMic string
defaultSpeaker string
apiUrl string
canConnectToVoiceApiToken string
rooms ResgridPluginRooms[]

ResgridPluginRooms

Prop Type
name string
id string
token string