Update a Stream
Update a stream’s configuration or apply live adjustments, including turning dubbing on and off, without recreating it.
Overview
Partially updates an existing stream. Send only the fields you want to change. Updates are allowed while the stream is scheduled, setting up, or started. There are two kinds of changes:- Configuration updates - rescheduling, replacing voices or dictionaries, and adding or modifying audio selections, profiles, pipelines, and targets. These are persisted into the stream configuration.
- Live pipeline patches (
pipeline_patches) - runtime-only adjustments to a running stream: turn dubbing on or off, adjust the dubbing mix, or nudge audio/video sync. These take effect within seconds and are not persisted.
ids (audio_selections, processing_profiles,
encoding_profiles, pipelines, target_streams) are merged by id:
entries you send are added or replaced as a whole, and existing entries are
never removed.Turning dubbing on and off
Setdubbing_enabled on a pipeline patch. With false, dubbing pauses and
the original audio passes through; with true, dubbing resumes.
Common updates
Errors
400- The stream has already finished and can no longer be updated.404- No stream with this ID belongs to your team.422- Validation error: unknownpipeline_id, anidreference that doesn’t resolve, or times without a matchingtimezone.
Related endpoints
Authorizations
Body
Partial update of a stream. All fields are optional; omit anything you do not want to change. List fields carrying ids (audio_selections, processing_profiles, encoding_profiles, pipelines, target_streams) are merged by id: entries you send are added or replaced, existing entries are never removed.
Response
Successful Response
The response is of type Response Patch Stream Data Stream Stream Id Patch · object.