Kappapps SDK

Appearance

Interface: LibraryMediaFileData ​

Metadata of a media file from the public Kappapps media library (ready-to-use assets curated by the Kappapps team), as returned by k.medias.library and k.medias.getLibrary.

Remarks ​

Same shape as ChannelMediaFileData (playable as-is via k.medias.playMedia({ file, ... })), plus catalog metadata.

Extends ​

Properties ​

category ​

ts
category: string;

Catalog category (e.g. a soundboard name), or null.

extension ​

ts
extension: string;

File extension (e.g. mp3, mp4, png).

Inherited from ​

ChannelMediaFileData.extension

name ​

ts
name: string;

Media name (the identifier used to look it up).

Inherited from ​

ChannelMediaFileData.name

path ​

ts
path: string;

Storage path of the file.

Inherited from ​

ChannelMediaFileData.path

size ​

ts
size: number;

File size, in bytes.

Inherited from ​

ChannelMediaFileData.size

slug ​

ts
slug: string;

Stable identifier of the asset (e.g. kapp-ding). Use it with k.medias.getLibrary / k.medias.playLibrary.

tags ​

ts
tags: string[];

Search tags.

token ​

ts
token: string;

Token used to build the media's playback URL.

Inherited from ​

ChannelMediaFileData.token

type ​

ts
type: "sounds" | "videos" | "images";

Media category.

Inherited from ​

ChannelMediaFileData.type