@mux/ai 0.12.0 → 0.13.0

package/dist/{types-BRbaGW3t.d.ts → shots-BFYOfBgN.d.ts}

@@ -239,4 +239,119 @@ interface TokenUsage {
     metadata?: UsageMetadata;
 }
 
-export { type AssetTextTrack as A, type ChunkEmbedding as C, type Encrypted as E, type ImageSubmissionMode as I, type MuxAIOptions as M, type PlaybackAsset as P, type StoragePutObjectInput as S, type TextChunk as T, type UsageMetadata as U, type VTTChunkingConfig as V, type WorkflowCredentials as W, type StoragePresignGetObjectInput as a, type ChunkingStrategy as b, type EncryptedPayload as c, type MuxAsset as d, type PlaybackPolicy as e, type StorageAdapter as f, type TokenChunkingConfig as g, type TokenUsage as h, type ToneType as i, type VideoEmbeddingsResult as j, type WorkflowCredentialsInput as k, type WorkflowMuxClient as l, decryptFromWorkflow as m, encryptForWorkflow as n };
+interface Hotspot {
+    /** Inclusive start time in milliseconds */
+    startMs: number;
+    /** Exclusive end time in milliseconds */
+    endMs: number;
+    /** Hotspot score using distribution-based normalization (0-1) */
+    score: number;
+}
+interface HotspotOptions {
+    /** Maximum number of hotspots to return (default: 5) */
+    limit?: number;
+    /** Sort order: 'asc' or 'desc' (default: 'desc') */
+    orderDirection?: "asc" | "desc";
+    /** Order by field (default: 'score') */
+    orderBy?: "score";
+    /** Time window for results, e.g., '7:days' (default: '7:days') */
+    timeframe?: string;
+    /** Optional workflow credentials */
+    credentials?: WorkflowCredentialsInput;
+}
+interface HotspotResponse {
+    assetId?: string;
+    videoId?: string;
+    playbackId?: string;
+    hotspots: Hotspot[];
+}
+/**
+ * Fetches engagement hotspots for a Mux asset.
+ * Returns the top N "hot" time ranges based on engagement data.
+ *
+ * @param assetId - The Mux asset ID
+ * @param options - Hotspot query options
+ * @returns Array of hotspots with time ranges and scores
+ */
+declare function getHotspotsForAsset(assetId: string, options?: HotspotOptions): Promise<Hotspot[]>;
+/**
+ * Fetches engagement hotspots for a Mux video ID.
+ * Returns the top N "hot" time ranges based on engagement data.
+ *
+ * @param videoId - The Mux video ID
+ * @param options - Hotspot query options
+ * @returns Array of hotspots with time ranges and scores
+ */
+declare function getHotspotsForVideo(videoId: string, options?: HotspotOptions): Promise<Hotspot[]>;
+/**
+ * Fetches engagement hotspots for a Mux playback ID.
+ * Returns the top N "hot" time ranges based on engagement data.
+ *
+ * @param playbackId - The Mux playback ID
+ * @param options - Hotspot query options
+ * @returns Array of hotspots with time ranges and scores
+ */
+declare function getHotspotsForPlaybackId(playbackId: string, options?: HotspotOptions): Promise<Hotspot[]>;
+
+interface Shot {
+    /** Start time of the shot in seconds from the beginning of the asset. */
+    startTime: number;
+    /** Signed URL for a representative image of the shot. */
+    imageUrl: string;
+}
+interface PendingShotsResult {
+    status: "pending";
+    createdAt: string;
+}
+interface ErroredShotsResult {
+    status: "errored";
+    createdAt: string;
+    error: {
+        type: string;
+        messages: string[];
+    };
+}
+interface CompletedShotsResult {
+    status: "completed";
+    createdAt: string;
+    shots: Shot[];
+}
+type ShotsResult = PendingShotsResult | ErroredShotsResult | CompletedShotsResult;
+interface ShotRequestOptions {
+    /** Optional workflow credentials */
+    credentials?: WorkflowCredentialsInput;
+}
+interface WaitForShotsOptions extends ShotRequestOptions {
+    /** Polling interval in milliseconds (default: 2000, minimum enforced: 1000) */
+    pollIntervalMs?: number;
+    /** Maximum number of polling attempts (default: 60) */
+    maxAttempts?: number;
+    /** When true, request shot generation before polling (default: true) */
+    createIfMissing?: boolean;
+}
+/**
+ * Starts generating shots for an asset.
+ *
+ * @param assetId - The Mux asset ID
+ * @param options - Request options
+ * @returns Pending shot generation state
+ */
+declare function requestShotsForAsset(assetId: string, options?: ShotRequestOptions): Promise<PendingShotsResult>;
+/**
+ * Gets the current shot generation status for an asset.
+ *
+ * @param assetId - The Mux asset ID
+ * @param options - Request options
+ * @returns Pending, errored, or completed shot result
+ */
+declare function getShotsForAsset(assetId: string, options?: ShotRequestOptions): Promise<ShotsResult>;
+/**
+ * Requests shot generation if needed and polls until shots are completed.
+ *
+ * @param assetId - The Mux asset ID
+ * @param options - Polling options
+ * @returns Completed shot result
+ */
+declare function waitForShotsForAsset(assetId: string, options?: WaitForShotsOptions): Promise<CompletedShotsResult>;
+
+export { type AssetTextTrack as A, getShotsForAsset as B, type ChunkEmbedding as C, requestShotsForAsset as D, type Encrypted as E, waitForShotsForAsset as F, type Hotspot as H, type ImageSubmissionMode as I, type MuxAIOptions as M, type PlaybackAsset as P, type StoragePutObjectInput as S, type TextChunk as T, type UsageMetadata as U, type VTTChunkingConfig as V, type WorkflowCredentials as W, type StoragePresignGetObjectInput as a, type ChunkingStrategy as b, type EncryptedPayload as c, type MuxAsset as d, type PlaybackPolicy as e, type StorageAdapter as f, type TokenChunkingConfig as g, type TokenUsage as h, type ToneType as i, type VideoEmbeddingsResult as j, type WorkflowCredentialsInput as k, type WorkflowMuxClient as l, decryptFromWorkflow as m, encryptForWorkflow as n, type CompletedShotsResult as o, type ErroredShotsResult as p, type HotspotOptions as q, type HotspotResponse as r, type PendingShotsResult as s, type Shot as t, type ShotRequestOptions as u, type ShotsResult as v, type WaitForShotsOptions as w, getHotspotsForAsset as x, getHotspotsForPlaybackId as y, getHotspotsForVideo as z };

