bitmovin_api_sdk.encoding.encodings package

Subpackages

Submodules

bitmovin_api_sdk.encoding.encodings.encoding_list_query_params module

class bitmovin_api_sdk.encoding.encodings.encoding_list_query_params.EncodingListQueryParams(offset: int = None, limit: int = None, include_total_count: bool = None, sort: string_types = None, type_: string_types = None, status: string_types = None, cloud_region: CloudRegion = None, selected_cloud_region: CloudRegion = None, encoder_version: string_types = None, selected_encoder_version: string_types = None, selected_encoding_mode: EncodingMode = None, name: string_types = None, search: string_types = None, created_at_newer_than: datetime = None, created_at_older_than: datetime = None, started_at_newer_than: datetime = None, started_at_older_than: datetime = None, finished_at_newer_than: datetime = None, finished_at_older_than: datetime = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.encodings.encodings_api module

class bitmovin_api_sdk.encoding.encodings.encodings_api.EncodingsApi(**kwargs)[source]

Bases: BaseApi

create(encoding: Encoding, **kwargs: dict) Encoding[source]

Create Encoding

Parameters

encoding (Encoding, required) – The Encoding to be created

Returns

Encoding

Return type

Encoding

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

Delete Encoding

Parameters

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

Returns

Id of the encoding

Return type

BitmovinResponse

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

Encoding Details

Parameters

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

Returns

Encoding

Return type

Encoding

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

Encoding Start Details

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Service specific result

Return type

StartEncodingRequest

list(query_params: Optional[EncodingListQueryParams] = None, **kwargs: dict) Encoding[source]

List all Encodings

Parameters

query_params (EncodingListQueryParams) – Query parameters

Returns

List of encodings

Return type

Encoding

reprioritize(encoding_id: string_types, reprioritize_encoding_request: ReprioritizeEncodingRequest, **kwargs: dict) BitmovinResponse[source]

Reprioritize Encoding

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

  • reprioritize_encoding_request (ReprioritizeEncodingRequest, required) – Reprioritization options

Returns

Id of the encoding

Return type

BitmovinResponse

reschedule(encoding_id: string_types, reschedule_encoding_request: RescheduleEncodingRequest, **kwargs: dict) BitmovinResponse[source]

Reschedule Encoding

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

  • reschedule_encoding_request (RescheduleEncodingRequest, required) – Rescheduling options

Returns

Id of the encoding

Return type

BitmovinResponse

start(encoding_id: string_types, start_encoding_request: StartEncodingRequest = None, **kwargs: dict) BitmovinResponse[source]

Start VoD Encoding

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

  • start_encoding_request (StartEncodingRequest) – Encoding Startup Options

Returns

Id of the encoding

Return type

BitmovinResponse

status(encoding_id: string_types, **kwargs: dict) Task[source]

Encoding Status

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Status of encoding

Return type

Task

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

Stop Encoding

Parameters

encoding_id (string_types, required) – Id of the encoding

Returns

Id of the encoding

Return type

BitmovinResponse

Module contents