Skip to content

Type Alias: ISoundboardSound ​

ts
type ISoundboardSound = object;

Defined in: types/api.base.ts:242

A clip on a server's soundboard.

Properties ​

categoryId? ​

ts
optional categoryId?: number | null;

Defined in: types/api.base.ts:249

Missing on older hosts; null means Uncategorized.


createdAt ​

ts
createdAt: string;

Defined in: types/api.base.ts:258


createdBy ​

ts
createdBy: IUserSimple | null;

Defined in: types/api.base.ts:257


durationMs ​

ts
durationMs: number;

Defined in: types/api.base.ts:255


emoji ​

ts
emoji: string | null;

Defined in: types/api.base.ts:252

Unicode emoji or an instance custom emoji key (custom:<id>).


guid ​

ts
guid: string;

Defined in: types/api.base.ts:244


id ​

ts
id: number;

Defined in: types/api.base.ts:243


name ​

ts
name: string;

Defined in: types/api.base.ts:250


serverGuid? ​

ts
optional serverGuid?: string;

Defined in: types/api.base.ts:247

Stable server identity for soundboard playback across federated instances.


serverId ​

ts
serverId: number;

Defined in: types/api.base.ts:245


url ​

ts
url: string;

Defined in: types/api.base.ts:256


volume ​

ts
volume: number;

Defined in: types/api.base.ts:254

Released under the GNU Affero General Public License v3.0.