Interface IFirmwareChecker

Namespace

Huddly.Sdk.Upgraders

Assembly

Huddly.Sdk.dll

public interface IFirmwareChecker

Methods

ForDevice(ConnectionType, DeviceModel)

Create a new FirmwareChecker instance for the desired connection type and device model.

IFirmwareChecker ForDevice(ConnectionType connection, DeviceModel model)

Parameters

connection ConnectionType

model DeviceModel

Returns

IFirmwareChecker

GetFirmwareList(FirmwareChannel, CancellationToken)

Task<Result<List<RemoteFirmwareInfo>>> GetFirmwareList(FirmwareChannel channel, CancellationToken ct = default)

Parameters

channel FirmwareChannel

ct CancellationToken

Returns

Task<Result<List<RemoteFirmwareInfo>>>

GetLatestLocalVersion(IEnumerable<string>, CancellationToken)

Returns the path and version of the latest firmware, given a list of local firmware paths. If the firmware file is not found or cannot be read it is ignored and it will not be returned. If all paths are invalid or point to invalid firmware, an error result is returned.

Task<Result<LocalFirmwareInfo>> GetLatestLocalVersion(IEnumerable<string> filePaths, CancellationToken ct = default)

Parameters

filePaths IEnumerable<string>

ct CancellationToken

Returns

Task<Result<LocalFirmwareInfo>>

GetLatestRemoteVersion(FirmwareChannel, Dictionary<string, string>, CancellationToken)

Task<Result<RemoteFirmwareInfo>> GetLatestRemoteVersion(FirmwareChannel channel, Dictionary<string, string> metadata, CancellationToken ct = default)

Parameters

channel FirmwareChannel

metadata Dictionary<string, string>

ct CancellationToken

Returns

Task<Result<RemoteFirmwareInfo>>

GetLatestRemoteVersion(FirmwareChannel, CancellationToken)

Task<Result<RemoteFirmwareInfo>> GetLatestRemoteVersion(FirmwareChannel channel, CancellationToken ct = default)

Parameters

channel FirmwareChannel

ct CancellationToken

Returns

Task<Result<RemoteFirmwareInfo>>

GetVersion(string, CancellationToken)

Task<Result<FirmwareVersion>> GetVersion(string filePath, CancellationToken ct = default)

Parameters

filePath string

ct CancellationToken

Returns

Task<Result<FirmwareVersion>>