Class SpritesApi

Inheritance

System.Object

SpritesApi

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.Encodings.Streams.Sprites

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SpritesApi

Constructors

SpritesApi(IBitmovinApiClientFactory)

Declaration

public SpritesApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SpritesApi

Declaration

public static BitmovinApiBuilder<SpritesApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SpritesApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(String, String, Sprite)

Add Sprite

Declaration

public Task<Sprite> CreateAsync(string encodingId, string streamId, Sprite sprite)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
Sprite	sprite	The Sprite to be added

Returns

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

DeleteAsync(String, String, String)

Delete Sprite

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId, string spriteId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	spriteId	Id of the sprite. (required)

Returns

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

GetAsync(String, String, String)

Sprite Details

Declaration

public Task<Sprite> GetAsync(string encodingId, string streamId, string spriteId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	spriteId	Id of the sprite configuration. (required)

Returns

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

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

List Sprites

Declaration

public Task<PaginationResponse<Sprite>> ListAsync(string encodingId, string streamId, params Func<SpritesApi.ListQueryParams, SpritesApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.Func<SpritesApi.ListQueryParams, SpritesApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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