bitmovin_api_sdk.encoding.encodings.streams.captions.cea.scc package

Subpackages

Submodules

bitmovin_api_sdk.encoding.encodings.streams.captions.cea.scc.scc_api module

class bitmovin_api_sdk.encoding.encodings.streams.captions.cea.scc.scc_api.SccApi(**kwargs)[source]

Bases: BaseApi

create(encoding_id: string_types, stream_id: string_types, scc_caption: SccCaption, **kwargs: dict) → SccCaption[source]

Embed SCC captions as 608/708 into Stream

Parameters

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

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

  • scc_caption (SccCaption, required) – The SCC captions to be embedded as 607/708 into Stream

Returns

Caption resource

Return type

SccCaption

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

Delete SCC captions as 608/708 from Stream

Parameters

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

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

  • captions_id (string_types, required) – Id of the caption.

Returns

Id of the caption

Return type

BitmovinResponse

get(encoding_id: string_types, stream_id: string_types, captions_id: string_types, **kwargs: dict) → SccCaption[source]

Embed SCC captions as 608/708 Details

Parameters

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

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

  • captions_id (string_types, required) – Id of the caption.

Returns

Caption

Return type

SccCaption

list(encoding_id: string_types, stream_id: string_types, query_params: SccCaptionListQueryParams = None, **kwargs: dict) → SccCaption[source]

List SCC captions as 608/708 from Stream

Parameters

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

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

  • query_params (SccCaptionListQueryParams) – Query parameters

Returns

List of caption configurations

Return type

SccCaption

bitmovin_api_sdk.encoding.encodings.streams.captions.cea.scc.scc_caption_list_query_params module

class bitmovin_api_sdk.encoding.encodings.streams.captions.cea.scc.scc_caption_list_query_params.SccCaptionListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

Module contents