Class SpriteApi

Hierarchy

BaseAPI
- SpriteApi

Index

Constructors

constructor

Properties

restClient

Methods

Constructors

constructor

new SpriteApi(configuration: Configuration): SpriteApi

Overrides BaseAPI.constructor
- Defined in encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.ts:15
Parameters
- configuration: Configuration
Returns SpriteApi

Properties

Protected restClient

restClient: RestClient

Methods

create

create(manifestId: string, periodId: string, adaptationsetId: string, spriteRepresentation: SpriteRepresentation): Promise<SpriteRepresentation>

- Defined in encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.ts:30
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
- Optional spriteRepresentation: SpriteRepresentation
Returns Promise<SpriteRepresentation>

delete

delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.ts:50
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
- representationId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<SpriteRepresentation>

- Defined in encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.ts:71
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
- representationId: string
Returns Promise<SpriteRepresentation>

list

list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters: SpriteRepresentationListQueryParams | function): Promise<PaginationResponse<SpriteRepresentation>>

- Defined in encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.ts:92
Parameters
- manifestId: string
- periodId: string
- adaptationsetId: string
- Optional queryParameters: SpriteRepresentationListQueryParams | function
Returns Promise<PaginationResponse<SpriteRepresentation>>

Generated using TypeDoc