Show / Hide Table of Contents

Class WatermarkApi

Inheritance
System.Object
WatermarkApi
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.Filters.Watermark
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class WatermarkApi

Constructors

WatermarkApi(IBitmovinApiClientFactory)

Declaration
public WatermarkApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of WatermarkApi

Declaration
public static BitmovinApiBuilder<WatermarkApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<WatermarkApi>

Customdata

Declaration
public CustomdataApi Customdata { get; }
Property Value
Type Description
CustomdataApi

Methods

CreateAsync(WatermarkFilter)

Create Watermark Filter

Declaration
public Task<WatermarkFilter> CreateAsync(WatermarkFilter watermarkFilter)
Parameters
Type Name Description
WatermarkFilter watermarkFilter

The Watermark Filter to be created. Only one horizontal and one vertical distance parameter is allowed, either top or bottom, and either left or right. See example body.

Returns
Type Description
System.Threading.Tasks.Task<WatermarkFilter>

DeleteAsync(String)

Delete Watermark Filter

Declaration
public Task<BitmovinResponse> DeleteAsync(string filterId)
Parameters
Type Name Description
System.String filterId

Id of the Watermark Filter. (required)

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

GetAsync(String)

Watermark Filter Details

Declaration
public Task<WatermarkFilter> GetAsync(string filterId)
Parameters
Type Name Description
System.String filterId

Id of the Watermark Filter. (required)

Returns
Type Description
System.Threading.Tasks.Task<WatermarkFilter>

ListAsync(Func<WatermarkApi.ListQueryParams, WatermarkApi.ListQueryParams>[])

List Watermark Filters

Declaration
public Task<PaginationResponse<WatermarkFilter>> ListAsync(params Func<WatermarkApi.ListQueryParams, WatermarkApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.Func<WatermarkApi.ListQueryParams, WatermarkApi.ListQueryParams>[] queryParams

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

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<WatermarkFilter>>
Back to top Generated by DocFX