Class FirmwareVersion

Namespace

Huddly.Sdk.Models

Assembly

Huddly.Sdk.dll

public sealed class FirmwareVersion : IComparable<FirmwareVersion>, IEquatable<FirmwareVersion>

Inheritance

object

FirmwareVersion

Implements

IComparable<FirmwareVersion>

IEquatable<FirmwareVersion>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

FirmwareVersion(SemVersion, SemVersion?)

[Obsolete("Use FirmwareVersion(SemVersion, SemVersion, DeviceFirmwareState) instead. Constructor will be removed in SDK version 3.")]
public FirmwareVersion(SemVersion mainDevice, SemVersion? subDevice)

Parameters

mainDevice SemVersion

subDevice SemVersion

FirmwareVersion(SemVersion, SemVersion?, DeviceFirmwareState)

public FirmwareVersion(SemVersion mainDevice, SemVersion? subDevice, DeviceFirmwareState deviceFirmwareState)

Parameters

mainDevice SemVersion

subDevice SemVersion

deviceFirmwareState DeviceFirmwareState

Properties

DeviceFirmwareState

public DeviceFirmwareState DeviceFirmwareState { get; init; }

Property Value

DeviceFirmwareState

MainDevice

public SemVersion MainDevice { get; init; }

Property Value

SemVersion

SubDevice

public SemVersion? SubDevice { get; init; }

Property Value

SemVersion

Methods

CompareTo(FirmwareVersion?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(FirmwareVersion? other)

Parameters

other FirmwareVersion

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

CompareTo(FirmwareVersion?, FirmwareComparison)

public int CompareTo(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

int

Equals(FirmwareVersion?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(FirmwareVersion? other)

Parameters

other FirmwareVersion

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(FirmwareVersion?, FirmwareComparison)

public bool Equals(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

bool

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GreaterThan(FirmwareVersion?, FirmwareComparison)

public bool GreaterThan(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

bool

GreaterThanOrEqualTo(FirmwareVersion?, FirmwareComparison)

public bool GreaterThanOrEqualTo(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

bool

LessThan(FirmwareVersion?, FirmwareComparison)

public bool LessThan(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

bool

LessThanOrEqualTo(FirmwareVersion?, FirmwareComparison)

public bool LessThanOrEqualTo(FirmwareVersion? other, FirmwareComparison comparisonType = FirmwareComparison.StandardPrereleasePrecedence)

Parameters

other FirmwareVersion

comparisonType FirmwareComparison

Returns

bool

ToString()

The default string representation of FirmwareVersion, which includes both the main and sub device versions (when the camera/sub-device is connected through an adapter). Format: major.minor.patch-prerelease+metadata_major.minor.patch-prerelease+metadata. Example: "1.0.0-alpha.1+sha.204a81e_2.0.0-rc.2+sha.61c81d8" (main-device_sub-device).

public override string ToString()

Returns

string

ToString(FirmwareStringFormat)

The string representation of FirmwareVersion using specified format flags.

public string ToString(FirmwareStringFormat format = FirmwareStringFormat.Full)

Parameters

format FirmwareStringFormat

Formatting flags for the string representation of FirmwareVersion.

Returns

string

Operators

operator ==(FirmwareVersion?, FirmwareVersion?)

public static bool operator ==(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool

operator >(FirmwareVersion?, FirmwareVersion?)

public static bool operator >(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool

operator >=(FirmwareVersion?, FirmwareVersion?)

public static bool operator >=(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool

operator !=(FirmwareVersion?, FirmwareVersion?)

public static bool operator !=(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool

operator <(FirmwareVersion?, FirmwareVersion?)

public static bool operator <(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool

operator <=(FirmwareVersion?, FirmwareVersion?)

public static bool operator <=(FirmwareVersion? left, FirmwareVersion? right)

Parameters

left FirmwareVersion

right FirmwareVersion

Returns

bool