SHUTTER JS SDK

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

A javascript sdk for Shutter built with webpack, babel & es6. 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 >= 14.x

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

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-js";

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

Methods

The following service methods are available to instantiated clients. The examples assume you have already created a shutter client as shutter with valid credentials.

- users
- me
- create
- delete
- organizations
- list
- create
- update
- delete
- rooms
- list
- get
- create
- update
- delete
- start
- close
- startRecording
- stopRecording
- startMassiveStreaming
- stopMassiveStreaming
- attendeesUrls
- attendees
- list
- get
- getURL
- create
- update
- delete
- mute
- raiseHand
- lowerHand
- grantWord
- denyWord
- startTrack
- stopTrack
- recordings
- list
- getIframeUrl
- frames
- get
- list
- captureRoom
- captureAttendee

Method naming conventions:

- get or get{{Item}} - expected response for client is a single object
- list or list{{Items}} - expected response for client is a list of objects
- create or create{{Item}} - expected response for client is a single object
- update or update{{Item}} - expected response is an object with a status
message
- delete or delete{{Item}} - expected response is an object with a status
message

$3

#### me

shutter.users.me()

Example:

`js
try {
const me = await shutter.users.me();
console.log(me); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`
{
id: '109bec0f8aaef2395f481059',
name: 'Example',
surname: 'test',
email: 'example@shutter.com',
type: 'ACCOUNT',
organizations: [
{
id: '109bec1d8aaef2395f48105c',
name: 'Test Org',
logo: ,
created: '1620831261329'
}
],
language: 'en',
state: 'UNCONFIRMED',
created: '1620831247972'
}
`

#### create

shutter.users.create({ user })

Example:

`js
try {
const createdUser = await shutter.users.create({
user: {
name: "test",
email: "test@shutter.com",
},
});
console.log(createdUser); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '609ab5190ae391f4e90d10f1',
name: 'test',
email: "test@shutter.com"
}
`

Options:

| Parameter | Description |
| :-------- | :---------------------------------------------------------- |
| name | Name of the user. |
| email | Email address of the user. Example: "Jhon ". |

#### delete

shutter.users.delete({ id })

Example:

`js
try {
const deletedUser = await shutter.users.delete({
id: "109e4d75ec5805340e6ccaf7",
});
console.log(deletedUser); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`
{
id: '109e4d75ec5805340e6ccaf7',
name: 'Test',
surname: 'User',
email: 'test@shutter.com',
type: 'BASIC',
language: 'en',
state: 'UNCONFIRMED',
created: '1620987253103',
organizations: []
}
`

Options:

| Parameter | Description |
| :-------- | :---------- |
| id | User ID. |

$3

#### list

shutter.organizations.list()

Example:

`js
try {
const organizations = await shutter.organizations.list();
console.log(organizations); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
id: '109bec1d8aaef2395f48105c',
name: 'Test Org 1',
logo: ,
created: '1620831261329',
owner: {
id: '109bec0f8aaef2395f481059',
name: 'Test',
surname: 'SHUTTER',
email: 'test@shutter.com',
language: 'en',
created: '1620831247972'
}
},
...
]
`

#### create

shutter.organizations.create({ organization })

Example:

`js
try {
const organization = await shutter.organizations.create({
organization: {
name: Test Org,
logo: {
filetype: "png",
base64:
"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAdgAAAHYBTnsmCAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAEySURBVDiNhdJPK0VhEMfxz3UlsmDBQkn+lPxZKJYsRCErO2WpvAXvwXuwJaykJGWHYmFhgZ2UUjZYyC0RizM3zz0d3alper7PzO/Mc2ZKim0ZvTn2gN18Yumfwn7c5+6qrEaoMZc0jDNcFXRVZVMpzAvAEMZwjdFgNwmrsYYCgQ6sRXwOT1ldgSvsROwOT1ldgQlsRmwKT1ldgbtIvMNbeMpqrOgn9qFdNuKRYE8JqysAr5FcKWA1VsIMFuJcwa1smR4wGfw8YSNoidqjMlaxh/cQ+sKl7M1daI5Oq2wcBzjFYhnTmI83fmJLtm2H+MEjThI2iE7M4qUU7WxjI3nKWRQsxXk/YXCMdaw0xJe7cRGX6chew/NjHJCtdaWMObTK9r4n2hbCbfjwN432yPmO2PQLRLdIycezsR4AAAAASUVORK5CYII=",
},
},
});
console.log(organization); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e4d71ec5805340e6ccaf3',
name: 'Test Org',
logo:
}
`

Options:

| Parameter | Description |
| :-------- | :------------------------------------------------------------------------------------------------ |
| name | Name of the organization. |
| logo | Need two fields: filetype -> file type (png, jpeg, gif...); base64 -> file base64 encoded string. |

#### update

shutter.organizations.update({ organization })

Example:

`js
try {
const updatedOrganization = await shutter.organizations.update({
organization: {
id: "109e4d71ec5805340e6ccaf3",
name: Test Org Updated,
logo: {
filetype: "png",
base64:
"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAdgAAAHYBTnsmCAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAEySURBVDiNhdJPK0VhEMfxz3UlsmDBQkn+lPxZKJYsRCErO2WpvAXvwXuwJaykJGWHYmFhgZ2UUjZYyC0RizM3zz0d3alper7PzO/Mc2ZKim0ZvTn2gN18Yumfwn7c5+6qrEaoMZc0jDNcFXRVZVMpzAvAEMZwjdFgNwmrsYYCgQ6sRXwOT1ldgSvsROwOT1ldgQlsRmwKT1ldgbtIvMNbeMpqrOgn9qFdNuKRYE8JqysAr5FcKWA1VsIMFuJcwa1smR4wGfw8YSNoidqjMlaxh/cQ+sKl7M1daI5Oq2wcBzjFYhnTmI83fmJLtm2H+MEjThI2iE7M4qUU7WxjI3nKWRQsxXk/YXCMdaw0xJe7cRGX6chew/NjHJCtdaWMObTK9r4n2hbCbfjwN432yPmO2PQLRLdIycezsR4AAAAASUVORK5CYII=",
},
},
});
console.log(updatedOrganization); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e4d71ec5805340e6ccaf3',
name: 'Test Org Updated',
logo:
}
`

Options:

| Parameter | Description |
| :-------- | :------------------------------------------------------------------------------------------------ |
| id | Organization ID. (required). |
| name | Name of the organization. |
| logo | Need two fields: filetype -> file type (png, jpeg, gif...); base64 -> file base64 encoded string. |

#### delete

shutter.organizations.delete({ id })

Example:

`js
try {
const deletedOrganization = await shutter.organizations.delete({
id: "109e4d71ec5805340e6ccaf3",
});
console.log(deletedOrganization); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e4d71ec5805340e6ccaf3',
name: 'Test Org',
logo:
}
`

Options:

| Parameter | Description |
| :-------- | :--------------- |
| id | Organization ID. |

$3

#### list

shutter.rooms.list()

Example:

`js
try {
const rooms = await shutter.rooms.list();
console.log(rooms); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
roomNumber: '109e5704fd41a639344b9432',
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
created: '1620989700405',
displayName: 'Meeting',
externalID: 'test_1',
agenda: 'Meeting agenda',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: '',
view: 'grid',
theme: 'light',
attendees: [
{
id: '109e5705fd41a639344b943a',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
broadcasting: false,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
},
...
],
url: null,
canRecord: false,
autoRecord: false,
recording: false,
state: 'DRAFT',
deletedAt: null
},
...
]
`

#### get

shutter.rooms.get({ roomNumber })

Example:

`js
try {
const room = await shutter.rooms.get({ roomNumber: room.roomNumber });
console.log(room); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
roomNumber: '109e5704fd41a639344b9432',
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
created: '1620989700405',
displayName: 'Meeting',
externalID: 'test_1',
agenda: 'Meeting agenda',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: '',
view: 'grid',
theme: 'light',
attendees: [
{
id: '109e5705fd41a639344b943a',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
broadcasting: false,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
},
...
],
url: null,
canRecord: false,
autoRecord: false,
recording: false,
state: 'DRAFT',
deletedAt: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### create

shutter.rooms.create({ room, organizationID })

Example:

`js
try {
const room = await shutter.rooms.create({
room: {
type: "MEET",
displayName: Meeting test,
externalID: "test_2",
agenda: "Meeting agenda",
urlExternalLiveStreaming: "",
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: "",
view: "grid",
theme: "light",
attendees: [
{
email: "moderator@shutter.com",
role: "MODERATOR",
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: true,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: "Moderador",
language: "es",
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
},
],
password: "abc12345",
canRecord: false,
autoRecord: false,
security: "PRIVATE",
state: "DRAFT",
},
organizationID: "109e5700fd41a639344b942c",
});
console.log(room); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
created: '1620989700405',
displayName: 'Meeting test',
externalID: 'test_2',
agenda: 'Meeting agenda',
presenterID: null,
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: '',
view: 'grid',
theme: 'light',
attendees: [
{
id: '109e5704fd41a639344b9433',
externalID: null,
role: 'MODERATOR',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: true,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Moderador',
language: 'es',
online: false,
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
],
url: null,
canRecord: false,
autoRecord: false,
recording: false,
state: 'DRAFT',
roomNumber: '109e5704fd41a639344b9432'
}
`

Options:

| Parameter | Description |
| :------------- | :------------------------------------ |
| room | Room object |
| organizationID | Organization ID that room belongs to. |

#### update

shutter.rooms.update({ room })

Example:

`js
try {
const updatedRoom = await shutter.rooms.update({
room: {
roomNumber: '109e5704fd41a639344b9432',
type: 'MEET',
displayName: Meeting test Updated,
externalID: 'test_2',
agenda: 'Meeting agenda',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: '',
view: 'grid',
theme: 'light',
attendees: [
{
email: 'moderator@shutter.com',
role: 'MODERATOR',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: true,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Moderador',
language: 'es',
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
],
password: 'abc12345',
canRecord: false,
autoRecord: false,
security: 'PRIVATE',
state: 'DRAFT'
}
console.log(updatedRoom) // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
roomNumber: '109e5704fd41a639344b9432',
type: 'MEET',
displayName: Meeting test Updated,
externalID: 'test_2',
agenda: 'Meeting agenda',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
locked: false,
enabledWaitingRoom: false,
webhook: null,
data: '',
view: 'grid',
theme: 'light',
attendees: [
{
email: 'moderator@shutter.com',
role: 'MODERATOR',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: true,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Moderador',
language: 'es',
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
],
password: 'abc12345',
canRecord: false,
autoRecord: false,
security: 'PRIVATE',
state: 'DRAFT'
}
`

Options:

| Parameter | Description |
| :------------- | :------------------------------------ |
| room | Room object |

#### delete

shutter.rooms.delete({ roomNumber })

Example:

`js
try {
const deletedRoom = await shutter.rooms.delete({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(deletedRoom); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
canRecord: false,
autoRecord: false,
recording: false,
deletedAt: '1620989709156'
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### start

shutter.rooms.start({ roomNumber })

Example:

`js
try {
const startedRoom = await shutter.rooms.start({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(startedRoom); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
canRecord: false,
autoRecord: false,
recording: false,
state: 'STARTED'
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### close

shutter.rooms.close({ roomNumber })

Example:

`js
try {
const closedRoom = await shutter.rooms.close({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(closedRoom); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
canRecord: false,
autoRecord: false,
recording: false,
state: 'FINISHED'
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### startRecording

shutter.rooms.startRecording({ roomNumber })

Example:

`js
try {
const recordingStarted = await shutter.rooms.startRecording({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(recordingStarted); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
canRecord: true,
autoRecord: false,
recording: true
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### stopRecording

shutter.rooms.stopRecording({ roomNumber })

Example:

`js
try {
const recordingStopped = await shutter.rooms.stopRecording({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(recordingStopped); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
urlExternalLiveStreaming: '',
canExternalLiveStreaming: false,
autoExternalLiveStreaming: false,
externalLiveStreaming: false,
canRecord: true,
autoRecord: false,
recording: false
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### startMassiveStreaming

shutter.rooms.startMassiveStreaming({ roomNumber })

Example:

`js
try {
const massiveStreamingStarted = await shutter.rooms.startMassiveStreaming({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(massiveStreamingStarted); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
massive: true,
massiveStreaming: true,
canRecord: true,
autoRecord: false,
recording: false
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### stopMassiveStreaming

shutter.rooms.stopMassiveStreaming({ roomNumber })

Example:

`js
try {
const massiveStreamingStopped = await shutter.rooms.stopMassiveStreaming({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(massiveStreamingStopped); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
userID: '109bec0f8aaef2395f481059',
organizationID: '109e5700fd41a639344b942c',
type: 'MEET',
displayName: 'Meeting test Updated',
massive: true,
massiveStreaming: true,
canRecord: true,
autoRecord: false,
recording: false
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### attendeesUrls

shutter.rooms.attendeesUrls({ roomNumber })

Example:

`js
try {
const attendeesUrls = await shutter.rooms.attendeesUrls({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(attendeesUrls); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
attendee: {
id: '109e5705fd41a639344b9436',
role: 'MODERATOR',
canShareScreen: true,
canBroadcast: true,
broadcasting: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: true,
canSeeAttendeesList: true,
canRaiseHand: true,
mutedMic: false,
mutedCam: false,
displayName: 'Moderador',
language: 'es',
data: null
},
url:
},
...
]
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

$3

#### list

shutter.attendees.list({ roomNumber })

Example:

`js
try {
const attendees = await shutter.attendees.list({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(attendees); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
id: '109e5705fd41a639344b943a',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
broadcasting: false,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
},
...
]
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### get

shutter.attendees.get({ roomNumber, id })

Example:

`js
try {
const attendee = await shutter.attendees.get({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(attendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
broadcasting: false,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### get URL

shutter.attendees.getURL({ roomNumber, id })

Example:

`js
try {
const attendeeURL = await shutter.attendees.getURL({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(attendeeURL); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`
https:///room/
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### create

shutter.attendees.create({ roomNumber: room.roomNumber, attendee: newAttendee })

Example:

`js
try {
const createdAttendee = await shutter.attendees.create({
roomNumber: "109e5704fd41a639344b9432"
attendee: {
email: 'speaker2@shutter.com',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test 2',
language: 'en',
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
});
console.log(createdAttendee) // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test 2',
email: 'speaker2@shutter.com'
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
`

Options:

| Parameter | Description |
| :--------- | :-------------------------------- |
| roomNumber | Room ID that attendee belongs to. |
| attendee | Attendee object |

#### update

shutter.attendees.update({ roomNumber: room.roomNumber, attendee: newAttendee })

Example:

`js
try {
const updatedAttendee = await shutter.attendees.update({
roomNumber: "109e5704fd41a639344b9432"
attendee: {
id: '109e5705fd41a639344b943a',
email: 'speaker2@shutter.com',
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test 2 Updated',
language: 'en',
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
});
console.log(updatedAttendee) // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test 2 Updated',
email: 'speaker2@shutter.com'
language: 'en',
data: null,
toolbarShortcuts: {
shareScreen: true,
captureFrame: false
},
requiredMediaPermits: {
video: false,
audio: false
}
}
`

Options:

| Parameter | Description |
| :--------- | :-------------------------------- |
| roomNumber | Room ID that attendee belongs to. |
| attendee | Attendee object |

#### delete

shutter.attendees.delete({ roomNumber, id })

Example:

`js
try {
const deletedAttendee = await shutter.attendees.delete({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(deletedAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test 2 Updated',
email: 'speaker2@shutter.com'
language: 'en',
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### mute

shutter.attendees.mute({ roomNumber, id, type })

Example:

`js
try {
const mutedAttendee = await shutter.attendees.mute({ roomNumber: '109e5704fd41a639344b9432', id: '109e5705fd41a639344b943a', type: 'video });
console.log(mutedAttendee) // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
broadcasting: true,
mutedMic: false,
mutedCam: true,
displayName: 'Speaker Test 2 Updated',
email: 'speaker2@shutter.com'
language: 'en',
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |
| type | audio or video |

#### raiseHand

shutter.attendees.raiseHand({ roomNumber, id })

Example:

`js
try {
const raisedHandAttendee = await shutter.attendees.raiseHand({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(raisedHandAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
raisedHand: true, // <--
broadcasting: false,
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
online: false,
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### lowerHand

shutter.attendees.lowerHand({ roomNumber, id })

Example:

`js
try {
const loweredHandAttendee = await shutter.attendees.lowerHand({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(loweredHandAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
raisedHand: false, // <--
broadcasting: false, // <-- Put to false also.
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
online: false,
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### grantWord

shutter.attendees.grantWord({ roomNumber, id })

Example:

`js
try {
const grantedWordAttendee = await shutter.attendees.grantWord({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(grantedWordAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
raisedHand: true,
broadcasting: true, // <--
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
online: false,
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### denyWord

shutter.attendees.denyWord({ roomNumber, id })

Example:

`js
try {
const deniedWordAttendee = await shutter.attendees.denyWord({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
});
console.log(deniedWordAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
canShareScreen: true,
canBroadcast: true,
canChat: true,
canMuteAudio: true,
canMuteVideo: true,
canMuteAudioAll: true,
canMuteVideoAll: true,
canShareFiles: false,
canSeeAttendeesList: true,
canRaiseHand: true,
raisedHand: false, // <-- Put to false also.
broadcasting: false, // <--
mutedMic: false,
mutedCam: false,
displayName: 'Speaker Test',
language: 'en',
online: false,
data: null
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |

#### startTrack

shutter.attendees.startTrack({ roomNumber, id })

Example:

`js
try {
const startTrackAttendee = await shutter.attendees.startTrack({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
type: "video",
});
console.log(startTrackAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
broadcasting: false,
mutedMic: false,
mutedCam: false,
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |
| type | video or audio |

#### stopTrack

shutter.attendees.stopTrack({ roomNumber, id })

Example:

`js
try {
const stopTrackAttendee = await shutter.attendees.stopTrack({
roomNumber: "109e5704fd41a639344b9432",
id: "109e5705fd41a639344b943a",
type: "video",
});
console.log(stopTrackAttendee); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
id: '109e5705fd41a639344b943a',
externalID: null,
role: 'SPEAKER',
broadcasting: false,
mutedMic: false,
mutedCam: false,
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Attendee ID |
| type | video or audio |

$3

#### list

shutter.recordings.list({ roomNumber })

Example:

`js
try {
const recordings = await shutter.recordings.list({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(recordings); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
name: '60b89e4bf36ed0194f4189ca',
mixed: true,
mixProgress: 100,
uploaded: true,
uploadProgress: 100,
duration: 60,
size: 1000,
hash: '081d77de3522137b36deac2eb8479480ca4f376391865c99b73bfca5bef2c778'
hashType: 'SHA3-256'
creationDate: '1622711886052',
finishDate: null,
posterUrl: 'https:///recordings/poster?roomNumber=109e5704fd41a639344b9432&name=60b89e4bf36ed0194f4189ca&authorization=',
downloadUrl: 'https:///recordings/get?roomNumber=109e5704fd41a639344b9432&name=60b89e4bf36ed0194f4189ca&authorization=',
streamingUrl: 'https:///recordings/streaming?roomNumber=109e5704fd41a639344b9432&name=60b89e4bf36ed0194f4189ca&authorization=',
audioFile: true,
extractedAudio: true,
extractAudioProgress: 100,
uploadedAudio: true,
uploadAudioProgress: 100,
audioDuration: 60,
audioSize: 500,
audioHash: '9778229a36d04eb676ad4bc6aad70d6ed8d6bbab88e9efb2aa74346509a3d77c',
audioHashType: 'SHA3-256',
downloadAudioUrl: 'https:///recordings/get?roomNumber=109e5704fd41a639344b9432&name=60b89e4bf36ed0194f4189ca&type=audio&authorization=',
streamingAudioUrl: 'https:///recordings/streaming?roomNumber=109e5704fd41a639344b9432&name=60b89e4bf36ed0194f4189ca&type=audio&authorization='
},
...
]
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### getIframeUrl

shutter.recordings.getIframeUrl({ roomNumber })

Example:

`js
try {
const recordingsIframeUrl = await shutter.recordings.getIframeUrl({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(recordingsIframeUrl); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`
https:///recordings//
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

$3

#### get

shutter.frames.list({ roomNumber })

Example:

`js
try {
const frame = await shutter.frames.get({
roomNumber: "109e5704fd41a639344b9432",
id: "619b6d6cb46138160aaac1c1",
});
console.log(frames); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
"id": "619b6d6cb46138160aaac1c1",
"status": "DONE",
"date": "1637576044933",
"roomNumber": "109e5704fd41a639344b9432",
"attendeeID": "6194dd427fa3293dd6a12a9e",
"hash": "5888eb0d695eaf2452c6b7022a878d7d10acca1de00dfa7cf6c32ce348413359",
"hashType": "SHA3-256",
"url": "https:///frames/get?id=619b6d6cb46138160aaac1c1&authorization="
}
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| id | Frame ID. |

#### list

shutter.frames.list({ roomNumber })

Example:

`js
try {
const frames = await shutter.frames.list({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(frames); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
"id": "619b6d6cb46138160aaac1c1",
"status": "DONE",
"date": "1637576044933",
"roomNumber": "109e5704fd41a639344b9432",
"attendeeID": "6194dd427fa3293dd6a12a9e",
"hash": "5888eb0d695eaf2452c6b7022a878d7d10acca1de00dfa7cf6c32ce348413359",
"hashType": "SHA3-256",
"url": "https:///frames/get?id=619b6d6cb46138160aaac1c1&authorization="
},
...
]
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### captureRoom

shutter.frames.captureRoom({ roomNumber })

Example:

`js
try {
const capturedFrames = await shutter.frames.captureRoom({
roomNumber: "109e5704fd41a639344b9432",
});
console.log(capturedFrames); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
[
{
"id": "619b6d7bb46138160aaac1dc",
"status": "IN_PROGRESS",
"date": "1637576059301",
"roomNumber": "109e5704fd41a639344b9432",
"attendeeID": "6194dcb07fa3293dd6a129b4"
},
...
]
`

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |

#### captureAttendee

shutter.frames.captureAttendee({ roomNumber, attendeeID })

Example:

`js
try {
const capturedFrame = await shutter.frames.captureAttendee({
roomNumber: "109e5704fd41a639344b9432",
attendeeID: "6194dd427fa3293dd6a12a9e",
});
console.log(capturedFrame); // logs response data
} catch (err) {
console.log(err); // logs any error
}
`

Promise Returns:

`js
{
"id": "619b6d6cb46138160aaac1c1",
"status": "IN_PROGRESS",
"date": "1637576044933",
"roomNumber": "109e5704fd41a639344b9432",
"attendeeID": "6194dd427fa3293dd6a12a9e"
}
``

Options:

| Parameter | Description |
| :--------- | :----------------- |
| roomNumber | Room number or ID. |
| attendeeID | Attendee ID. |