|
VolumeAutomation.Load method |
  
|
|
VolumeAutomation.Load method |
|
Remarks
Loads a volume automation procedure from a XML-based VDJ file.
A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_VOLUME_AUTOMATION_LOADED.
For details about using Volume Automation and for a reference about VDJ format refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function Load ( nPlayerIndex as Int16, strPathname as String ) as enumErrorCodes |
[C#] public enumErrorCodes Load ( Int16 nPlayerIndex, string strPathname ); |
[C++] public: enumErrorCodes Load ( Int16 nPlayerIndex, string strPathname ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
strPathname |
String containing the absolute pathname of the VDJ file to load. An empty string will force the control to search for a VDJ file having the same filename of the loaded sound but with extension .vdj: if for example the loaded sound file should be named MySong.mp3, the corresponding searched VDJ file would be named MySong.vdj |
Return value
Value |
Meaning |
|
|
enumErrorCodes.NOERROR (0) |
The method call was successful |
Negative value |
An error occurred: see the LastError property for further error details or for a list of the possible error values. |
