public class SpriteApi extends Object
Constructor and Description |
---|
SpriteApi(BitmovinApiClientFactory clientFactory) |
Modifier and Type | Method and Description |
---|---|
static BitmovinApiBuilder<SpriteApi> |
builder()
Fluent builder for creating an instance of SpriteApi
|
SpriteRepresentation |
create(String manifestId,
String periodId,
String adaptationsetId,
SpriteRepresentation spriteRepresentation)
Add Sprite Representation
|
BitmovinResponse |
delete(String manifestId,
String periodId,
String adaptationsetId,
String representationId)
Delete Sprite Representation
|
SpriteRepresentation |
get(String manifestId,
String periodId,
String adaptationsetId,
String representationId)
Sprite Representation Details
|
PaginationResponse<SpriteRepresentation> |
list(String manifestId,
String periodId,
String adaptationsetId)
List all Sprite Representations
|
PaginationResponse<SpriteRepresentation> |
list(String manifestId,
String periodId,
String adaptationsetId,
SpriteRepresentationListQueryParams queryParams)
List all Sprite Representations
|
public SpriteApi(BitmovinApiClientFactory clientFactory)
public static BitmovinApiBuilder<SpriteApi> builder()
public SpriteRepresentation create(String manifestId, String periodId, String adaptationsetId, SpriteRepresentation spriteRepresentation) throws BitmovinException
manifestId
- Id of the manifest (required)periodId
- Id of the period (required)adaptationsetId
- Id of the adaptation set (required)spriteRepresentation
- 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. (required)BitmovinException
- if fails to make API callpublic BitmovinResponse delete(String manifestId, String periodId, String adaptationsetId, String representationId) throws BitmovinException
manifestId
- Id of the manifest (required)periodId
- Id of the period (required)adaptationsetId
- Id of the adaptation set (required)representationId
- Id of the Sprite representation to be deleted (required)BitmovinException
- if fails to make API callpublic SpriteRepresentation get(String manifestId, String periodId, String adaptationsetId, String representationId) throws BitmovinException
manifestId
- Id of the manifest (required)periodId
- Id of the period (required)adaptationsetId
- Id of the adaptation set (required)representationId
- Id of the Sprite representation (required)BitmovinException
- if fails to make API callpublic PaginationResponse<SpriteRepresentation> list(String manifestId, String periodId, String adaptationsetId) throws BitmovinException
manifestId
- Id of the manifest (required)periodId
- Id of the period (required)adaptationsetId
- Id of the adaptation set (required)BitmovinException
- if fails to make API callpublic PaginationResponse<SpriteRepresentation> list(String manifestId, String periodId, String adaptationsetId, SpriteRepresentationListQueryParams queryParams) throws BitmovinException
manifestId
- Id of the manifest (required)periodId
- Id of the period (required)adaptationsetId
- Id of the adaptation set (required)queryParams
- The query parameters for sorting, filtering and paging options (optional)BitmovinException
- if fails to make API callCopyright © 2021. All rights reserved.