Effects.EqualizerSaveToMemoryStream method |
|
Remarks
Saves existing equalizer's settings into a memory stream in XML format. These equalizer's settings can be loaded at a later time through the EqualizerLoadFromMemoryStream method.
For further details about defining the equalizer settings refer to the How to create and use an Equalizer section.
Syntax
[Visual Basic] Public Function EqualizerSaveToMemoryStream ( nPlayerIndex as Int16, ms as MemoryStream ) as enumErrorCodes |
[C#] public enumErrorCodes EqualizerSaveToMemoryStream ( Int16 nPlayerIndex, MemoryStream ms ); |
[C++] public: enumErrorCodes EqualizerSaveToMemoryStream ( Int16 nPlayerIndex, MemoryStream ms ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
ms |
Memory stream for storing equalizer's settings in XML format |
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. |