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
CancellationTokenA cancellation token
Returns
GetFaceBasedExposure(CancellationToken)
Get the device FaceBasedExposure setting value
Task<Result<Toggle>> GetFaceBasedExposure(CancellationToken ct = default)
Parameters
ct
CancellationTokenA cancellation token
Returns
GetPerspectiveCorrection(CancellationToken)
Get the device perspective correction mode
Task<Result<PerspectiveCorrection>> GetPerspectiveCorrection(CancellationToken ct = default)
Parameters
ct
CancellationTokenA 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
CancellationTokenA cancellation token
Returns
PersistCurrentImageSettings(CancellationToken)
Persist the current brightness and saturation values in the active camera storage slot
Task<Result> PersistCurrentImageSettings(CancellationToken ct = default)
Parameters
ct
CancellationTokenA cancellation token
Returns
RestorePersistentImageSettings(CancellationToken)
Restore the brightness and saturation values from the active camera storage slot
Task<Result> RestorePersistentImageSettings(CancellationToken ct = default)
Parameters
ct
CancellationTokenA cancellation token
Returns
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
doubleThe new value, in the range [-1.0, 1.0]
ct
CancellationTokenA cancellation token
Returns
SetFaceBasedExposure(Toggle, CancellationToken)
Set and persist the device FaceBasedExposure setting value
Task<Result> SetFaceBasedExposure(Toggle value, CancellationToken ct = default)
Parameters
value
ToggleThe new value. For accepted values, query GetSupportedFeatures(CancellationToken)
ct
CancellationTokenA cancellation token
Returns
SetPerspectiveCorrection(PerspectiveCorrection, CancellationToken)
Set device perspective correction mode
Task<Result> SetPerspectiveCorrection(PerspectiveCorrection value, CancellationToken ct = default)
Parameters
value
PerspectiveCorrectionThe new value
ct
CancellationTokenA cancellation token
Returns
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
doubleThe new value, in the range [-1.0, 1.0]
ct
CancellationTokenA cancellation token