bitmovin_api_sdk.encoding.encodings.live.update_autoshutdown_config package
Submodules
bitmovin_api_sdk.encoding.encodings.live.update_autoshutdown_config.update_autoshutdown_config_api module
- class bitmovin_api_sdk.encoding.encodings.live.update_autoshutdown_config.update_autoshutdown_config_api.UpdateAutoshutdownConfigApi(**kwargs)[source]
Bases:
BaseApi- create(encoding_id, live_auto_shutdown_configuration_update_request, **kwargs)[source]
Replace Live Auto Shutdown Configuration
- Parameters:
encoding_id (string_types, required) – Id of the encoding.
live_auto_shutdown_configuration_update_request (LiveAutoShutdownConfigurationUpdateRequest, required) – 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.
- Returns:
The accepted Live Encoding auto shutdown configuration
- Return type: