Skip to content

armgit / Cap

Public Imported from GitHub
0

Open source Loom alternative. Beautiful, shareable screen recordings.

3.6 KB
Raw Blame
/**
 * Type definitions for JSON metadata fields
 */

/**
 * Video metadata structure
 */
export interface VideoMetadata {
	loomImportRun?: {
		runId: string;
		dispatch: "pending" | "accepted" | "rejected" | "uncertain";
		importPriority?: "customer" | "bulk";
		mediaDispatch?: {
			attemptId: string;
			videoId?: string;
			state: "accepted" | "rejected" | "uncertain";
			jobId?: string;
			worker?: "importer" | "media" | null;
		};
	};
	loomImportUpload?: {
		attemptId: string;
		ownerId: string;
		organizationId: string | null;
		source?: { key: string; uploadId: string };
		output: { key: string; uploadId: string };
	};
	loomDeferredProcessing?: {
		rawFileKey: string;
		status: "pending" | "started" | "complete";
		startedAt?: string;
	};
	transcribeOnView?: boolean;
	loomPreviewGif?: {
		status: "pending" | "started" | "complete";
		startedAt?: string;
	};
	editProcessing?: {
		token: string;
		startedAt: string;
		ownerId: string;
		bucket: string | null;
		storageIntegrationId: string | null;
		sourceKey: string;
		source: string;
		dispatch: "pending" | "dispatching" | "accepted";
		jobId?: string;
		resultCommitted?: boolean;
		renderedMetadata?: {
			duration: number;
			width: number;
			height: number;
			fps: number;
		};
	};
	completedVideoEdit?: {
		token: string;
		startedAt: string;
		transcriptRemapped: boolean;
	};
	desktopRecordingUpload?: {
		version: 1;
		artifact:
			| { kind: "segments"; manifestSha256: string }
			| {
					kind: "mp4";
					fileSize: number;
					duration: number;
					objectIdentity: string;
			  };
		fileSize: number;
		duration: number;
		hasAudio: boolean;
		fullDecode: true;
		requiredAudioVerified?: boolean;
		objectIdentity: string;
		outputKey?: string;
		outputSha256?: string;
		sourceObjectIdentity?: string;
		sourceProof?: {
			version: 1;
			manifestSha256: string;
			inventorySha256: string;
			sourcePreserved: true;
			videoDuration: number;
			hasAudio: boolean;
			audioVerified: boolean;
		};
	};
	/**
	 * Custom created date that can be edited by the user
	 * This overrides the display of the actual createdAt timestamp
	 */
	customCreatedAt?: string;
	/**
	 * Title of the captured monitor or window
	 */
	sourceName?: string;
	/**
	 * AI generated title for the video
	 */
	aiTitle?: string;
	titleManuallyEdited?: boolean;
	/**
	 * AI generated summary of the content
	 */
	summary?: string;
	summaryManuallyEdited?: boolean;
	/**
	 * Chapter markers generated from the transcript
	 */
	chapters?: { title: string; start: number }[];
	chaptersManuallyEdited?: boolean;
	aiGenerationStatus?:
		| "QUEUED"
		| "PROCESSING"
		| "COMPLETE"
		| "ERROR"
		| "SKIPPED";
	/**
	 * Progress of the provisional live transcription that runs while an
	 * instant-mode recording is still uploading. The transcript content lives
	 * in `transcription.live.json` next to the video; this only gates UI/queue
	 * behavior. Cleared when the canonical transcription completes.
	 */
	liveTranscript?: {
		status: "active" | "complete" | "stopped";
		updatedAt?: string;
	};
	enhancedAudioStatus?: "PROCESSING" | "COMPLETE" | "ERROR" | "SKIPPED";
	agentUpload?: {
		state: "pending" | "accepted" | "rejected";
		rawFileKey?: string;
	};
}

export interface VideoCallToAction {
	label: string;
	url: string;
	headline?: string;
	color?: string;
	showWhilePlaying?: boolean;
}

export type VideoEditRange = {
	start: number;
	end: number;
};

export type VideoEditSpec = {
	version: 1;
	sourceDuration: number;
	keepRanges: VideoEditRange[];
};

/**
 * Space metadata structure
 */
export interface SpaceMetadata {
	[key: string]: never;
}

/**
 * User metadata structure
 */
export interface UserMetadata {
	[key: string]: never;
}