Interface IFramingZoneControl

Namespace

Huddly.Sdk.FramingZoneCore

Assembly

Huddly.Sdk.dll

public interface IFramingZoneControl

Methods

GetFramingZone(CancellationToken)

Get a FramingZone with width and depth values for the framing zone

Task<Result<FramingZone>> GetFramingZone(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<FramingZone>>

GetFramingZonePeopleDetectionResults(CancellationToken)

[Obsolete("Use GetFramingZonePersonDetections instead. Method will be removed in SDK version 3.")]
Task<Result<IList<FramingZonePersonDetectionResult>>> GetFramingZonePeopleDetectionResults(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<Result<IList<FramingZonePersonDetectionResult>>>

GetFramingZonePersonDetections(CancellationToken)

Get stream of FramingZonePersonDetections that are detected within the framing zone

IAsyncEnumerable<IList<FramingZonePersonDetection>> GetFramingZonePersonDetections(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

IAsyncEnumerable<IList<FramingZonePersonDetection>>

A stream of framing zone detections

Exceptions

NotSupportedException

When API call is unsupported

ExclusiveLockException

When device is locked for firmware update

OperationCanceledException

When operation is canceled

RpcException

When a device or USB proxy RPC call fails

Exception

On device internal or unexpected SDK errors

GetFramingZoneToggle(CancellationToken)

Get the current Framing Zone on/off toggle value

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

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<Toggle>>

Result containing a toggle indicating if the feature is on or off

IsFramingZoneEnabled(CancellationToken)

[Obsolete("Use <see cref=\"GetFramingZoneToggle\"/> instead. Method will be removed in SDK version 3.")]
Task<Result<bool>> IsFramingZoneEnabled(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<Result<bool>>

SetFramingZone(FramingZone, CancellationToken)

Set the device FramingZone width and depth values

Task<Result> SetFramingZone(FramingZone value, CancellationToken ct = default)

Parameters

value FramingZone

The new value

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetFramingZoneToggle(Toggle, CancellationToken)

Set the current Framing Zone on/off toggle value

Task<Result> SetFramingZoneToggle(Toggle toggle, CancellationToken ct = default)

Parameters

toggle Toggle

A toggle value to turn the feature on or off

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result

ToggleFramingZone(Toggle, CancellationToken)

[Obsolete("Use <see cref=\"SetFramingZoneToggle\"/> instead. Method will be removed in SDK version 3.")]
Task<Result> ToggleFramingZone(Toggle toggle, CancellationToken ct = default)

Parameters

toggle Toggle

ct CancellationToken

Returns

Task<Result>