Method OpenVideoMixProjector

Namespace

OBSStudioClient

Assembly

OBSClient.dll

OpenVideoMixProjector(MixType, int?, string?, CancellationToken)

Opens a projector for a specific output video mix.

public Task OpenVideoMixProjector(MixType videoMixType, int? monitorIndex = null, string? projectorGeometry = null, CancellationToken cancellationToken = default)

Parameters

videoMixType MixType

Type of mix to open.

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.

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

Mix types:.

- OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW - OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM - OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW.

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