SDK Reference
Encoders
Choose codec and container for your target platform.
Format Guide
| Format | Codec | Alpha | Typical Use |
|---|---|---|---|
| MP4 | H.264 | No | Universal playback |
| WebM | VP9 | Yes | Web transparency |
| MOV | ProRes | Yes | Professional editing |
| PNG Sequence | PNG | Yes | Frame-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
- Initialize singleton client per service process.
- Wrap SDK calls with your own timeout/retry decorators.
- Map SDK/domain errors into internal error taxonomy.
- 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
| Format | Best For | Tradeoff |
|---|---|---|
| webm | Transparent web delivery | Not ideal for all legacy players |
| mov | Professional editing workflows | Larger files |
| mp4 | Universal playback | No alpha channel |