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

Class FiltersApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.filters.FiltersApi

public class FiltersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FiltersApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<FiltersApi>	builder() Fluent builder for creating an instance of FiltersApi
StreamFilterList	create(String encodingId, String streamId, List<StreamFilter> streamFilter) Add Filters to Stream
BitmovinResponse	delete(String encodingId, String streamId, String filterId) Delete Specific Filter from Stream
BitmovinResponseList	deleteAll(String encodingId, String streamId) Delete All Filters from Stream
StreamFilterList	list(String encodingId, String streamId) List the filters of a stream
StreamFilterList	list(String encodingId, String streamId, StreamFilterListListQueryParams queryParams) List the filters of a stream

Methods inherited from class java.lang.Object

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

Constructor Detail

FiltersApi

public FiltersApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<FiltersApi> builder()

Fluent builder for creating an instance of FiltersApi

create

public StreamFilterList create(String encodingId,
                               String streamId,
                               List<StreamFilter> streamFilter)
                        throws BitmovinException

Add Filters to Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

streamFilter - The Filters to be added (required)

Returns:

StreamFilterList

Throws:

BitmovinException - if fails to make API call

delete

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

Delete Specific Filter from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

filterId - Id of the filter (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

deleteAll

public BitmovinResponseList deleteAll(String encodingId,
                                      String streamId)
                               throws BitmovinException

Delete All Filters from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

BitmovinResponseList

Throws:

BitmovinException - if fails to make API call

list

public StreamFilterList list(String encodingId,
                             String streamId)
                      throws BitmovinException

List the filters of a stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

StreamFilterList

Throws:

BitmovinException - if fails to make API call

list

public StreamFilterList list(String encodingId,
                             String streamId,
                             StreamFilterListListQueryParams queryParams)
                      throws BitmovinException

List the filters of a stream

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:

StreamFilterList

Throws:

BitmovinException - if fails to make API call