Methods > LoadSoundFromApiEditingSession method

Remarks

Loads a sound stored inside an other instance of Audio Sound Editor API for .NET.

During the execution of the loading session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_SOUND_LOADING, in order to notify about the percentage of advancement of the loading session.

For further details about callback delegates see the How to synchronize the container application with the API tutorial. For further details about the use of more than one instance of Audio Sound Editor API for .NET or of another instance of Audio Sound Editor for .NET Winform component, check the How to load a sound stored inside another instance of the API section.

Syntax

[Visual Basic]

Public Function LoadSoundFromApiEditingSession (

nEditorInstanceId as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes LoadSoundFromApiEditingSession (

Int16 nEditorInstanceId

);

[C++]

public: enumErrorCodes LoadSoundFromApiEditingSession (

Int16 nEditorInstanceId

);

Parameter	Description

nEditorInstanceId	Number representing the identifier of the instance of Audio Sound Editor API containing the sound to load. The identifier of the instance can be obtained through the GetEditorInstanceId method.

Return value

Value	Meaning

Negative value	An error occurred. Check the LastError property value in order to see the last error.
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.