bitmovin_api_sdk.encoding.encodings.sidecars.webvtt package

Submodules

bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.web_vtt_sidecar_file_list_query_params module

class bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.web_vtt_sidecar_file_list_query_params.WebVttSidecarFileListQueryParams(offset=None, limit=None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.webvtt_api module

class bitmovin_api_sdk.encoding.encodings.sidecars.webvtt.webvtt_api.WebvttApi(**kwargs)[source]

Bases: BaseApi

create(encoding_id, web_vtt_sidecar_file, **kwargs)[source]

Add WebVTT sidecar file

Parameters:

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

  • web_vtt_sidecar_file (WebVttSidecarFile, required) – The WebVTT Sidecar file to be added

Returns:

WebVTT sidecar file

Return type:

WebVttSidecarFile

delete(encoding_id, sidecar_id, **kwargs)[source]

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, sidecar_id, **kwargs)[source]

WebVTT Sidecar Details

Parameters:

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

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

Returns:

WebVTT Subtitle file

Return type:

WebVttSidecarFile

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

List WebVTT sidecar files

Parameters:
Returns:

List of WebVTT sidecar files

Return type:

WebVttSidecarFile

Module contents