bitmovin_api_sdk.encoding.encodings.live package

Subpackages

Submodules

bitmovin_api_sdk.encoding.encodings.live.live_api module

class bitmovin_api_sdk.encoding.encodings.live.live_api.LiveApi(**kwargs)[source]

Bases: BaseApi

get(encoding_id: string_types, **kwargs: dict) → LiveEncoding[source]

Live Encoding Details

Parameters

encoding_id (string_types, required) – Id of the encoding.

Returns

Encoding

Return type

LiveEncoding

get_start_request(encoding_id: string_types, **kwargs: dict) → StartLiveEncodingRequest[source]

Live Encoding Start Details

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Service specific result

Return type

StartLiveEncodingRequest

restart(encoding_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Re-Start Live Encoding

Parameters

encoding_id (string_types, required) – Id of the encoding. Important: Only live encodings with the status `RUNNING`, `FINISHED`, `CANCELED` or `ERROR` can be restarted.

Returns

Id of the encoding

Return type

BitmovinResponse

start(encoding_id: string_types, start_live_encoding_request: StartLiveEncodingRequest, **kwargs: dict) → BitmovinResponse[source]

Start Live Encoding

Parameters

  • encoding_id (string_types, required) – Id of the encoding

  • start_live_encoding_request (StartLiveEncodingRequest, required) – Live Encoding startup options

Returns

Id of the encoding

Return type

BitmovinResponse

stop(encoding_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Stop Live Encoding

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Id of the encoding

Return type

BitmovinResponse

Module contents