Class SpritesApi

Hierarchy

BaseAPI
- SpritesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SpritesApi(configuration: Configuration): SpritesApi

Overrides BaseAPI.constructor
- Defined in encoding/encodings/streams/sprites/SpritesApi.ts:17
Parameters
- configuration: Configuration
Returns SpritesApi

Properties

customdata

customdata: CustomdataApi

Protected restClient

restClient: RestClient

Methods

create

create(encodingId: string, streamId: string, sprite: Sprite): Promise<Sprite>

- Defined in encoding/encodings/streams/sprites/SpritesApi.ts:32
Parameters
- encodingId: string
- streamId: string
- Optional sprite: Sprite
Returns Promise<Sprite>

delete

delete(encodingId: string, streamId: string, spriteId: string): Promise<BitmovinResponse>

- Defined in encoding/encodings/streams/sprites/SpritesApi.ts:50
Parameters
- encodingId: string
- streamId: string
- spriteId: string
Returns Promise<BitmovinResponse>

get

get(encodingId: string, streamId: string, spriteId: string): Promise<Sprite>

- Defined in encoding/encodings/streams/sprites/SpritesApi.ts:69
Parameters
- encodingId: string
- streamId: string
- spriteId: string
Returns Promise<Sprite>

list

list(encodingId: string, streamId: string, queryParameters: SpriteListQueryParams | function): Promise<PaginationResponse<Sprite>>

- Defined in encoding/encodings/streams/sprites/SpritesApi.ts:88
Parameters
- encodingId: string
- streamId: string
- Optional queryParameters: SpriteListQueryParams | function
Returns Promise<PaginationResponse<Sprite>>

Generated using TypeDoc