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