Interface IUsbDevice

Namespace

Huddly.Sdk

Assembly

Huddly.Sdk.dll

public interface IUsbDevice : IDevice, IImageSettings, IPtz

Inherited Members

IDevice.ConnectionType

IDevice.ConnectionState

IDevice.Id

IDevice.LastActivity

IDevice.Serial

IDevice.Manufacturer

IDevice.Model

IDevice.FirmwareChecker

IDevice.GetName(CancellationToken)

IDevice.GetFwVersion(CancellationToken)

IDevice.GetFirmwareParser()

IDevice.GetLatestFirmwareReleaseInfo(FirmwareChannel, CancellationToken)

IDevice.IsGreaterThanCurrentVersion(FirmwareInfo, CancellationToken)

IDevice.GetFirmwareVersion(CancellationToken)

IDevice.GetFirmwareUpgrader(string, CancellationToken)

IDevice.Reboot(CancellationToken)

IDevice.GetUptime(CancellationToken)

IDevice.GetTime(CancellationToken)

IDevice.SetTime(DateTime, CancellationToken)

IDevice.GetLog(Stream, CancellationToken)

IDevice.EraseLog(CancellationToken)

IDevice.GetFramingMode(CancellationToken)

IDevice.SetFramingMode(FramingMode, CancellationToken)

IDevice.GetSupportedFeatures(CancellationToken)

IDevice.GetFeatureOptions(CancellationToken)

IDevice.AddFeatureOption(FeatureOption, CancellationToken)

IDevice.ReportAudioOutputLevel(int, double[], CancellationToken)

IDevice.GetDetector(DetectorOptions, CancellationToken)

IDevice.GetStreamStatus(CancellationToken)

IDevice.SubscribeToStreamStatusChange(CancellationToken)

IDevice.GetFramingSubscriber(FramingSubscriberOptions, CancellationToken)

IDevice.IsFramingZoneEnabled(CancellationToken)

IDevice.ToggleFramingZone(Toggle, CancellationToken)

IDevice.GetFramingZone(CancellationToken)

IDevice.SetFramingZone(FramingZone, CancellationToken)

IDevice.GetFramingZonePeopleDetectionResults(CancellationToken)

IImageSettings.GetBrightness(CancellationToken)

IImageSettings.SetBrightness(double, CancellationToken)

IImageSettings.GetSaturation(CancellationToken)

IImageSettings.SetSaturation(double, CancellationToken)

IImageSettings.PersistCurrentImageSettings(CancellationToken)

IImageSettings.RestorePersistentImageSettings(CancellationToken)

IImageSettings.GetFaceBasedExposure(CancellationToken)

IImageSettings.SetFaceBasedExposure(Toggle, CancellationToken)

IImageSettings.GetPerspectiveCorrection(CancellationToken)

IImageSettings.SetPerspectiveCorrection(PerspectiveCorrection, CancellationToken)

IPtz.GetPan(CancellationToken)

IPtz.SetPan(double, CancellationToken)

IPtz.GetTilt(CancellationToken)

IPtz.SetTilt(double, CancellationToken)

IPtz.GetZoom(CancellationToken)

IPtz.SetZoom(double, CancellationToken)

IPtz.PersistCurrentPtz(CancellationToken)

IPtz.RestorePersistentPtz(CancellationToken)

IPtz.GetPtz(CancellationToken)

IPtz.SetPtz(double?, double?, double?, CancellationToken)

Properties

Client

ICameraUsbClient Client { get; }

Property Value

ICameraUsbClient

ProductId

ushort ProductId { get; }

Property Value

ushort

VendorId

ushort VendorId { get; }

Property Value

ushort

Methods

GetCanvasEnhanceMode(CancellationToken)

Get canvas enhance mode status.

Task<Result<Toggle?>> GetCanvasEnhanceMode(CancellationToken ct = default)

Parameters

ct CancellationToken

A cancellation token

Returns

Task<Result<Toggle?>>

A toggle result. The result value is null if device is not in canvas mode

GetExclusiveLockStatus(CancellationToken)

Task<Result<ExclusiveLockStatus>> GetExclusiveLockStatus(CancellationToken ct)

Parameters

ct CancellationToken

Returns

Task<Result<ExclusiveLockStatus>>

ReleaseExclusiveLock(CancellationToken)

Task<Result> ReleaseExclusiveLock(CancellationToken ct)

Parameters

ct CancellationToken

Returns

Task<Result>

SetCanvasEnhanceMode(Toggle, CancellationToken)

Set canvas enhance mode.

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

Parameters

value Toggle

The new value.

ct CancellationToken

A cancellation token

Returns

Task<Result>

A result indicating success or failure

TakeExclusiveLock(int, string, CancellationToken)

Task<Result> TakeExclusiveLock(int timeout, string reason, CancellationToken ct)

Parameters

timeout int

reason string

ct CancellationToken

Returns

Task<Result>