bitmovin_api_sdk.encoding.manifests.dash.periods.custom_xml_elements package

Submodules

bitmovin_api_sdk.encoding.manifests.dash.periods.custom_xml_elements.custom_xml_element_list_query_params module

class bitmovin_api_sdk.encoding.manifests.dash.periods.custom_xml_elements.custom_xml_element_list_query_params.CustomXmlElementListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.manifests.dash.periods.custom_xml_elements.custom_xml_elements_api module

class bitmovin_api_sdk.encoding.manifests.dash.periods.custom_xml_elements.custom_xml_elements_api.CustomXmlElementsApi(**kwargs)[source]

Bases: BaseApi

create(manifest_id: string_types, period_id: string_types, custom_xml_element: CustomXmlElement, **kwargs: dict) → CustomXmlElement[source]

Add Custom XML Element to Period

Parameters

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

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

  • custom_xml_element (CustomXmlElement, required) – Data of the custom XML element to be added to the period

Returns

Custom XML Element

Return type

CustomXmlElement

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

Delete Custom XML Element

Parameters

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

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

  • custom_xml_element_id (string_types, required) – Id of the Custom XML Element

Returns

Id of the Custom XML Element

Return type

BitmovinResponse

get(manifest_id: string_types, period_id: string_types, custom_xml_element_id: string_types, **kwargs: dict) → CustomXmlElement[source]

Custom XML Element Details

Parameters

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

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

  • custom_xml_element_id (string_types, required) – Id of the Custom XML Element

Returns

Custom XML Element details

Return type

CustomXmlElement

list(manifest_id: string_types, period_id: string_types, query_params: CustomXmlElementListQueryParams = None, **kwargs: dict) → CustomXmlElement[source]

List all Custom XML Elements of Period

Parameters

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

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

  • query_params (CustomXmlElementListQueryParams) – Query parameters

Returns

List of Custom XML Elements

Return type

CustomXmlElement

Module contents