Interface IAimpExtensionEmbeddedVisualization

This type visualization displays on visual display of player only and can be chosen by user.

Instance should be created by plugin and must be registered in the application in the Initialize() method via the RegisterExtension(IAimpExtension) method.

Implements the IAimpExtension

Namespace: AIMP.SDK.Visuals

Assembly: AIMP.SDK.dll

Syntax

public interface IAimpExtensionEmbeddedVisualization : IAimpExtension

Methods

Click(Int32, Int32, AimpVisualClickButtonType)

Occurs when user clicked on visualization.

Declaration

void Click(int x, int y, AimpVisualClickButtonType button)

Parameters

Type	Name	Description
System.Int32	x	Position by X.
System.Int32	y	Position by Y.
AimpVisualClickButtonType	button	The mouse button.

Draw(IntPtr, AimpVisualData)

Draws visualization on the specified output screen.

Declaration

void Draw(IntPtr dc, AimpVisualData data)

Parameters

Type	Name	Description
System.IntPtr	dc	The output screen handle.
AimpVisualData	data	The visualization data AimpVisualData.

GetFlags()

Returns zero or combination of followed flags AimpVisualFlags.

Declaration

AimpVisualFlags GetFlags()

GetMaxDisplaySize()

Method returns a maximal resolution supported by the extension. If current resolution is not supported by extension, player will automatically stretch output.

Declaration

AimpActionResult<int, int> GetMaxDisplaySize()

GetName()

Gets the visualization display name.

Declaration

AimpActionResult<string> GetName()

Initialize(Int32, Int32)

Initializes the visualization. Occurs when user activate the visualization.

Declaration

AimpActionResult Initialize(int width, int height)

Parameters

Type	Name	Description
System.Int32	width	The width.
System.Int32	height	The height.

OnFinalize()

Called when visualization should be finalized.

Declaration

void OnFinalize()

Resize(Int32, Int32)

Occurs when the sizes of the visualization window are changed.

Declaration

void Resize(int newWidth, int newHeight)

Parameters

Type	Name	Description
System.Int32	newWidth	The new width.
System.Int32	newHeight	The new height.

See Also

IAimpExtension