Idrnd.FaceSdk.Settings Class Reference

Provides a way to control global FaceSDK configuration. More...

Static Public Member Functions
static void	SetNumThreads (uint numThreads, ThreadingLevel threadingLevel)
	Sets the maximum number of threads available for FaceSDK at the specified level. If 0 is passed, then the optimal number of threads is detected automatically (the same effect is achieved if setNumThreads is not called). Function call is equivalent to setting FACESDK_NUM_THREADS_PIPELINE, FACESDK_NUM_THREADS_ENGINE or FACESDK_NUM_THREADS_OPERATOR environment variable before loading FaceSDK library. Function call takes precedence over environment variables.
static void	SetOvBindThreads (bool ovBindThreads)
	Sets the CPU bind setting for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_BIND_THREADS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.
static void	SetOvNumThroughputStreams (int numOvThroughputStreams)
	Sets the number of CPU execution streams for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_NUM_THROUGHPUT_STREAMS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.
static void	SetOvMaxBatchSize (uint ovMaxBatchSize)
	Sets the maximum batch size for OpenVINO backend. This is not a hard limit (i.e. passing batches bigger than the limit will not cause an error), however setting this value to the target batch size will increase performance. Function call is equivalent to setting FACESDK_OV_MAX_BATCH_SIZE environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.
static void	SetEnableLogging (bool enableLogging)
	Sets whether to enable FaceSDK logging. Logging is enabled by default. Function call is equivalent to setting FACESDK_ENABLE_LOGGING environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Detailed Description

Provides a way to control global FaceSDK configuration.

Member Function Documentation

SetEnableLogging()

static void Idrnd.FaceSdk.Settings.SetEnableLogging ( bool  enableLogging )

static

Sets whether to enable FaceSDK logging. Logging is enabled by default. Function call is equivalent to setting FACESDK_ENABLE_LOGGING environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters

enableLogging

Whether to enable logging or not

SetNumThreads()

static void Idrnd.FaceSdk.Settings.SetNumThreads ( uint  numThreads, ThreadingLevel  threadingLevel  )

static

Sets the maximum number of threads available for FaceSDK at the specified level. If 0 is passed, then the optimal number of threads is detected automatically (the same effect is achieved if setNumThreads is not called). Function call is equivalent to setting FACESDK_NUM_THREADS_PIPELINE, FACESDK_NUM_THREADS_ENGINE or FACESDK_NUM_THREADS_OPERATOR environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters

numThreads	Maximum number of threads available for FaceSDK at the specified level
threadingLevel	Threading level to apply setting

SetOvBindThreads()

static void Idrnd.FaceSdk.Settings.SetOvBindThreads ( bool  ovBindThreads )

static

Sets the CPU bind setting for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_BIND_THREADS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters

ovBindThreads

Whether to bind execution threads to CPU physical cores or not

SetOvMaxBatchSize()

static void Idrnd.FaceSdk.Settings.SetOvMaxBatchSize ( uint  ovMaxBatchSize )

static

Sets the maximum batch size for OpenVINO backend. This is not a hard limit (i.e. passing batches bigger than the limit will not cause an error), however setting this value to the target batch size will increase performance. Function call is equivalent to setting FACESDK_OV_MAX_BATCH_SIZE environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters

ovMaxBatchSize

ovMaxBatchSize Maximum batch size

SetOvNumThroughputStreams()

static void Idrnd.FaceSdk.Settings.SetOvNumThroughputStreams ( int  numOvThroughputStreams )

static

Sets the number of CPU execution streams for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_NUM_THROUGHPUT_STREAMS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters

numOvThroughputStreams

ovNumThroughputStreams Number of CPU execution streams, valid values are -1 (auto-tune number of streams), 0 (use the default setting) and any positive value, other values are dropped without an error

---

The documentation for this class was generated from the following file:

• FaceSdkClr.cs