Color / Crop / Transform / Overlay

Functions
WSCResult	WSC_SetColorParams (int outputId, const WSCColorParams *params)
	Set color adjustment for an output.
WSCResult	WSC_SetCrop (int outputId, const WSCCropRect *crop)
	Set crop rectangle for an output.
WSCResult	WSC_SetTextOverlay (int outputId, const WSCTextOverlay *overlay)
	Set a text overlay for an output.
WSCResult	WSC_SetImageOverlay (int outputId, const WSCImageOverlay *overlay)
	Set an image overlay (logo/watermark) from a file.
WSCResult	WSC_SetImageOverlayFromMemory (int outputId, const void *data, int dataSize, int x, int y, int width, int height, float opacity)
	Set an image overlay from a memory buffer.
WSCResult	WSC_SetFlip (int outputId, int flipX, int flipY)
	Set horizontal/vertical flip for an output.
WSCResult	WSC_SetRotation (int outputId, int degrees)
	Set rotation for an output.

Detailed Description

Function Documentation

WSC_SetColorParams()

WSCResult WSC_SetColorParams	(	int	outputId,
		const WSCColorParams *	params )

Set color adjustment for an output.

Parameters

outputId	Output ID.
params	Color parameters, or NULL to reset to defaults.

Returns

WSC_OK on success.

See also

WSCColorParams

WSC_SetCrop()

WSCResult WSC_SetCrop	(	int	outputId,
		const WSCCropRect *	crop )

Set crop rectangle for an output.

Parameters

outputId	Output ID.
crop	Normalized crop rect, or NULL to reset (no crop).

Returns

WSC_OK on success.

See also

WSCCropRect

WSC_SetTextOverlay()

WSCResult WSC_SetTextOverlay	(	int	outputId,
		const WSCTextOverlay *	overlay )

Set a text overlay for an output.

Parameters

outputId	Output ID.
overlay	Text overlay parameters, or NULL to clear.

Returns

WSC_OK on success.

WSC_SetImageOverlay()

WSCResult WSC_SetImageOverlay	(	int	outputId,
		const WSCImageOverlay *	overlay )

Set an image overlay (logo/watermark) from a file.

Supports PNG, JPEG, BMP, GIF, TIFF. Image is loaded once and cached.

Parameters

outputId	Output ID.
overlay	Image overlay parameters, or NULL to clear.

Returns

WSC_OK on success.

WSC_SetImageOverlayFromMemory()

WSCResult WSC_SetImageOverlayFromMemory	(	int	outputId,
		const void *	data,
		int	dataSize,
		int	x,
		int	y,
		int	width,
		int	height,
		float	opacity )

Set an image overlay from a memory buffer.

Parameters

outputId	Output ID.
data	Pointer to image data (PNG/JPEG/BMP bytes).
dataSize	Size of data in bytes.
x,y	Position in pixels.
width	Display width (0 = original).
height	Display height (0 = original).
opacity	0.0–1.0.

Returns

WSC_OK on success.

WSC_SetFlip()

WSCResult WSC_SetFlip	(	int	outputId,
		int	flipX,
		int	flipY )

Set horizontal/vertical flip for an output.

Parameters

outputId	Output ID.
flipX	1 to flip horizontally, 0 to disable.
flipY	1 to flip vertically, 0 to disable.

Returns

WSC_OK on success.

WSC_SetRotation()

WSCResult WSC_SetRotation	(	int	outputId,
		int	degrees )

Set rotation for an output.

Parameters

outputId	Output ID.
degrees	Rotation in degrees. Only 0, 90, 180, 270 are supported.

Returns

WSC_OK on success.