package/dist/workflows/index.d.ts

@@ -1,7 +1,7 @@
-export { A as AskQuestionsOptions, a as AskQuestionsResult, b as AskQuestionsType, c as AudioTranslationOptions, d as AudioTranslationResult, e as AutoCensorProfanityOptions, B as BurnedInCaptionsAnalysis, f as BurnedInCaptionsOptions, g as BurnedInCaptionsPromptOverrides, h as BurnedInCaptionsPromptSections, j as BurnedInCaptionsResult, C as CaptionReplacement, k as CensorMode, l as Chapter, m as ChapterSystemPromptSections, n as ChaptersOptions, o as ChaptersPromptOverrides, p as ChaptersPromptSections, q as ChaptersResult, r as ChaptersType, D as DEFAULT_DESCRIPTION_LENGTH, s as DEFAULT_SUMMARY_KEYWORD_LIMIT, t as DEFAULT_TITLE_LENGTH, E as EditCaptionsOptions, u as EditCaptionsResult, v as EmbeddingsOptions, w as EmbeddingsResult, H as HIVE_SEXUAL_CATEGORIES, x as HIVE_VIOLENCE_CATEGORIES, y as HiveModerationOutput, z as HiveModerationSource, M as ModerationOptions, F as ModerationProvider, G as ModerationResult, P as ProfanityDetectionPayload, Q as Question, I as QuestionAnswer, J as QuestionAnswerType, R as ReplacementRecord, S as SummarizationOptions, K as SummarizationPromptOverrides, L as SummarizationPromptSections, N as SummaryAndTagsResult, O as SummaryType, T as ThumbnailModerationScore, U as TranslationChunkingOptions, V as TranslationOptions, W as TranslationPayload, X as TranslationResult, Y as aggregateTokenUsage, Z as applyOverrideLists, _ as applyReplacements, $ as askQuestions, a0 as buildReplacementRegex, a1 as burnedInCaptionsSchema, a2 as censorVttContent, a3 as chapterSchema, a4 as chaptersSchema, a5 as createReplacer, a6 as editCaptions, a7 as generateChapters, a8 as generateEmbeddings, a9 as generateVideoEmbeddings, aa as getModerationScores, ab as getSummaryAndTags, ac as hasBurnedInCaptions, ad as profanityDetectionSchema, ae as questionAnswerSchema, af as shouldSplitChunkTranslationError, ag as summarySchema, ah as transformCueText, ai as translateAudio, aj as translateCaptions, ak as translationSchema } from '../index-DyzifniY.js';
+export { A as AskQuestionsOptions, a as AskQuestionsResult, b as AskQuestionsType, c as AudioTranslationOptions, d as AudioTranslationResult, e as AutoCensorProfanityOptions, B as BurnedInCaptionsAnalysis, f as BurnedInCaptionsOptions, g as BurnedInCaptionsPromptOverrides, h as BurnedInCaptionsPromptSections, j as BurnedInCaptionsResult, C as CaptionReplacement, k as CensorMode, l as Chapter, m as ChapterSystemPromptSections, n as ChaptersOptions, o as ChaptersPromptOverrides, p as ChaptersPromptSections, q as ChaptersResult, r as ChaptersType, D as DEFAULT_DESCRIPTION_LENGTH, s as DEFAULT_SUMMARY_KEYWORD_LIMIT, t as DEFAULT_TITLE_LENGTH, E as EditCaptionsOptions, u as EditCaptionsResult, v as EmbeddingsOptions, w as EmbeddingsResult, x as EngagementInsightsOptions, y as EngagementInsightsResult, H as HIVE_SEXUAL_CATEGORIES, z as HIVE_VIOLENCE_CATEGORIES, F as HiveModerationOutput, G as HiveModerationSource, M as ModerationOptions, I as ModerationProvider, J as ModerationResult, K as MomentInsight, O as OverallInsight, P as ProfanityDetectionPayload, Q as Question, L as QuestionAnswer, N as QuestionAnswerType, R as ReplacementRecord, S as SummarizationOptions, T as SummarizationPromptOverrides, U as SummarizationPromptSections, V as SummaryAndTagsResult, W as SummaryType, X as ThumbnailModerationScore, Y as TranslationChunkingOptions, Z as TranslationOptions, _ as TranslationPayload, $ as TranslationResult, a0 as aggregateTokenUsage, a1 as applyOverrideLists, a2 as applyReplacements, a3 as askQuestions, a4 as buildReplacementRegex, a5 as burnedInCaptionsSchema, a6 as censorVttContent, a7 as chapterSchema, a8 as chaptersSchema, a9 as createReplacer, aa as editCaptions, ab as extractTranscriptSegmentsForHotspots, ac as generateChapters, ad as generateEmbeddings, ae as generateEngagementInsights, af as generateVideoEmbeddings, ag as getModerationScores, ah as getSummaryAndTags, ai as hasBurnedInCaptions, aj as mapShotsToHotspots, ak as profanityDetectionSchema, al as questionAnswerSchema, am as shouldSplitChunkTranslationError, an as summarySchema, ao as transformCueText, ap as translateAudio, aq as translateCaptions, ar as translationSchema } from '../index-BeX_4DL7.js';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
-import '../types-BRbaGW3t.js';
+import '../shots-BFYOfBgN.js';
 import '@mux/mux-node';