Copyright © 2005-2018 MultiMedia Soft

Waveform.Create method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates the Waveform object for real-time visual feedback during sound's playback: once created, the Waveform feedback will stay active until the termination of the container application: being a graphical object, the Waveform feedback needs to be associated to an existing window that will be used as a surface for the graphic rendering: this window can be changed at a later time through the Waveform.SetHwnd method. For development environments like WPF, where controls don't expose a HWND, the usage of the Waveform.CreateNew method should be preferred.

 

Once created, by default the Waveform feedback is still not visible: you must make a call to the Waveform.Show method in order to display it.

 

Note that you can have a different Waveform for each of the allocated players.

 

For further details about using the embedded Waveform refer to the Waveform class section.

For details about using Visual Feedbacks refer to the How to use the embedded Visual Feedbacks section.

 

 

Syntax

 

[Visual Basic]

Public Function Create (

nPlayerIndex as Int16,

hWndTarget as IntPtr

) as enumErrorCodes


 

[C#]

public enumErrorCodes Create (

Int16 nPlayerIndex,

IntPtr hWndTarget

);


 

[C++]

public: enumErrorCodes Create (

Int16 nPlayerIndex,

IntPtr hWndTarget

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the player that will use the Waveform

hWndTarget

Handle of the window whose surface will be used in order to render the Waveform graphics

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.