SHUTTER SDK

![License]()
![Version]()
![NPM]()

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
- Setup Client
- Methods

Install

- Requires node.js >= 18.x

``sh
npm i @councilbox/shutter-sdk
`

Setup Client

Next, require the module and instantiate a shutter client by calling
new Shutter and setup the client with basic auth credentials
(email: 'example@mail.com', password: 'your_pass_here'). Also need an api url
provided by shutter team.

`js
import Shutter from "@councilbox/shutter-sdk";

const shutter = new Shutter({
email: "example@mail.com",
password: "your_pass_here",
uri: "example.shutter.com",
});
``

Documentation

Typescript documentation is available here.

Methods

$3

- create
- delete
- me

$3

- create
- delete
- list
- update

$3

- attendeesUrls
- close
- create
- delete
- get
- list
- start
- startExternalStreaming
- startMassiveStreaming
- startRecording
- stopExternalStreaming
- stopMassiveStreaming
- stopRecording
- update
- updateStatus

$3

- create
- delete
- denyWord
- get
- getURL
- grantWord
- list
- lowerHand
- mute
- raiseHand
- startTrack
- stopTrack
- update

$3

- getIframeUrl
- list

$3

- captureAttendee
- captureRoom
- get
- list