Class ObsRecordOutput

Namespace: OBSStudioClient.Model

Assembly: OBSClient.dll

The recording of OBS Studio. Besides what every output has, it can be paused and split, and it says which file it writes.

public sealed class ObsRecordOutput : ObsOutput, INotifyPropertyChanged

Inheritance: object

ObsOutput

ObsRecordOutput

Implements: INotifyPropertyChanged

Inherited Members: ObsOutput.PropertyChanged

ObsOutput.Model

ObsOutput.Kind

ObsOutput.Name

ObsOutput.Status

ObsOutput.IsActive

ObsOutput.ToString()

ObsOutput.StartAsync(CancellationToken)

ObsOutput.StopAsync(CancellationToken)

ObsOutput.ToggleAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

CurrentFile: Gets the path of the file of the recording: the file that OBS Studio is writing, or wrote last. It is null until the model has seen OBS Studio say one.

IsPaused: Gets whether the recording is paused: Status is Paused.

Methods

CreateChapterAsync(string?, CancellationToken): Adds a chapter marker to the file that is being recorded, and returns when OBS Studio has accepted the request.

GetStatisticsAsync(CancellationToken): Asks OBS Studio for the figures of the recording: how long it runs (the timecode and the duration in milliseconds) and how many bytes it has written.

PauseAsync(CancellationToken): Pauses the recording, and returns when the model shows it.

ResumeAsync(CancellationToken): Resumes the recording after it was paused, and returns when the model shows it.

SplitFileAsync(CancellationToken): Splits the recording: OBS Studio finishes the file that it is writing and goes on in a new one. It returns when OBS Studio has accepted the request.

TogglePauseAsync(CancellationToken): Pauses the recording when it is not paused, and resumes it when it is, and returns when the model shows it.

Events

FileChanged: Occurs when the recording continues in a new file: OBS Studio has split the recording (because of its settings, or SplitFileAsync(CancellationToken)) and has begun to write another file. The event carries the path of the new file, which is CurrentFile from then on.