public class SpritesApi extends Object
Modifier and Type | Field and Description |
---|---|
CustomdataApi |
customdata |
Constructor and Description |
---|
SpritesApi(BitmovinApiClientFactory clientFactory) |
Modifier and Type | Method and Description |
---|---|
static BitmovinApiBuilder<SpritesApi> |
builder()
Fluent builder for creating an instance of SpritesApi
|
Sprite |
create(String encodingId,
String streamId,
Sprite sprite)
Add Sprite
|
BitmovinResponse |
delete(String encodingId,
String streamId,
String spriteId)
Delete Sprite
|
Sprite |
get(String encodingId,
String streamId,
String spriteId)
Sprite Details
|
PaginationResponse<Sprite> |
list(String encodingId,
String streamId)
List Sprites
|
PaginationResponse<Sprite> |
list(String encodingId,
String streamId,
SpriteListQueryParams queryParams)
List Sprites
|
public final CustomdataApi customdata
public SpritesApi(BitmovinApiClientFactory clientFactory)
public static BitmovinApiBuilder<SpritesApi> builder()
public Sprite create(String encodingId, String streamId, Sprite sprite) throws BitmovinException
encodingId
- Id of the encoding. (required)streamId
- Id of the stream. (required)sprite
- The Sprite to be added (required)BitmovinException
- if fails to make API callpublic BitmovinResponse delete(String encodingId, String streamId, String spriteId) throws BitmovinException
encodingId
- Id of the encoding. (required)streamId
- Id of the stream. (required)spriteId
- Id of the sprite. (required)BitmovinException
- if fails to make API callpublic Sprite get(String encodingId, String streamId, String spriteId) throws BitmovinException
encodingId
- Id of the encoding. (required)streamId
- Id of the stream. (required)spriteId
- Id of the sprite configuration. (required)BitmovinException
- if fails to make API callpublic PaginationResponse<Sprite> list(String encodingId, String streamId) throws BitmovinException
encodingId
- Id of the encoding. (required)streamId
- Id of the stream. (required)BitmovinException
- if fails to make API callpublic PaginationResponse<Sprite> list(String encodingId, String streamId, SpriteListQueryParams queryParams) throws BitmovinException
encodingId
- Id of the encoding. (required)streamId
- Id of the stream. (required)queryParams
- The query parameters for sorting, filtering and paging options (optional)BitmovinException
- if fails to make API callCopyright © 2019. All rights reserved.