bitmovin_api_sdk.encoding.encodings.live package

Subpackages

• bitmovin_api_sdk.encoding.encodings.live.hd package
  • Submodules
  • bitmovin_api_sdk.encoding.encodings.live.hd.hd_api module
  • Module contents
• bitmovin_api_sdk.encoding.encodings.live.insertable_content package
  • Subpackages
    • bitmovin_api_sdk.encoding.encodings.live.insertable_content.schedule package
      • Submodules
      • bitmovin_api_sdk.encoding.encodings.live.insertable_content.schedule.schedule_api module
      • Module contents
    • bitmovin_api_sdk.encoding.encodings.live.insertable_content.scheduled package
      • Submodules
      • bitmovin_api_sdk.encoding.encodings.live.insertable_content.scheduled.scheduled_api module
      • bitmovin_api_sdk.encoding.encodings.live.insertable_content.scheduled.scheduled_insertable_content_list_query_params module
      • Module contents
    • bitmovin_api_sdk.encoding.encodings.live.insertable_content.stop package
      • Submodules
      • bitmovin_api_sdk.encoding.encodings.live.insertable_content.stop.stop_api module
      • Module contents
  • Submodules
  • bitmovin_api_sdk.encoding.encodings.live.insertable_content.insertable_content_api module
  • bitmovin_api_sdk.encoding.encodings.live.insertable_content.insertable_content_list_query_params module
  • Module contents
• bitmovin_api_sdk.encoding.encodings.live.scte35_cue package
  • Submodules
  • bitmovin_api_sdk.encoding.encodings.live.scte35_cue.scte35_cue_api module
  • Module contents

Submodules

bitmovin_api_sdk.encoding.encodings.live.live_api module

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

Bases: BaseApi

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

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

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

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

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

Stop Live Encoding

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Id of the encoding

Return type

BitmovinResponse

Module contents