Class ObsScene

A scene of OBS Studio.

public sealed class ObsScene : ObsSource, INotifyPropertyChanged

Inherited Members: ObsSource.TriggerHotkeyAsync(string, CancellationToken)

ObsSource.GetActivityAsync(CancellationToken)

ObsSource.GetScreenshotAsync(string, int?, int?, int?, CancellationToken)

ObsSource.SaveScreenshotAsync(string, string, int?, int?, int?, CancellationToken)

ObsSource.OpenProjectorAsync(int?, string, CancellationToken)

ObsSource.PropertyChanged

ObsSource.Model

ObsSource.Uuid

ObsSource.Name

ObsSource.State

ObsSource.IsRemoved

ObsSource.Filters

ObsSource.GetSceneItems()

ObsSource.ToString()

ObsSource.CreateFilterAsync(string, string, object, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

A group of OBS Studio is a scene too (IsGroup): it is not in Scenes, but it is the Source of the scene item that shows it.

Index: Gets the position of the scene in the list of scenes of OBS Studio: 0 is the first, as in Scenes. It is -1 for a scene that is not in that list: a group, and a scene that is not Live.

IsPreview: Gets whether the scene is the preview scene: the one that studio mode shows next to the program scene, and that becomes the program scene when the transition is triggered (TriggerAsync(CancellationToken)). There is none while studio mode is off.

IsProgram: Gets whether the scene is the program scene: the one that is on the air.

Items: Gets the scene items of the scene, from the bottom (index 0) to the top.

AddAsync(ObsSource, bool, CancellationToken): Shows a scene or an input in the scene (makes a scene item for it, on top), and returns the scene item when the model shows it.

ClearTransitionOverrideAsync(CancellationToken): Takes the transition and the duration of the scene away: the scene uses the current ones again.

CreateInputAsync(string, string, object?, bool, CancellationToken): Makes an input in the scene (and a scene item that shows it), and returns the input when the model shows both.

GetTransitionOverrideAsync(CancellationToken): Asks OBS Studio which transition, and how long, the scene brings with it.

RemoveAsync(CancellationToken): Removes the scene, and the scene items that show it in other scenes, and returns when the model shows it.

RenameAsync(string, CancellationToken): Gives the scene another name, and returns when the model shows it.

SetTransitionOverrideAsync(string?, TimeSpan?, CancellationToken): Gives the scene a transition and a duration of its own, or takes them away, and returns when OBS Studio has made the change.

SwitchToAsync(CancellationToken): Makes the scene the program scene (the one that is on the air), and returns when the model shows it.

SwitchToPreviewAsync(CancellationToken): Makes the scene the preview scene of studio mode (the one that becomes the program scene when the transition is triggered), and returns when the model shows it.