Interface IImageSettings

Namespace

Huddly.Sdk.CameraControl

Assembly

Huddly.Sdk.dll

public interface IImageSettings

Methods

GetBrightness(CancellationToken)

Get the device brightness setting value

Task<Result<double>> GetBrightness(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<double>>

A result with the current brightness normalized to the range [-1.0, 1.0]

GetFaceBasedExposure(CancellationToken)

Get the device FaceBasedExposure setting value

Task<Result<Toggle>> GetFaceBasedExposure(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<Toggle>>

A Toggle Result

GetPerspectiveCorrection(CancellationToken)

Get the device perspective correction mode

Task<Result<PerspectiveCorrection>> GetPerspectiveCorrection(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<PerspectiveCorrection>>

A result with the current perspective correction mode

GetSaturation(CancellationToken)

Get the device saturation setting value

Task<Result<double>> GetSaturation(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<double>>

A result with the current value normalized to the range [-1.0, 1.0]

PersistCurrentImageSettings(CancellationToken)

Persist the current brightness and saturation values in the active camera storage slot

Task<Result> PersistCurrentImageSettings(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

RestorePersistentImageSettings(CancellationToken)

Restore the brightness and saturation values from the active camera storage slot

Task<Result> RestorePersistentImageSettings(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetBrightness(double, CancellationToken)

Set the device brightness setting value. To persist the set value, call PersistCurrentImageSettings(CancellationToken).

Task<Result> SetBrightness(double value, CancellationToken ct = default)

Parameters

value double

The new value, in the range [-1.0, 1.0]

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetFaceBasedExposure(Toggle, CancellationToken)

Set and persist the device FaceBasedExposure setting value

Task<Result> SetFaceBasedExposure(Toggle value, CancellationToken ct = default)

Parameters

value Toggle

The new value. For accepted values, query GetSupportedFeatures(CancellationToken)

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetPerspectiveCorrection(PerspectiveCorrection, CancellationToken)

Set device perspective correction mode

[Obsolete("Not supported. PerspectiveCorrection is always on for Crew/L1/S1 firmware >= 1.8.11.")]
Task<Result> SetPerspectiveCorrection(PerspectiveCorrection value, CancellationToken ct = default)

Parameters

value PerspectiveCorrection

The new value

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetSaturation(double, CancellationToken)

Set the device saturation setting value. To persist the set value, call PersistCurrentImageSettings(CancellationToken).

Task<Result> SetSaturation(double value, CancellationToken ct = default)

Parameters

value double

The new value, in the range [-1.0, 1.0]

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure