com.bitmovin.api.sdk.encoding.encodings.streams.thumbnails

Class ThumbnailsApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.thumbnails.ThumbnailsApi

public class ThumbnailsApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
ThumbnailsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<ThumbnailsApi>	builder() Fluent builder for creating an instance of ThumbnailsApi
Thumbnail	create(String encodingId, String streamId, Thumbnail thumbnail) Add Thumbnail
BitmovinResponse	delete(String encodingId, String streamId, String thumbnailId) Delete Thumbnail
Thumbnail	get(String encodingId, String streamId, String thumbnailId) Thumbnail Details
PaginationResponse<Thumbnail>	list(String encodingId, String streamId) List Thumbnails
PaginationResponse<Thumbnail>	list(String encodingId, String streamId, ThumbnailListQueryParams queryParams) List Thumbnails

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customdata

public final CustomdataApi customdata

Constructor Detail

ThumbnailsApi

public ThumbnailsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<ThumbnailsApi> builder()

Fluent builder for creating an instance of ThumbnailsApi

create

public Thumbnail create(String encodingId,
                        String streamId,
                        Thumbnail thumbnail)
                 throws BitmovinException

Add Thumbnail

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

thumbnail - The Thumbnail to be added (required)

Returns:

Thumbnail

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String streamId,
                               String thumbnailId)
                        throws BitmovinException

Delete Thumbnail

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

thumbnailId - Id of the thumbnail. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public Thumbnail get(String encodingId,
                     String streamId,
                     String thumbnailId)
              throws BitmovinException

Thumbnail Details

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

thumbnailId - Id of the thumbnail. (required)

Returns:

Thumbnail

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Thumbnail> list(String encodingId,
                                          String streamId)
                                   throws BitmovinException

List Thumbnails

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

List<Thumbnail>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Thumbnail> list(String encodingId,
                                          String streamId,
                                          ThumbnailListQueryParams queryParams)
                                   throws BitmovinException

List Thumbnails

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<Thumbnail>

Throws:

BitmovinException - if fails to make API call