@councilbox/shutter-sdk
v0.0.2
Published
Shutter API - Typescript/Javascript SDK
Downloads
7
Readme
SHUTTER SDK
A javascript sdk for Shutter built in typescript. This can be used in node or in the browser*.
NOTE: If used in the browser do not publish your private api key in frontend code.
Install
- Requires node.js >= 18.x
npm i @councilbox/shutter-sdkSetup Client
Next, require the module and instantiate a shutter client by calling
new Shutter and setup the client with basic auth credentials
(email: '[email protected]', password: 'your_pass_here'). Also need an api url
provided by shutter team.
import Shutter from "@councilbox/shutter-sdk";
const shutter = new Shutter({
email: "[email protected]",
password: "your_pass_here",
uri: "example.shutter.com",
});Documentation
Typescript documentation is available here.
Methods
users
- create
- delete
- me
organizations
- create
- delete
- list
- update
rooms
- attendeesUrls
- close
- create
- delete
- get
- list
- start
- startExternalStreaming
- startMassiveStreaming
- startRecording
- stopExternalStreaming
- stopMassiveStreaming
- stopRecording
- update
- updateStatus
attendees
- create
- delete
- denyWord
- get
- getURL
- grantWord
- list
- lowerHand
- mute
- raiseHand
- startTrack
- stopTrack
- update
recordings
- getIframeUrl
- list
frames
- captureAttendee
- captureRoom
- get
- list
