Class ObjectDetectionApi

Inheritance

System.Object

ObjectDetectionApi

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.MachineLearning.ObjectDetection

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ObjectDetectionApi

Constructors

ObjectDetectionApi(IBitmovinApiClientFactory)

Declaration

public ObjectDetectionApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ObjectDetectionApi

Declaration

public static BitmovinApiBuilder<ObjectDetectionApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ObjectDetectionApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Results

Declaration

public ResultsApi Results { get; }

Property Value

Type	Description
ResultsApi

Methods

CreateAsync(String, ObjectDetectionConfiguration)

Add object detection configuration to an encoding

Declaration

public Task<ObjectDetectionConfiguration> CreateAsync(string encodingId, ObjectDetectionConfiguration objectDetectionConfiguration)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
ObjectDetectionConfiguration	objectDetectionConfiguration	The object detection configuration to be created

Returns

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

DeleteAsync(String, String)

Delete object detection configuration

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string objectDetectionId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
System.String	objectDetectionId	Id of the object detection configuration to be deleted (required)

Returns

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

GetAsync(String, String)

Get object detection configuration details

Declaration

public Task<ObjectDetectionConfiguration> GetAsync(string encodingId, string objectDetectionId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding (required)
System.String	objectDetectionId	Id of the object detection configuration (required)

Returns

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

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

List object detection configurations of an encoding

Declaration

public Task<PaginationResponse<ObjectDetectionConfiguration>> ListAsync(string encodingId, params Func<ObjectDetectionApi.ListQueryParams, ObjectDetectionApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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