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=None, limit=None, include_total_count=None, sort=None, type_=None, status=None, cloud_region=None, selected_cloud_region=None, encoder_version=None, selected_encoder_version=None, selected_encoding_mode=None, name=None, search=None, created_at_newer_than=None, created_at_older_than=None, started_at_newer_than=None, started_at_older_than=None, finished_at_newer_than=None, finished_at_older_than=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, **kwargs)[source]

Create Encoding

Parameters:

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

Returns:

Encoding

Return type:

Encoding

delete(encoding_id, **kwargs)[source]

Delete Encoding

Parameters:

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

Returns:

Id of the encoding

Return type:

BitmovinResponse

get(encoding_id, **kwargs)[source]

Encoding Details

Parameters:

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

Returns:

Encoding

Return type:

Encoding

get_start_request(encoding_id, **kwargs)[source]

Encoding Start Details

Parameters:

encoding_id (string_types, required) – Id of the encoding

Returns:

Service specific result

Return type:

StartEncodingRequest

list(query_params=None, **kwargs)[source]

List all Encodings

Parameters:

query_params (EncodingListQueryParams) – Query parameters

Returns:

List of encodings

Return type:

Encoding

reprioritize(encoding_id, reprioritize_encoding_request, **kwargs)[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, reschedule_encoding_request, **kwargs)[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, start_encoding_request=None, **kwargs)[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, **kwargs)[source]

Encoding Status

Parameters:

encoding_id (string_types, required) – Id of the encoding

Returns:

Status of encoding

Return type:

Task

stop(encoding_id, **kwargs)[source]

Stop Encoding

Parameters:

encoding_id (string_types, required) – Id of the encoding

Returns:

Id of the encoding

Return type:

BitmovinResponse

Module contents