Class SpriteApi

Inheritance

System.Object

SpriteApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Encoding.Manifests.Dash.Periods.Adaptationsets.Representations.Sprite

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SpriteApi

Constructors

SpriteApi(IBitmovinApiClientFactory)

Declaration

public SpriteApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SpriteApi

Declaration

public static BitmovinApiBuilder<SpriteApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SpriteApi>

Methods

CreateAsync(String, String, String, SpriteRepresentation)

Add Sprite Representation

Declaration

public Task<SpriteRepresentation> CreateAsync(string manifestId, string periodId, string adaptationsetId, SpriteRepresentation spriteRepresentation)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the image adaptation set (required)
SpriteRepresentation	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.

Returns

Type	Description
System.Threading.Tasks.Task<SpriteRepresentation>

DeleteAsync(String, String, String, String)

Delete Sprite Representation

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId, string representationId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
System.String	representationId	Id of the Sprite representation to be deleted (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String, String, String)

Sprite Representation Details

Declaration

public Task<SpriteRepresentation> GetAsync(string manifestId, string periodId, string adaptationsetId, string representationId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
System.String	representationId	Id of the Sprite representation (required)

Returns

Type	Description
System.Threading.Tasks.Task<SpriteRepresentation>

ListAsync(String, String, String, Func<SpriteApi.ListQueryParams, SpriteApi.ListQueryParams>[])

List all Sprite Representations

Declaration

public Task<PaginationResponse<SpriteRepresentation>> ListAsync(string manifestId, string periodId, string adaptationsetId, params Func<SpriteApi.ListQueryParams, SpriteApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
System.Func<SpriteApi.ListQueryParams, SpriteApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<SpriteRepresentation>>