bitmovin_api_sdk.encoding.encodings.sidecars package

Subpackages

• bitmovin_api_sdk.encoding.encodings.sidecars.customdata package
  • Submodules
  • bitmovin_api_sdk.encoding.encodings.sidecars.customdata.customdata_api module
  • Module contents
• bitmovin_api_sdk.encoding.encodings.sidecars.webvtt package
  • Submodules
  • bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.web_vtt_sidecar_file_list_query_params module
  • bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.webvtt_api module
  • Module contents

Submodules

bitmovin_api_sdk.encoding.encodings.sidecars.sidecar_file_list_query_params module

class bitmovin_api_sdk.encoding.encodings.sidecars.sidecar_file_list_query_params.SidecarFileListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)

Bases: object

property attribute_map

property openapi_types

bitmovin_api_sdk.encoding.encodings.sidecars.sidecars_api module

class bitmovin_api_sdk.encoding.encodings.sidecars.sidecars_api.SidecarsApi(**kwargs)

Bases: BaseApi

create(encoding_id: string_types, sidecar_file: SidecarFile, **kwargs: dict) → SidecarFile

Add Sidecar

Parameters

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

• sidecar_file (SidecarFile, required) – The Sidecar to be added

Returns

Sidecar

Return type

SidecarFile

delete(encoding_id: string_types, sidecar_id: string_types, **kwargs: dict) → BitmovinResponse

Delete Sidecar

Parameters

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

• sidecar_id (string_types, required) – Id of the sidecar.

Returns

Id of the sidecar

Return type

BitmovinResponse

get(encoding_id: string_types, sidecar_id: string_types, **kwargs: dict) → SidecarFile

Sidecar Details

Parameters

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

• sidecar_id (string_types, required) – Id of the sidecar.

Returns

Subtitle

Return type

SidecarFile

list(encoding_id: string_types, query_params: SidecarFileListQueryParams = None, **kwargs: dict) → SidecarFile

List Sidecars

Parameters

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

• query_params (SidecarFileListQueryParams) – Query parameters

Returns

List of subtitles

Return type

SidecarFile

Module contents