SDK Reference

Encoders

Choose codec and container for your target platform.

Format Guide

FormatCodecAlphaTypical Use
MP4H.264NoUniversal playback
WebMVP9YesWeb transparency
MOVProResYesProfessional editing
PNG SequencePNGYesFrame-by-frame VFX

Tradeoffs

  • Higher quality increases file size and processing time.
  • WebM gives efficient alpha for browser delivery.
  • ProRes is heavy but best for editing headroom.

Recommended SDK Usage Pattern

  1. Initialize singleton client per service process.
  2. Wrap SDK calls with your own timeout/retry decorators.
  3. Map SDK/domain errors into internal error taxonomy.
  4. Capture job_id and business context in your tracing system.

SDK Hardening Checklist

  • Add per-call timeout defaults and circuit breaking.
  • Track SDK version in logs for post-incident debugging.
  • Test SDK upgrade in staging with archived production payloads.
  • Implement fallback strategy by model and output format.

Encoder Selection Guide

FormatBest ForTradeoff
webmTransparent web deliveryNot ideal for all legacy players
movProfessional editing workflowsLarger files
mp4Universal playbackNo alpha channel