Interface IStudioCompanionClient
- Namespace
- Cress.Studio.Services
- Assembly
- Cress.Studio.Core.dll
public interface IStudioCompanionClient
Methods
GetSnapshotAsync(bool, CancellationToken)
Task<CompanionServiceSnapshot> GetSnapshotAsync(bool includePreview = false, CancellationToken cancellationToken = default)
Parameters
includePreview bool
cancellationToken CancellationToken
Returns
- Task<CompanionServiceSnapshot>
ListTargetsAsync(CancellationToken)
Task<IReadOnlyList<CompanionTargetInfo>> ListTargetsAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task<IReadOnlyList<CompanionTargetInfo>>
PauseRecordingAsync(int, CancellationToken)
Task<CompanionSessionSnapshot> PauseRecordingAsync(int processId, CancellationToken cancellationToken = default)
Parameters
processId int
cancellationToken CancellationToken
Returns
- Task<CompanionSessionSnapshot>
ResumeRecordingAsync(int, CancellationToken)
Task<CompanionSessionSnapshot> ResumeRecordingAsync(int processId, CancellationToken cancellationToken = default)
Parameters
processId int
cancellationToken CancellationToken
Returns
- Task<CompanionSessionSnapshot>
StartRecordingAsync(int, bool, CancellationToken)
Task<CompanionSessionSnapshot> StartRecordingAsync(int processId, bool overlayEnabled = true, CancellationToken cancellationToken = default)
Parameters
processId int
overlayEnabled bool
cancellationToken CancellationToken
Returns
- Task<CompanionSessionSnapshot>
StopRecordingAsync(int, CancellationToken)
Task<CompanionSessionSnapshot> StopRecordingAsync(int processId, CancellationToken cancellationToken = default)
Parameters
processId int
cancellationToken CancellationToken
Returns
- Task<CompanionSessionSnapshot>