bitmovin_api_sdk.encoding.encodings.streams.filters package

Submodules

bitmovin_api_sdk.encoding.encodings.streams.filters.filters_api module

class bitmovin_api_sdk.encoding.encodings.streams.filters.filters_api.FiltersApi(**kwargs)[source]

Bases: BaseApi

create(encoding_id: string_types, stream_id: string_types, stream_filter: list, **kwargs: dict) → StreamFilterList[source]

Add Filters to Stream

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • stream_filter (list[StreamFilter], required) – The Filters to be added

Returns

List of created stream filters

Return type

StreamFilterList

delete(encoding_id: string_types, stream_id: string_types, filter_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Specific Filter from Stream

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • filter_id (string_types, required) – Id of the filter

Returns

Id of the filter

Return type

BitmovinResponse

delete_all(encoding_id: string_types, stream_id: string_types, **kwargs: dict) → BitmovinResponseList[source]

Delete All Filters from Stream

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

Returns

List of ids of deleted stream filters

Return type

BitmovinResponseList

list(encoding_id: string_types, stream_id: string_types, query_params: StreamFilterListListQueryParams = None, **kwargs: dict) → StreamFilterList[source]

List the filters of a stream

Parameters

  • encoding_id (string_types, required) – Id of the encoding.

  • stream_id (string_types, required) – Id of the stream.

  • query_params (StreamFilterListListQueryParams) – Query parameters

Returns

List of stream filters

Return type

StreamFilterList

bitmovin_api_sdk.encoding.encodings.streams.filters.stream_filter_list_list_query_params module

class bitmovin_api_sdk.encoding.encodings.streams.filters.stream_filter_list_list_query_params.StreamFilterListListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map
property openapi_types

Module contents