Method OpenSourceProjector

Namespace

OBSStudioClient

Assembly

OBSClient.dll

OpenSourceProjector(SourceRef, int?, string?, Guid?, CancellationToken)

Opens a projector for a source.

public Task OpenSourceProjector(SourceRef source, int? monitorIndex = null, string? projectorGeometry = null, 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 to obtain index. If omitted: -1: Opens projector in windowed mode.

projectorGeometry string

Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex.

canvasUuid Guid?

UUID of the canvas the source is in, if the source is given by name.

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.