Method OpenSourceProjectorOnMonitor

Namespace

OBSStudioClient

Assembly

OBSClient.dll

OpenSourceProjectorOnMonitor(SourceRef, int, Guid?, CancellationToken)

Opens a projector for a source on a monitor.

public Task OpenSourceProjectorOnMonitor(SourceRef source, int monitorIndex, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

The source to open a projector for, by name or by UUID.

monitorIndex int

Monitor index, use GetMonitorList(CancellationToken) to obtain index. Use -1 for windowed mode.

canvasUuid Guid?

UUID of the canvas the source is in, if using the name of the source.

cancellationToken CancellationToken

A token that ends the wait for the response, which makes the method throw an OperationCanceledException. A request that was already sent is not undone: OBS Studio may still carry it out.

Returns

Task

Remarks

Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.