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

Submodules

bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.sprite.sprite_api module

class bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.sprite.sprite_api.SpriteApi(**kwargs)[source]

Bases: BaseApi

create(manifest_id, period_id, adaptationset_id, sprite_representation, **kwargs)[source]

Add Sprite 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 image adaptation set

  • sprite_representation (SpriteRepresentation, required) – The Sprite representation to be added to the adaptation set. Note that the adaptation set has to be an image adaptation set. Only supported for sprites generated with encoder version `2.76.0` or above.

Returns:

Sprite representation

Return type:

SpriteRepresentation

delete(manifest_id, period_id, adaptationset_id, representation_id, **kwargs)[source]

Delete Sprite 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 Sprite representation to be deleted

Returns:

Id of the Sprite Representation

Return type:

BitmovinResponse

get(manifest_id, period_id, adaptationset_id, representation_id, **kwargs)[source]

Sprite 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 Sprite representation

Returns:

Sprite Representation details

Return type:

SpriteRepresentation

list(manifest_id, period_id, adaptationset_id, query_params=None, **kwargs)[source]

List all Sprite 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 (SpriteRepresentationListQueryParams) – Query parameters

Returns:

List of Sprite Representations

Return type:

SpriteRepresentation

bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.sprite.sprite_representation_list_query_params module

class bitmovin_api_sdk.encoding.manifests.dash.periods.adaptationsets.representations.sprite.sprite_representation_list_query_params.SpriteRepresentationListQueryParams(offset=None, limit=None)[source]

Bases: object

property attribute_map
property openapi_types

Module contents