ugcinc 4.22.0 → 4.24.0

package/README.md

@@ -380,3 +380,42 @@ const everyFrame = await client.media.readVideoText({url: videoUrl, mode: 'frame
 Results include per-frame regions/lines, up to eight annotated frame previews, heuristic text `tracks` with observed boxes, and `coverage.inspected` plus `coverage.uninspected`. `coverage.complete` means all displayed frames within the range were inspected, not that OCR found every word. A track's `firstObservedMs` / `lastObservedEndMs` bounds observations; it does not prove uninterrupted visibility between sampled frames. Fast mode can miss brief text entirely. Fully scanned recognized single-frame text retains its decoded frame interval. Recognition scores are not calibrated probabilities. Track identity, scene-change rejection and line grouping are estimates; use individual observations and polygons for evidence.
 
 Both methods return `ApiResponse<MediaAnalysisJob>`, waiting through up to180 two-second status polls. A pending/processing response retains `jobId`; resume with `getMediaAnalysis({jobId})`. Job results include model/runtime versions and SHA-256 checksums. These CPU jobs share the existing bounded analysis queue. A failed job does not return partial OCR as complete.
+
+### Local speech transcription and audio levels
+
+Quick reference: `client.media.transcribeAudio({url})`, `client.media.measureAudioLevels({url})`; agent tools `transcribe_audio`, `measure_audio_levels`. Both use the authenticated media-analysis job/status flow.
+
+```ts
+const transcript = await client.media.transcribeAudio({url: videoUrl, language: 'en', timing: 'word'});
+const levels = await client.media.measureAudioLevels({url: videoUrl, windowMs: 100, silenceThresholdDbfs: -50});
+const excerpt = await client.media.transcribeAudio({url: videoUrl, range: {startMs: 5000, endMs: 15000}, channel: 0});
+```
+
+`POST /media/analysis/transcribe-audio` runs an owned CPU int8 Whisper Small model through faster-whisper. There is no hosted transcription call. Inputs: HTTPS audio/video URL; optional range, `timing: 'word' | 'segment'` (default word), language (auto default; en/es/fr/de/it/pt/ja/ko/zh/ar/hi/ru), and channel0 or1. Without a channel, native channels are arithmetically averaged; opposite-phase stereo can cancel. Results contain raw recognized text, segments/words with source-relative millisecond timestamps, model scores, detected language, pinned model revision/hashes and a mono16kHz WAV preview. Segment and word timings are explicitly **estimated**, not forced alignment. Segment mode leaves words empty and word timing unavailable. Speaker labels are unavailable; overlapping voices are not separated. Empty output means no speech recognized, not proof of no speech. Silence and files without audio return explicit successful statuses.
+
+`POST /media/analysis/measure-audio-levels` uses native channels/sample rate. Inputs: URL; optional range, `windowMs`20–5000 (default100), `silenceThresholdDbfs`−100 to−10 (default−50). Results contain per-channel RMS/sample peak levels in dBFS, near-full-scale sample counts, estimated true peaks in dBTP, integrated LUFS, a100ms momentary/short-term LUFS timeline, measured silence ranges and a waveform preview. Silence means all channels' window RMS is below the threshold; boundaries have window resolution. Near-full-scale samples (absolute amplitude>=1−1/32768) indicate possible clipping, not proven distortion. `intersampleOvershoot` distinguishes a true-peak estimate above0dBTP while sample peaks remain below0dBFS. Zero levels, gated/too-short loudness and unavailable metrics return null, never infinity. Momentary loudness needs400ms of history; short-term needs3seconds. FFmpeg summary LUFS/true peak values have0.1dB display precision.
+
+Both operations accept mono/stereo8–192kHz, source files<=100MiB and source duration<=30minutes. Each request covers at most120seconds; larger sources require an explicit smaller range. Range end is exclusive. Times are relative to the first displayed video frame, or the first decoded audio frame for audio-only files. Original audio PTS/timebase, audio offset, native channel layout and source hash are retained. Coverage distinguishes intervals with audio from video intervals without an audio stream; missing audio is not measured silence. Boundaries are rounded inward to decoded samples with the tolerance reported. Unsupported discontinuous audio timestamps fail explicitly. No source gain normalization is applied to level measurement.
+
+Both return `ApiResponse<MediaAnalysisJob>`, with the existing polling behavior and `getMediaAnalysis({jobId})` continuation. Owned JSON manifests retain results. Failed jobs never return incomplete analysis as complete. Recognition can miss words under music/overlap; timing precision and recognition accuracy must be evaluated separately.
+
+### Image colors and layout
+
+Quick reference: `client.media.sampleColors({url})`, `client.media.measureLayout({url, elements})`; tools `sample_colors`, `measure_layout`. Both return analysis jobs; poll `client.media.getMediaAnalysis({jobId})` if still pending.
+
+```typescript
+const colors = await client.media.sampleColors({url: imageUrl, point: {x: 20, y: 30}});
+const palette = await client.media.sampleColors({url: imageUrl, box: {x: 10, y: 20, width: 200, height: 100}, maxColors: 8});
+const layout = await client.media.measureLayout({url: imageUrl, elements: [
+  {id: 'headline', box: {x: 40, y: 60, width: 600, height: 100}},
+  {id: 'face', box: {x: 160, y: 200, width: 360, height: 500}},
+]});
+```
+
+`POST /media/analysis/sample-colors`: HTTPS image URL, optional **one** of integer `point`, `box`, or `mask`; omitted selector samples the whole image. `maxColors` defaults to 8, range 1–32. Coordinates refer to display-oriented source pixels after EXIF orientation. Boxes are continuous half-open rectangles and include pixel centers. The point returns straight RGBA bytes. Palettes exclude transparent pixels and weight partial alpha by alpha/255. If observed unique colors fit the limit, returns exact colors; otherwise returns the most populated 5-bit sRGB bins with alpha-weighted mean RGB, rounded to bytes. Proportions always use all selected alpha mass; `otherProportion` reports unreturned bins. Means are in encoded sRGB, not linear light. Empty or fully transparent selections return an empty palette. This measures decoded pixels, not guaranteed original design hex values, especially after compression or antialiasing.
+
+`POST /media/analysis/measure-layout`: HTTPS image URL plus 1–32 `elements`, each with a unique `id` (1–80 characters) and either `box` or `mask`. Returns bounds, normalized bounds, canvas margins, box centers, mask area and visible centroid, plus pairwise alignment deltas (B minus A), signed axis gaps, box intersection/IoU and mask intersection/IoU. Positive gap means separated, zero touching, negative means interval intersection length. Box area is not visible subject area: visible measurements are null without masks, and visible intersections require two masks. Empty masks have zero area and null bounds/centroids. This tool measures supplied geometry; it does not find elements or judge design intent. Preview numbers correspond to input element order.
+
+Masks for either tool are `{width, height, counts}` matching the full display-oriented image dimensions. `counts` is **row-major** binary run-length encoding, alternating background/foreground starting with background; only the first count may be zero. Runs sum to width×height; maximum 100,000 runs total per request. This is not COCO's column-major encoding. Mask pixel centers determine centroids; each included pixel contributes one square pixel of area, regardless of source alpha.
+
+Both tools accept single-frame PNG (up to 8-bit channels), JPEG and WebP, at most 4096 pixels per side and the shared 100MiB download limit. Embedded ICC profiles convert to sRGB using relative-colorimetric intent; untagged RGB/grayscale assumes sRGB. Unsupported/invalid profiles, untagged CMYK, unsupported bit depth/mode, animation, mismatched masks and out-of-bounds geometry fail explicitly. No resizing precedes measurement. Results include source byte hash, color/coordinate policies, a bounded annotated preview and JSON manifest. No model or hosted inference is used.

package/dist/index.d.ts

@@ -86,5 +86,5 @@ export type { SuccessResponse, ErrorResponse, ApiResponse, } from './types';
 export type { CropBoundary, CropAxisConfig, DynamicCropConfig, BorderRadiusConfig, VerticalAnchor, HorizontalAnchor, HorizontalSelfAnchor, VerticalSelfAnchor, RelativePositionConfigX, RelativePositionConfigY, } from './render/types';
 export type { PublicPostFailureCode, PublicPostRecovery, PublicPostNextAction, PublicPostFailure } from './post-failure';
 export type { ListProfilePostsParams, ListProfilePostsResult, DownloadSocialPostParams, DownloadSocialPostResult, SocialReferencePost, SocialReferenceAsset } from './social-acquisition';
-export type { ReadImageTextParams, ReadVideoTextParams, ImageTextResult, VideoTextResult, ExtractFramesParams, DetectScenesParams, FramesResult, ScenesResult, MediaAnalysisResult, MediaAnalysisJob } from "./media-analysis";
-export { readImageTextSchema, readVideoTextSchema, imageTextResultSchema, videoTextResultSchema, extractFramesSchema, detectScenesSchema, mediaAnalysisStatusSchema, mediaAnalysisResultSchema } from "./media-analysis";
+export type { SampleColorsParams, MeasureLayoutParams, SampleColorsResult, MeasureLayoutResult, TranscribeAudioParams, MeasureAudioLevelsParams, AudioTranscriptResult, AudioLevelsResult, ReadImageTextParams, ReadVideoTextParams, ImageTextResult, VideoTextResult, ExtractFramesParams, DetectScenesParams, FramesResult, ScenesResult, MediaAnalysisResult, MediaAnalysisJob } from "./media-analysis";
+export { sampleColorsSchema, measureLayoutSchema, sampleColorsResultSchema, measureLayoutResultSchema, binaryMaskSchema, transcribeAudioSchema, measureAudioLevelsSchema, audioTranscriptResultSchema, audioLevelsResultSchema, readImageTextSchema, readVideoTextSchema, imageTextResultSchema, videoTextResultSchema, extractFramesSchema, detectScenesSchema, mediaAnalysisStatusSchema, mediaAnalysisResultSchema } from "./media-analysis";

package/dist/index.js

@@ -7,7 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasMissingTriggerError = exports.getPortErrorsForNode = exports.getErrorNodeIds = exports.validateWorkflow = exports.getCapturedNodes = exports.getNodesDownstreamOfSet = exports.getDownstreamNodes = exports.checkCrossContextViolation = exports.getForEachContext = exports.getConnectedSource = exports.cleanupStaleConnections = exports.removeNodeConnections = exports.removeConnection = exports.addConnection = exports.deriveConnections = exports.createNode = exports.getOutputSchema = exports.getNodeByType = exports.getAllNodes = exports.getInputPreviewValue = exports.computeAllNodePortsWithPreviews = exports.computeAllNodePorts = exports.computePortsWithPreviews = exports.computePortsForNode = exports.areTypesCompatible = exports.parseRemotionPropsJson = exports.REMOTION_COMPOSITION_IMPORTS = exports.remotionCompositionPortSchema = exports.remotionCompositionNodeSchema = exports.remotionCompositionSchema = exports.submitIMessageDmRenderJob = exports.submitInstagramDmRenderJob = exports.submitAutoCaptionRenderJob = exports.submitRemotionCompositionRenderJob = exports.submitScreenshotAnimationRenderJob = exports.submitSceneSplitJob = exports.submitDeduplicationJob = exports.getRenderJobStatus = exports.submitVideoRenderJob = exports.submitImageRenderJob = exports.BillingClient = exports.CommentsClient = exports.MediaClient = exports.AutomationsClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
 exports.parseOpenAPIOutputPath = exports.parseOpenAPIInputs = exports.mapOpenAPIType = exports.nodeConfigToCaptionStyle = exports.HttpMethods = exports.prepareImageComposerInput = exports.substituteVariables = exports.processTemplate = exports.extractTemplateVariables = exports.PortIdSchema = exports.normalizeToPortId = exports.portIdToTitle = exports.isValidPortId = exports.portId = exports.selectFromPool = exports.getModelDurations = exports.getModelAspectRatios = exports.ALL_VIDEO_MODELS = exports.getAvailableInputModes = exports.hasReferenceVariant = exports.getReferenceModelId = exports.hasFirstLastFrameVariant = exports.getFirstLastFrameModelId = exports.hasImageToVideoVariant = exports.getImageToVideoModelId = exports.isImageToVideoModel = exports.IMAGE_ASPECT_RATIOS = exports.ALL_IMAGE_MODELS = exports.getEditModelId = exports.isEditModel = exports.getCapturedSourceNodeTypes = exports.getFlowControlNodeTypes = exports.getAllNodeDefinitions = exports.getNodeDefinition = exports.isPortType = exports.formatPortType = exports.isAsyncExecutor = exports.internalNodeTypes = exports.nodeDefinitions = exports.extractWorkflowConfig = exports.generateNodeName = exports.shuffleNodePreview = exports.getPreviewValue = exports.removePreviewForConnection = exports.updatePreviewMapForConnection = exports.computePreviewMap = exports.computeAllNodePreviews = exports.resolveNodePreview = exports.getWorkflowOutputSchema = exports.hasMissingTerminalError = void 0;
-exports.mediaAnalysisResultSchema = exports.mediaAnalysisStatusSchema = exports.detectScenesSchema = exports.extractFramesSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.prepareVideoComposerInput = exports.formatDateTag = exports.outputFieldsToZod = exports.outputFieldToZod = exports.LLMProviders = exports.applyLogicOperator = exports.IfLogicOperators = exports.resolvePath = exports.indexExpressionToString = exports.indexExpressionToIndexes = exports.resolveUnknownPath = exports.getOutputTypeFromCategory = void 0;
+exports.mediaAnalysisResultSchema = exports.mediaAnalysisStatusSchema = exports.detectScenesSchema = exports.extractFramesSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.audioLevelsResultSchema = exports.audioTranscriptResultSchema = exports.measureAudioLevelsSchema = exports.transcribeAudioSchema = exports.binaryMaskSchema = exports.measureLayoutResultSchema = exports.sampleColorsResultSchema = exports.measureLayoutSchema = exports.sampleColorsSchema = exports.prepareVideoComposerInput = exports.formatDateTag = exports.outputFieldsToZod = exports.outputFieldToZod = exports.LLMProviders = exports.applyLogicOperator = exports.IfLogicOperators = exports.resolvePath = exports.indexExpressionToString = exports.indexExpressionToIndexes = exports.resolveUnknownPath = exports.getOutputTypeFromCategory = void 0;
 // =============================================================================
 // Client Exports
 // =============================================================================
@@ -175,6 +175,15 @@ Object.defineProperty(exports, "formatDateTag", { enumerable: true, get: functio
 var video_composer_1 = require("./automations/nodes/video-composer");
 Object.defineProperty(exports, "prepareVideoComposerInput", { enumerable: true, get: function () { return video_composer_1.prepareVideoComposerInput; } });
 var media_analysis_1 = require("./media-analysis");
+Object.defineProperty(exports, "sampleColorsSchema", { enumerable: true, get: function () { return media_analysis_1.sampleColorsSchema; } });
+Object.defineProperty(exports, "measureLayoutSchema", { enumerable: true, get: function () { return media_analysis_1.measureLayoutSchema; } });
+Object.defineProperty(exports, "sampleColorsResultSchema", { enumerable: true, get: function () { return media_analysis_1.sampleColorsResultSchema; } });
+Object.defineProperty(exports, "measureLayoutResultSchema", { enumerable: true, get: function () { return media_analysis_1.measureLayoutResultSchema; } });
+Object.defineProperty(exports, "binaryMaskSchema", { enumerable: true, get: function () { return media_analysis_1.binaryMaskSchema; } });
+Object.defineProperty(exports, "transcribeAudioSchema", { enumerable: true, get: function () { return media_analysis_1.transcribeAudioSchema; } });
+Object.defineProperty(exports, "measureAudioLevelsSchema", { enumerable: true, get: function () { return media_analysis_1.measureAudioLevelsSchema; } });
+Object.defineProperty(exports, "audioTranscriptResultSchema", { enumerable: true, get: function () { return media_analysis_1.audioTranscriptResultSchema; } });
+Object.defineProperty(exports, "audioLevelsResultSchema", { enumerable: true, get: function () { return media_analysis_1.audioLevelsResultSchema; } });
 Object.defineProperty(exports, "readImageTextSchema", { enumerable: true, get: function () { return media_analysis_1.readImageTextSchema; } });
 Object.defineProperty(exports, "readVideoTextSchema", { enumerable: true, get: function () { return media_analysis_1.readVideoTextSchema; } });
 Object.defineProperty(exports, "imageTextResultSchema", { enumerable: true, get: function () { return media_analysis_1.imageTextResultSchema; } });