Skip to content

Commit 88ef567

Browse files
docs: video-to-sfx returns audio only (no muxed video) (#5)
The dedicated video-to-audio endpoint no longer returns a muxed video, so video-to-sfx yields audio only. Fix the README example (which='video' would now raise) and note that SfxResult.video is retained for compatibility but is no longer populated.
1 parent b669cac commit 88ef567

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ task = client.video_to_sfx.submit(
9090
audio_format="wav",
9191
)
9292
result = client.tasks.wait(task.task_id, poll_interval=2.0, timeout=600.0)
93-
result.save("audio.wav")
94-
result.save("with_audio.mp4", which="video") # video-to-sfx also returns the muxed video
93+
result.save("audio.wav") # video-to-sfx returns the generated audio only
9594
```
9695

9796
`tasks.get(task_id)` fetches state once and never raises on a failed task;

‎src/sonilo/types.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ class SfxResult:
6060
status: str
6161
type: Optional[str] = None
6262
audio: Optional[SfxMedia] = None
63+
# video-to-sfx now returns audio only; `video` is kept for backward
64+
# compatibility but is no longer populated by the API.
6365
video: Optional[SfxMedia] = None
6466
cost: Optional[float] = None
6567
error: Optional[Dict[str, Any]] = None

0 commit comments

Comments
 (0)