Struct InputRef
- Namespace
- OBSStudioClient.Classes
- Assembly
- OBSClient.dll
Identifies an input to obs-websocket: by its name or by its UUID.
public readonly struct InputRef : IEquatable<InputRef>- Implements
- Inherited Members
Remarks
Wherever a method asks for an InputRef you can pass a name ("Microphone"), a Guid or an
Input that OBS Studio gave you: they convert implicitly. A UUID stays the same when the input is renamed.
default(InputRef) identifies nothing; the methods refuse it with an ArgumentException.
Properties
- IsSpecified
Gets a value indicating whether this identifies an input (
default(InputRef)does not).
- Name
Gets the name of the input, or null when the input is identified by its UUID.
- Uuid
Gets the UUID of the input, or null when the input is identified by its name.
Methods
- Equals(InputRef)
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.
- FromName(string)
Identifies an input by its name.
- FromUuid(Guid)
Identifies an input by its UUID.
- GetHashCode()
Returns the hash code for this instance.
- ToString()
Gets the name or the UUID of the input, as text.
Operators
- operator ==(InputRef, InputRef)
Determines whether two references are the same: the same name or the same UUID.
- implicit operator InputRef(Input)
Identifies an input that OBS Studio reported, by its UUID (or by its name when OBS Studio did not report a UUID).
- implicit operator InputRef(Guid)
Identifies an input by its UUID.
- implicit operator InputRef(string)
Identifies an input by its name.
- operator !=(InputRef, InputRef)
Determines whether two references are different.