bitmovin_api_sdk.encoding.encodings.streams.sprites package

Subpackages

Submodules

bitmovin_api_sdk.encoding.encodings.streams.sprites.sprite_list_query_params module

class bitmovin_api_sdk.encoding.encodings.streams.sprites.sprite_list_query_params.SpriteListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

bitmovin_api_sdk.encoding.encodings.streams.sprites.sprites_api module

class bitmovin_api_sdk.encoding.encodings.streams.sprites.sprites_api.SpritesApi(**kwargs)[source]

Bases: BaseApi

create(encoding_id: string_types, stream_id: string_types, sprite: Sprite, **kwargs: dict) → Sprite[source]

Add Sprite

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • sprite (Sprite, required) – The Sprite to be added

Returns

Sprite details

Return type

Sprite

delete(encoding_id: string_types, stream_id: string_types, sprite_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Sprite

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • sprite_id (string_types, required) – Id of the sprite.

Returns

Id of the sprite

Return type

BitmovinResponse

get(encoding_id: string_types, stream_id: string_types, sprite_id: string_types, **kwargs: dict) → Sprite[source]

Sprite Details

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • sprite_id (string_types, required) – Id of the sprite configuration.

Returns

Sprite details

Return type

Sprite

list(encoding_id: string_types, stream_id: string_types, query_params: SpriteListQueryParams = None, **kwargs: dict) → Sprite[source]

List Sprites

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • query_params (SpriteListQueryParams) – Query parameters

Returns

List of sprites

Return type

Sprite

Module contents