MCPcopy Create free account
hub / github.com/heygen-com/hyperframes / trackRenderComplete

Function trackRenderComplete

packages/cli/src/telemetry/events.ts:100–206  ·  view source on GitHub ↗
(
  props: {
    durationMs: number;
    fps: number;
    quality: string;
    /** Authoring workflow skill that drove this render (e.g. "product-launch-video"). */
    authoringSkill?: string;
    workers?: number;
    docker: boolean;
    gpu: boolean;
    // Static-frame dedup outcome (opt-out HF_STATIC_DEDUP=false). Undefined on
    // render paths with no capture session.
    staticDedupEnabled?: boolean;
    staticDedupArmed?: boolean;
    staticDedupSkipReason?: string;
    staticDedupPredictedFrames?: number;
    staticDedupReusedFrames?: number;
    // "cli" when triggered by `hyperframes render` (default), "studio" when
    // triggered by a studio preview-server render (POST /api/projects/:id/render).
    source?: "cli" | "studio";
    // Composition metadata
    compositionDurationMs?: number;
    compositionWidth?: number;
    compositionHeight?: number;
    totalFrames?: number;
    // Processing efficiency
    speedRatio?: number;
    captureAvgMs?: number;
    capturePeakMs?: number;
    // Resource usage
    peakMemoryMb?: number;
    memoryFreeMb?: number;
    tmpPeakBytes?: number;
    // Per-stage timings (subset of RenderPerfSummary.stages)
    stageCompileMs?: number;
    stageVideoExtractMs?: number;
    stageAudioProcessMs?: number;
    stageCaptureMs?: number;
    stageCaptureSetupMs?: number;
    stageCaptureFrameMs?: number;
    stageEncodeMs?: number;
    stageAssembleMs?: number;
    // Video-extraction breakdown (from RenderPerfSummary.videoExtractBreakdown)
    extractResolveMs?: number;
    extractHdrProbeMs?: number;
    extractHdrPreflightMs?: number;
    extractHdrPreflightCount?: number;
    extractVfrProbeMs?: number;
    extractVfrPreflightMs?: number;
    extractVfrPreflightCount?: number;
    extractPhase3Ms?: number;
    extractCacheHits?: number;
    extractCacheMisses?: number;
    // Attribute this event to a specific user (e.g. the browser user who
    // triggered a studio render); defaults to the install anonymousId.
    distinctId?: string;
  } & RenderObservabilityTelemetryPayload,
)

Source from the content-addressed store, hash-verified

98}
99
100export function trackRenderComplete(
101 props: {
102 durationMs: number;
103 fps: number;
104 quality: string;
105 /** Authoring workflow skill that drove this render (e.g. "product-launch-video"). */
106 authoringSkill?: string;
107 workers?: number;
108 docker: boolean;
109 gpu: boolean;
110 // Static-frame dedup outcome (opt-out HF_STATIC_DEDUP=false). Undefined on
111 // render paths with no capture session.
112 staticDedupEnabled?: boolean;
113 staticDedupArmed?: boolean;
114 staticDedupSkipReason?: string;
115 staticDedupPredictedFrames?: number;
116 staticDedupReusedFrames?: number;
117 // "cli" when triggered by `hyperframes render` (default), "studio" when
118 // triggered by a studio preview-server render (POST /api/projects/:id/render).
119 source?: "cli" | "studio";
120 // Composition metadata
121 compositionDurationMs?: number;
122 compositionWidth?: number;
123 compositionHeight?: number;
124 totalFrames?: number;
125 // Processing efficiency
126 speedRatio?: number;
127 captureAvgMs?: number;
128 capturePeakMs?: number;
129 // Resource usage
130 peakMemoryMb?: number;
131 memoryFreeMb?: number;
132 tmpPeakBytes?: number;
133 // Per-stage timings (subset of RenderPerfSummary.stages)
134 stageCompileMs?: number;
135 stageVideoExtractMs?: number;
136 stageAudioProcessMs?: number;
137 stageCaptureMs?: number;
138 stageCaptureSetupMs?: number;
139 stageCaptureFrameMs?: number;
140 stageEncodeMs?: number;
141 stageAssembleMs?: number;
142 // Video-extraction breakdown (from RenderPerfSummary.videoExtractBreakdown)
143 extractResolveMs?: number;
144 extractHdrProbeMs?: number;
145 extractHdrPreflightMs?: number;
146 extractHdrPreflightCount?: number;
147 extractVfrProbeMs?: number;
148 extractVfrPreflightMs?: number;
149 extractVfrPreflightCount?: number;
150 extractPhase3Ms?: number;
151 extractCacheHits?: number;
152 extractCacheMisses?: number;
153 // Attribute this event to a specific user (e.g. the browser user who
154 // triggered a studio render); defaults to the install anonymousId.
155 distinctId?: string;
156 } & RenderObservabilityTelemetryPayload,
157): void {

Callers 5

events.test.tsFile · 0.85
renderDockerFunction · 0.85
trackRenderMetricsFunction · 0.85
emitStudioRenderCompleteFunction · 0.85

Calls 2

trackEventFunction · 0.70

Tested by

no test coverage detected