bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.vtt package

Submodules

bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.vtt.dash_vtt_representation_list_query_params module

class bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.vtt.dash_vtt_representation_list_query_params.DashVttRepresentationListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.vtt.vtt_api module

class bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.vtt.vtt_api.VttApi(**kwargs)[source]

Bases: BaseApi

create(manifest_id: string_types, period_id: string_types, adaptationset_id: string_types, dash_vtt_representation: DashVttRepresentation, **kwargs: dict) → DashVttRepresentation[source]

Add VTT Representation

Parameters

  • manifest_id (string_types, required) – Id of the manifest

  • period_id (string_types, required) – Id of the period

  • adaptationset_id (string_types, required) – Id of the adaptation set

  • dash_vtt_representation (DashVttRepresentation, required) – The VTT representation to be added to the adaptation set

Returns

VTT representation

Return type

DashVttRepresentation

delete(manifest_id: string_types, period_id: string_types, adaptationset_id: string_types, representation_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete VTT Representation

Parameters

  • manifest_id (string_types, required) – Id of the manifest

  • period_id (string_types, required) – Id of the period

  • adaptationset_id (string_types, required) – Id of the adaptation set

  • representation_id (string_types, required) – Id of the VTT representation to be deleted

Returns

Id of the VTT Representation

Return type

BitmovinResponse

get(manifest_id: string_types, period_id: string_types, adaptationset_id: string_types, representation_id: string_types, **kwargs: dict) → DashVttRepresentation[source]

VTT Representation Details

Parameters

  • manifest_id (string_types, required) – Id of the manifest

  • period_id (string_types, required) – Id of the period

  • adaptationset_id (string_types, required) – Id of the adaptation set

  • representation_id (string_types, required) – Id of the VTT representation

Returns

VTT Representation details

Return type

DashVttRepresentation

list(manifest_id: string_types, period_id: string_types, adaptationset_id: string_types, query_params: DashVttRepresentationListQueryParams = None, **kwargs: dict) → DashVttRepresentation[source]

List all VTT Representations

Parameters

  • manifest_id (string_types, required) – Id of the manifest

  • period_id (string_types, required) – Id of the period

  • adaptationset_id (string_types, required) – Id of the adaptation set

  • query_params (DashVttRepresentationListQueryParams) – Query parameters

Returns

List of VTT Representations

Return type

DashVttRepresentation

Module contents