Replace Live Auto Shutdown Configuration

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of the encoding.

Body Params

Applies a new auto shutdown configuration to a Live Encoding that is already running, without interrupting
the stream.

The body is a full replacement, not a partial update. Every field that is omitted or set to null
disarms the corresponding timer, and an empty body {} disarms all timers. Always send the complete
configuration you want the encoding to run with, including the values you want to keep.

streamTimeoutMinutes is counted from this call, not from the start of the encoding. The encoding is
stopped that many minutes after the update is accepted, whereas in the start request the same field is
counted from when the encoding started. An encoding started at 12:00 with streamTimeoutMinutes of 120 is
scheduled to stop at 14:00; updating it at 13:30 with streamTimeoutMinutes of 150 moves the shutdown to
16:00, not to 14:30. bytesReadTimeoutSeconds is relative by nature, as it always counts from the last byte
received, and waitingForFirstConnectTimeoutMinutes has no effect once the input is connected.

The organization's maximum live encoding runtime still bounds the total runtime of the encoding, measured
from the start of the encoding. An update that would push the shutdown past that limit is rejected rather
than extending the encoding beyond it.

Do not leave the call to the last few seconds. The update is rejected with 409 when any armed shutdown
timer is within 10 seconds of firing, because at that point the shutdown sequence is effectively already in
flight.

The auto shutdown configuration to set on a running Live
Encoding. Any auto shutdown configuration the encoding
currently has is overwritten.

Every timer that is omitted or null is disarmed. An empty
object disarms all timers, so always send the complete
configuration the encoding should run with, including the
values that should stay unchanged.

int64
≥ 30

Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.

int64
≥ 5

Automatically stops the Live Encoding after the given number of
minutes, counted from when the encoder applies this request.
The maximum live encoding runtime of the organization, counted
from the start of the encoding, still applies. If it comes first,
the encoding stops at that limit instead.

The instant actually scheduled is returned as scheduledShutdownAt.
Omit this field or set it to null to disarm this timer.

int64
≥ 5

Automatically shutdown the live stream if input is never connected for a predefined number of minutes.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json