Class ThumbnailsApi

Inheritance

System.Object

ThumbnailsApi

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.Thumbnails

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ThumbnailsApi

Constructors

ThumbnailsApi(IBitmovinApiClientFactory)

Declaration

public ThumbnailsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ThumbnailsApi

Declaration

public static BitmovinApiBuilder<ThumbnailsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ThumbnailsApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(String, String, Thumbnail)

Add Thumbnail

Declaration

public Task<Thumbnail> CreateAsync(string encodingId, string streamId, Thumbnail thumbnail)

Parameters

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

Returns

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

DeleteAsync(String, String, String)

Delete Thumbnail

Declaration

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

Parameters

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

Returns

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

GetAsync(String, String, String)

Thumbnail Details

Declaration

public Task<Thumbnail> GetAsync(string encodingId, string streamId, string thumbnailId)

Parameters

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

Returns

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

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

List Thumbnails

Declaration

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

Parameters

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

Returns

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