StreamId struct
A logical video stream's 16-byte UUID, generated by the library for each
PrimarylessVideoSender (PrimarylessVideoSender.GetStreamId).
Compared by content; default(StreamId) equals StreamId.Default.
Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll
public readonly struct StreamId : IEquatable<StreamId>
Implements: IEquatable<StreamId>
Properties
Default
The all-zero id, meaning "none".
public static StreamId Default { get; }
Value: StreamId
Methods
| Member | Description |
|---|---|
| Parse(string) | Parses the UUID text StreamId.ToString produces. |
| TryParse(string, out StreamId) | Parses the UUID text StreamId.ToString produces; false, with a default id, when it is not one. |
| ToByteArray() | A copy of the 16 bytes. |
| AsSpan() | |
| TryCopyTo(Span<byte>) | Copies the 16 bytes; false, copying nothing, when destination is shorter. |
| ToString() | The 36-character UUID text, which StreamId.Parse accepts back. |
| Equals(StreamId) | Indicates whether the current object is equal to another object of the same type. |
| Equals(object?) | Indicates whether this instance and a specified object are equal. |
| GetHashCode() | Returns the hash code for this instance. |
Parse
Parses the UUID text StreamId.ToString produces.
public static StreamId Parse(string text)
Parameters
| Name | Type | Description |
|---|---|---|
text | string |
Returns: StreamId
Exceptions
| Exception | Condition |
|---|---|
| FormatException | text is not a UUID string. |
TryParse
Parses the UUID text StreamId.ToString produces; false, with a default id, when it is not one.
public static bool TryParse(string text, out StreamId id)
Parameters
| Name | Type | Description |
|---|---|---|
text | string | |
id | StreamId |
Returns: bool
ToByteArray
A copy of the 16 bytes.
public byte[] ToByteArray()
Returns: byte[]
AsSpan
public ReadOnlySpan<byte> AsSpan()
Returns: ReadOnlySpan<byte>
TryCopyTo
Copies the 16 bytes; false, copying nothing, when destination is shorter.
public bool TryCopyTo(Span<byte> destination)
Parameters
| Name | Type | Description |
|---|---|---|
destination | Span<byte> |
Returns: bool
ToString
The 36-character UUID text, which StreamId.Parse accepts back.
public override string ToString()
Returns: string
Equals(StreamId)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(StreamId other)
Parameters
| Name | Type | Description |
|---|---|---|
other | StreamId | An object to compare with this object. |
Returns: bool — true if the current object is equal to the other parameter; otherwise, false.
Equals(object?)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object? obj)
Parameters
| Name | Type | Description |
|---|---|---|
obj | object | The object to compare with the current instance. |
Returns: bool — true if obj and this instance are the same type and represent the same value; otherwise, false.
GetHashCode
Returns the hash code for this instance.
public override int GetHashCode()
Returns: int — A 32-bit signed integer that is the hash code for this instance.
Operators
operator ==
public static bool operator ==(StreamId left, StreamId right)
Parameters
| Name | Type | Description |
|---|---|---|
left | StreamId | |
right | StreamId |
Returns: bool
operator !=
public static bool operator !=(StreamId left, StreamId right)
Parameters
| Name | Type | Description |
|---|---|---|
left | StreamId | |
right | StreamId |
Returns: bool