bitmovin_api_sdk.encoding.encodings.streams.burn_in_subtitles.srt package

Submodules

bitmovin_api_sdk.encoding.encodings.streams.burn_in_subtitles.srt.burn_in_subtitle_srt_list_query_params module

class bitmovin_api_sdk.encoding.encodings.streams.burn_in_subtitles.srt.burn_in_subtitle_srt_list_query_params.BurnInSubtitleSrtListQueryParams(offset=None, limit=None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.encodings.streams.burn_in_subtitles.srt.srt_api module

class bitmovin_api_sdk.encoding.encodings.streams.burn_in_subtitles.srt.srt_api.SrtApi(**kwargs)[source]

Bases: BaseApi

create(encoding_id, stream_id, burn_in_subtitle_srt, **kwargs)[source]

Burn-In SRT Subtitle into Stream

Parameters:

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

  • stream_id (string_types, required) – Id of the stream.

  • burn_in_subtitle_srt (BurnInSubtitleSrt, required) – The Burn-In SRT Subtitle to be added

Returns:

Burn-in SRT subtitle details

Return type:

BurnInSubtitleSrt

delete(encoding_id, stream_id, subtitle_id, **kwargs)[source]

Delete Burn-In SRT Subtitle from Stream

Parameters:

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

  • stream_id (string_types, required) – Id of the stream.

  • subtitle_id (string_types, required) – Id of the burn-in subtitle.

Returns:

Id of the burn-in SRT subtitle

Return type:

BitmovinResponse

get(encoding_id, stream_id, subtitle_id, **kwargs)[source]

Get Burn-In SRT Subtitle Details

Parameters:

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

  • stream_id (string_types, required) – Id of the stream.

  • subtitle_id (string_types, required) – Id of the burn-in subtitle.

Returns:

Burn-in SRT subtitle details

Return type:

BurnInSubtitleSrt

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

List the Burn-In SRT subtitles of a stream

Parameters:

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

  • stream_id (string_types, required) – Id of the stream.

  • query_params (BurnInSubtitleSrtListQueryParams) – Query parameters

Returns:

List of burn-in SRT configurations

Return type:

BurnInSubtitleSrt

Module contents