Interface IPtz

Namespace

Huddly.Sdk.CameraControl

Assembly

Huddly.Sdk.dll

public interface IPtz

Methods

GetPan(CancellationToken)

Get the pan value of the device

The value is normalized in the range [-1.0, 1.0].

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

Parameters

ct CancellationToken

Returns

Task<Result<double>>

A result with the current Pan value of the device.

GetPtz(CancellationToken)

Obsolete: Use the individual get methods for pan, tilt and zoom instead

[Obsolete("Use the individual get methods for pan, tilt and zoom instead. Method will be removed in SDK version 3.")]
Task<Result<Ptz>> GetPtz(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<Result<Ptz>>

GetTilt(CancellationToken)

Get the tilt value of the device

The value is normalized in the range [-1.0, 1.0].

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

Parameters

ct CancellationToken

Returns

Task<Result<double>>

A result with the current Tilt value of the device.

GetZoom(CancellationToken)

Get the zoom values of the device

The value is normalized in the range [0.0, 1.0].

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

Parameters

ct CancellationToken

Returns

Task<Result<double>>

A result with the current Zoom value of the device.

PersistCurrentPtz(CancellationToken)

Persist the current PTZ values in the active camera storage slot

Task<Result> PersistCurrentPtz(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

RestorePersistentPtz(CancellationToken)

Restore PTZ values from active camera storage slot

Task<Result> RestorePersistentPtz(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetPan(double, CancellationToken)

Set the device pan value

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

Parameters

value double

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

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetPtz(double?, double?, double?, CancellationToken)

Obsolete: Use the individual set methods for pan, tilt and zoom instead

[Obsolete("Use the individual set methods for pan, tilt and zoom instead. Method will be removed in SDK version 3.")]
Task<Result> SetPtz(double? panValue = null, double? tiltValue = null, double? zoomValue = null, CancellationToken ct = default)

Parameters

panValue double?

tiltValue double?

zoomValue double?

ct CancellationToken

Returns

Task<Result>

SetTilt(double, CancellationToken)

Set the device tilt value

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

Parameters

value double

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

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

SetZoom(double, CancellationToken)

Set the device zoom value

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

Parameters

value double

The new Zoom value, in the range [0.0, 1.0]

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure