Enum ObsMediaState

Namespace

OBSStudioClient.Model

Assembly

OBSClient.dll

What a media input of OBS Studio is doing (see State).

public enum ObsMediaState

Fields

None = 0

OBS Studio has no state for the media: it has not opened it. A media source that restarts when it is shown (the default) does not open its file while its scene is not on the program output, until it is played or paused: that is what an input that was just made, or a restarted OBS Studio, is.

Playing = 1

The media is playing (as far as OBS Studio can tell: a media that is not shown does not move, and says that it plays).

Opening = 2

OBS Studio is opening the media. Only seen when the model reads the state.

Buffering = 3

OBS Studio is waiting for more of the media (a stream). Only seen when the model reads the state.

Paused = 4

The playback is paused.

Stopped = 5

The playback was stopped.

Ended = 6

The media played to its end (and does not loop). OBS Studio also says so for a file that it could not open, and when the source that shows it stopped being shown.

Error = 7

OBS Studio could not play the media. Only seen when the model reads the state.

Remarks

State is kept by the events that OBS Studio sends about playback: it becomes Playing when OBS Studio is told to play or restart (or says that the playback started), Paused and Stopped when it is told to pause or stop, and Ended when the playback ended. OBS Studio sends no event for the states in between, so Opening, Buffering and Error only show when the model reads the state (when it connects, and when the input is made): ask GetStatusAsync(CancellationToken) to know what OBS Studio holds now.