Class StudioCompanionClient

Namespace

Cress.Studio.Services

Assembly

Cress.Studio.Core.dll

public sealed class StudioCompanionClient : IStudioCompanionClient, IDisposable

Inheritance

object

StudioCompanionClient

Implements

IStudioCompanionClient

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StudioCompanionClient()

public StudioCompanionClient()

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetSnapshotAsync(bool, CancellationToken)

public Task<CompanionServiceSnapshot> GetSnapshotAsync(bool includePreview = false, CancellationToken cancellationToken = default)

Parameters

includePreview bool

cancellationToken CancellationToken

Returns

Task<CompanionServiceSnapshot>

ListTargetsAsync(CancellationToken)

public Task<IReadOnlyList<CompanionTargetInfo>> ListTargetsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<CompanionTargetInfo>>

PauseRecordingAsync(int, CancellationToken)

public Task<CompanionSessionSnapshot> PauseRecordingAsync(int processId, CancellationToken cancellationToken = default)

Parameters

processId int

cancellationToken CancellationToken

Returns

Task<CompanionSessionSnapshot>

ResumeRecordingAsync(int, CancellationToken)

public Task<CompanionSessionSnapshot> ResumeRecordingAsync(int processId, CancellationToken cancellationToken = default)

Parameters

processId int

cancellationToken CancellationToken

Returns

Task<CompanionSessionSnapshot>

StartRecordingAsync(int, bool, CancellationToken)

public Task<CompanionSessionSnapshot> StartRecordingAsync(int processId, bool overlayEnabled = true, CancellationToken cancellationToken = default)

Parameters

processId int

overlayEnabled bool

cancellationToken CancellationToken

Returns

Task<CompanionSessionSnapshot>

StopRecordingAsync(int, CancellationToken)

public Task<CompanionSessionSnapshot> StopRecordingAsync(int processId, CancellationToken cancellationToken = default)

Parameters

processId int

cancellationToken CancellationToken

Returns

Task<CompanionSessionSnapshot>