# coding: utf-8
from __future__ import absolute_import
from bitmovin_api_sdk.common import BaseApi, BitmovinApiLoggerBase
from bitmovin_api_sdk.common.poscheck import poscheck_except
from bitmovin_api_sdk.models.adaptation_set import AdaptationSet
from bitmovin_api_sdk.models.bitmovin_response import BitmovinResponse
from bitmovin_api_sdk.models.image_adaptation_set import ImageAdaptationSet
from bitmovin_api_sdk.models.response_envelope import ResponseEnvelope
from bitmovin_api_sdk.models.response_error import ResponseError
from bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.image.image_adaptation_set_list_query_params import ImageAdaptationSetListQueryParams
[docs]class ImageApi(BaseApi):
@poscheck_except(2)
def __init__(self, api_key, tenant_org_id=None, base_url=None, logger=None):
# type: (str, str, str, BitmovinApiLoggerBase) -> None
super(ImageApi, self).__init__(
api_key=api_key,
tenant_org_id=tenant_org_id,
base_url=base_url,
logger=logger
)
[docs] def create(self, manifest_id, period_id, image_adaptation_set, **kwargs):
# type: (string_types, string_types, ImageAdaptationSet, dict) -> ImageAdaptationSet
"""Add Image AdaptationSet
:param manifest_id: Id of the manifest
:type manifest_id: string_types, required
:param period_id: Id of the period
:type period_id: string_types, required
:param image_adaptation_set: The image adaptation set to be added to the period
:type image_adaptation_set: ImageAdaptationSet, required
:return: ImageAdaptationSet
:rtype: ImageAdaptationSet
"""
return self.api_client.post(
'/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image',
image_adaptation_set,
path_params={'manifest_id': manifest_id, 'period_id': period_id},
type=ImageAdaptationSet,
**kwargs
)
[docs] def delete(self, manifest_id, period_id, adaptationset_id, **kwargs):
# type: (string_types, string_types, string_types, dict) -> BitmovinResponse
"""Delete Image AdaptationSet
:param manifest_id: Id of the manifest
:type manifest_id: string_types, required
:param period_id: Id of the period
:type period_id: string_types, required
:param adaptationset_id: Id of the audio adaptation set to be deleted
:type adaptationset_id: string_types, required
:return: Id of the Image AdaptationSet
:rtype: BitmovinResponse
"""
return self.api_client.delete(
'/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image/{adaptationset_id}',
path_params={'manifest_id': manifest_id, 'period_id': period_id, 'adaptationset_id': adaptationset_id},
type=BitmovinResponse,
**kwargs
)
[docs] def get(self, manifest_id, period_id, adaptationset_id, **kwargs):
# type: (string_types, string_types, string_types, dict) -> ImageAdaptationSet
"""Image AdaptationSet Details
:param manifest_id: Id of the manifest
:type manifest_id: string_types, required
:param period_id: Id of the period
:type period_id: string_types, required
:param adaptationset_id: Id of the Image adaptation set
:type adaptationset_id: string_types, required
:return: Image AdaptationSet details
:rtype: ImageAdaptationSet
"""
return self.api_client.get(
'/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image/{adaptationset_id}',
path_params={'manifest_id': manifest_id, 'period_id': period_id, 'adaptationset_id': adaptationset_id},
type=ImageAdaptationSet,
**kwargs
)
[docs] def list(self, manifest_id, period_id, query_params=None, **kwargs):
# type: (string_types, string_types, ImageAdaptationSetListQueryParams, dict) -> ImageAdaptationSet
"""List all Image AdaptationSets
:param manifest_id: Id of the manifest
:type manifest_id: string_types, required
:param period_id: Id of the period
:type period_id: string_types, required
:param query_params: Query parameters
:type query_params: ImageAdaptationSetListQueryParams
:return: List of Image AdaptationSets
:rtype: ImageAdaptationSet
"""
return self.api_client.get(
'/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image',
path_params={'manifest_id': manifest_id, 'period_id': period_id},
query_params=query_params,
pagination_response=True,
type=ImageAdaptationSet,
**kwargs
)