Class: SoundboardEndpoint

Defined in: endpoints/soundboard.ts:17

A server's soundboard: short clips members can play into a voice call.

Every member can list the sounds. Adding, changing and removing them needs manage_soundboard; playing one is done by the client, on its own track, and needs use_soundboard and speak in the call's channel.

Constructors

Constructor

new SoundboardEndpoint(client): SoundboardEndpoint;

Defined in: endpoints/soundboard.ts:18

Parameters

Parameter	Type
client	RESTClient

Returns

SoundboardEndpoint

Methods

create()

create(serverId, sound): Promise<ISoundboardSoundResponse>;

Defined in: endpoints/soundboard.ts:28

Add an already-uploaded clip. Upload it through the media endpoint first with mediaType soundboard_sound.

Parameters

Parameter	Type
serverId	number
sound	ISoundboardSoundInput & object

Returns

Promise<ISoundboardSoundResponse>

---

createCategory()

createCategory(serverId, name): Promise<ISoundboardCategoryResponse>;

Defined in: endpoints/soundboard.ts:43

Parameters

Parameter	Type
serverId	number
name	string

Returns

Promise<ISoundboardCategoryResponse>

---

list()

list(serverId): Promise<ISoundboardSoundsResponse>;

Defined in: endpoints/soundboard.ts:20

Parameters

Parameter	Type
serverId	number

Returns

Promise<ISoundboardSoundsResponse>

---

remove()

remove(serverId, soundId): Promise<IApiResponse>;

Defined in: endpoints/soundboard.ts:39

Parameters

Parameter	Type
serverId	number
soundId	number

Returns

Promise<IApiResponse>

---

removeCategory()

removeCategory(serverId, categoryId): Promise<IApiResponse>;

Defined in: endpoints/soundboard.ts:54

Removing a category keeps its sounds, moving them to Uncategorized.

Parameters

Parameter	Type
serverId	number
categoryId	number

Returns

Promise<IApiResponse>

---

update()

update(
   serverId, 
   soundId, 
   changes
): Promise<ISoundboardSoundResponse>;

Defined in: endpoints/soundboard.ts:35

Parameters

Parameter	Type
serverId	number
soundId	number
changes	ISoundboardSoundInput

Returns

Promise<ISoundboardSoundResponse>

---

updateCategory()

updateCategory(
   serverId, 
   categoryId, 
   name
): Promise<ISoundboardCategoryResponse>;

Defined in: endpoints/soundboard.ts:47

Parameters

Parameter	Type
serverId	number
categoryId	number
name	string

Returns

Promise<ISoundboardCategoryResponse>