Method OpenSourceProjectorWindow

Namespace

OBSStudioClient

Assembly

OBSClient.dll

OpenSourceProjectorWindow(SourceRef, string, Guid?, CancellationToken)

Opens a windowed projector for a source.

public Task OpenSourceProjectorWindow(SourceRef source, string projectorGeometry, Guid? canvasUuid = null, CancellationToken cancellationToken = default)

Parameters

source SourceRef

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

projectorGeometry string

Size/Position data for a windowed projector, in Qt Base64 encoded format. See GetGeometry(int, int, int, int, int, bool, bool, int).

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.