Property IsActive

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

IsActive

Gets whether the input is on the air: shown in the program output, because the scene that is on the air shows it (or a scene in it, and the scene item is not hidden), or because a transition between two scenes shows it. It is null unless the model was asked to follow the activity (HighVolume with Activity): OBS Studio sends an event for the inputs of a scene each time that the program scene, a transition or a scene item that shows them changes, so the model does not ask for them unless they are wanted. To ask OBS Studio once, whatever the options are, use GetActivityAsync(CancellationToken).

public bool? IsActive { get; }

Property Value

bool?

Remarks

The value is current. A scene that is put on the air with a transition puts its inputs on the air when the transition starts, and the scene that goes off the air takes its inputs off the air after the transition has ended. An input that two scenes on the air show stays on the air when one of them goes. OBS Studio does not announce the activity of an input that it destroys, and says nothing of a scene (a scene in the model has no activity: ask GetActivityAsync(CancellationToken)).

In studio mode what is on the air is a copy of the program scene that OBS Studio made when the scene went on the air (or when studio mode was switched on): what is done to the scene itself afterwards (hiding a scene item, making an input) does not reach the copy, so the inputs stay as they were until the next scene goes on the air or studio mode is switched off (measured with OBS Studio 33.0.0). The inputs of the preview scene are shown (IsShowing) and not on the air, unless the copy shows them as well.