bitmovin_api_sdk.encoding.manifests.hls.media.custom_tags package

Submodules

bitmovin_api_sdk.encoding.manifests.hls.media.custom_tags.custom_tag_list_query_params module

class bitmovin_api_sdk.encoding.manifests.hls.media.custom_tags.custom_tag_list_query_params.CustomTagListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.manifests.hls.media.custom_tags.custom_tags_api module

class bitmovin_api_sdk.encoding.manifests.hls.media.custom_tags.custom_tags_api.CustomTagsApi(**kwargs)[source]

Bases: BaseApi

create(manifest_id: string_types, media_id: string_types, custom_tag: CustomTag, **kwargs: dict) → CustomTag[source]

Add Custom Tag to a Audio Media or a Subtitle media

Parameters

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

  • media_id (string_types, required) – Id of the media.

  • custom_tag (CustomTag, required) – The Custom Tag to be added

Returns

Custom Tag details

Return type

CustomTag

delete(manifest_id: string_types, media_id: string_types, custom_tag_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Custom Tag

Parameters

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

  • media_id (string_types, required) – Id of the media.

  • custom_tag_id (string_types, required) – Id of the custom tag.

Returns

Id of the custom tag

Return type

BitmovinResponse

get(manifest_id: string_types, media_id: string_types, custom_tag_id: string_types, **kwargs: dict) → CustomTag[source]

Custom Tag Details

Parameters

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

  • media_id (string_types, required) – Id of the media

  • custom_tag_id (string_types, required) – Id of the custom tag.

Returns

Custom tag details

Return type

CustomTag

list(manifest_id: string_types, media_id: string_types, query_params: CustomTagListQueryParams = None, **kwargs: dict) → CustomTag[source]

List all Custom Tags of a Audio media or a Subtitle media

Parameters

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

  • media_id (string_types, required) – Id of the media.

  • query_params (CustomTagListQueryParams) – Query parameters

Returns

Custom Tags

Return type

CustomTag

Module contents