Namespace OBSStudioClient.Model
Classes
- ObsAudioLevels
The levels of the audio of an input: one ObsChannelLevel for each channel, as OBS Studio measured them in its last message (see Levels).
- ObsAudioLevelsEventArgs
Describes the levels of the audio that OBS Studio sent (see AudioLevels).
- ObsCanvas
A canvas of OBS Studio: a surface that scenes are drawn on, with a video of its own. OBS Studio has a main canvas, and a plugin (or a scene collection that a plugin saved) can make more.
- ObsCanvases
The canvases of OBS Studio: the main canvas, and the ones that plugins made (or that a scene collection saved).
- ObsChangedEventArgs
Describes one change of the model of OBS Studio that an ObsModel keeps.
- ObsFilter
A filter of a scene or an input of OBS Studio: something that is applied to what the source shows or plays (a color correction, a noise gate).
- ObsFilterSettingsEventArgs
Describes a change of the settings of a filter of an ObsModel, as OBS Studio said it (see FilterSettingsChanged).
- ObsFilters
The filters of a scene or an input, from the first (index 0) to the last, which can be found by name.
- ObsInput
An input of OBS Studio: a source of video, audio or both (a camera, a microphone, an image, a browser source, and so on).
- ObsMedia
The playback of a media input of OBS Studio (a media source or a VLC video source): what it is doing, and the calls that play, pause, stop, restart and seek it.
- ObsMediaStatus
What OBS Studio says about a media input at the moment that it was asked (see GetStatusAsync(CancellationToken)): a snapshot, that does not change.
- ObsModel
A model of OBS Studio that keeps itself up to date, and that finds scenes, inputs and scene items by name.
- ObsModelOptions
The settings of an ObsModel.
- ObsNamedCollection<T>
The scenes or the inputs of OBS Studio, which can be found by name.
- ObsNamedOutput
An output of OBS Studio that is addressed by its name: one that a plugin added (a second stream, a recording to another place), or one of the four of ObsOutputs by the name that OBS Studio gave it. It can be started, stopped and asked how it does, and its settings can be read and set.
- ObsOutput
An output of OBS Studio: the stream, the recording, the virtual camera or the replay buffer. It is the same object for as long as the ObsModel lives.
- ObsOutputs
The outputs of OBS Studio: the stream, the recording, the virtual camera and the replay buffer.
- ObsProfileParameter
A parameter of the configuration of a profile of OBS Studio (the file
basic.iniof the profile): what it is now, and what OBS Studio gives it when nobody set it.
- ObsProfiles
The profiles of OBS Studio: which one is current, the names of all, and the calls that switch to one, make one and remove one.
- ObsPropertyItem
One choice of a list property of an input: an entry of the dropdown that OBS Studio shows in the properties of the input (a display of a display capture, a device of a video capture device, a font style).
- ObsRecordOutput
The recording of OBS Studio. Besides what every output has, it can be paused and split, and it says which file it writes.
- ObsReplayBufferOutput
The replay buffer of OBS Studio. Besides what every output has, it can save what it holds, and it says which file it wrote.
- ObsScene
A scene of OBS Studio.
- ObsSceneCollections
The scene collections of OBS Studio: which one is loaded, the names of all, and the calls that load one and make one.
- ObsSceneItem
A scene item of OBS Studio: a source (an input, or another scene) as it is shown in one scene.
- ObsSceneItemEventArgs
Describes something that happened to a scene item of an ObsModel.
- ObsSceneItems
The scene items of a scene, from the bottom (index 0) to the top, which can be found by the name of their source.
- ObsScreenshot
A screenshot that OBS Studio made of a scene or an input.
- ObsSource
A scene or an input of OBS Studio: something that has a name and a UUID, and that scene items can show.
- ObsSpecialInputs
The global audio inputs of OBS Studio: the audio devices that it has chosen for all scenes (Settings, Audio, Global Audio Devices). They are inputs of the model like any other, and are in no scene.
- ObsStreamOutput
The stream of OBS Studio to its streaming service. Besides what every output has, it can send captions and tell how it does.
- ObsStreamService
The stream service of OBS Studio (Settings, Stream) of the profile that is current: where the stream goes. It is a snapshot: it does not change when OBS Studio does (GetStreamServiceAsync(CancellationToken) asks again).
- ObsTransition
A scene transition of OBS Studio: how a scene gives way to another one. It tells what the transition is called, what kind it is, and whether it has a duration of its own and settings.
- ObsTransitionOverride
The transition that a scene brings with it: when OBS Studio switches to the scene, it uses this transition (and duration) instead of the current ones.
- ObsTransitions
The scene transitions of OBS Studio: which one is current, how long it takes, whether one is running, and the calls that change them and trigger the transition of studio mode.
- ObsVideoSettings
The video settings of OBS Studio (Settings, Video) of the profile that is current: the size of the canvas that the scenes are drawn on, the size of the video that it outputs, and the frame rate.
Structs
- ObsChannelLevel
The level of the audio of one channel of an input, as OBS Studio measured it a moment ago (see ObsAudioLevels).
Enums
- ObsAudioTracks
The audio tracks that an input is mixed into. OBS Studio has six tracks; the recording and the stream each take the ones that are chosen for them in its output settings.
- ObsCanvasFlags
What a canvas of OBS Studio is, and does (Flags). They are set when the canvas is made and do not change.
- ObsChangeKind
What kind of change an ObsChangedEventArgs describes.
- ObsDataRealm
Where OBS Studio keeps the data that it holds for an application (GetPersistentDataAsync(ObsDataRealm, string, CancellationToken) and SetPersistentDataAsync(ObsDataRealm, string, object, CancellationToken)).
- ObsDeinterlaceFieldOrder
Which of the two fields of an interlaced frame comes first (see ObsDeinterlaceMode).
- ObsDeinterlaceMode
How OBS Studio removes the interlacing of a video that comes as interlaced fields (some capture cards and cameras). Only inputs that deliver their frames from outside (the async inputs: capture devices, media) can be deinterlaced.
- ObsHighVolume
What OBS Studio sends very often, and that an ObsModel follows only when it is asked to (see HighVolume).
- ObsMediaState
What a media input of OBS Studio is doing (see State).
- ObsModelState
The state of an ObsModel.
- ObsMonitorType
What OBS Studio does with the audio of an input besides sending it to the program: whether it plays it on the monitoring device (the headphones of the person at the computer).
- ObsObjectState
What OBS Studio has done with a scene or an input.
- ObsOutputKind
The outputs of OBS Studio that the model keeps: what it sends somewhere, or writes to disk.
- ObsOutputStatus
What an output of OBS Studio is doing.