Codeboard.
Technical referenceAPI signaturesData shapes

Media types

Data shapes for media. See all type groups for other domains and shared units. Import public types from codeboard-studio; helper shapes are included to explain nested values.

Asset

Code
export interface Asset {
    id: Id;
    kind: "image" | "audio";
    name: string;
    path: string;
    mimeType: string;
    source: "linked" | "managed";
    checksum?: string;
}

AudioClip

Code
export interface AudioClip {
    id: Id;
    assetId: Id;
    name: string;
    startFrame: number;
    sourceInFrame: number;
    durationFrames: number;
    volume: number;
    fadeInFrames: number;
    fadeOutFrames: number;
}

AudioTrack

Code
export interface AudioTrack {
    id: Id;
    name: string;
    muted: boolean;
    locked: boolean;
    clips: AudioClip[];
}

AudioTrackSummary

Code
export interface AudioTrackSummary extends Omit<AudioTrack, "clips"> {
    clipCount: number;
}

AudioClipQuery

Code
export interface AudioClipQuery extends PageOptions {
    frame?: number;
    assetId?: Id;
}

AudioTrackChanges

Code
export type AudioTrackChanges = Partial<Pick<AudioTrack, "name" | "muted" | "locked">>;

AudioClipInput

Code
export type AudioClipInput = Omit<AudioClip, "id"> & {
    id?: Id;
};

AudioClipChanges

Code
export type AudioClipChanges = Partial<Pick<AudioClip, "startFrame" | "sourceInFrame" | "durationFrames" | "volume" | "fadeInFrames" | "fadeOutFrames" | "name">>;

On this page