Classes > VolumeAutomationMan class > Methods > VolumeAutomation.LoadFromMemoryStream method

Remarks

Loads a volume automation procedure from a memory stream containing the needed XML code into the given player. The existing procedure can be saved inside a memory stream through the VolumeAutomation.SaveToMemoryStream method.

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 LoadFromMemoryStream (

nPlayerIndex as Int16,

ms as MemoryStream

) as enumErrorCodes

[C#]

public enumErrorCodes LoadFromMemoryStream (

Int16 nPlayerIndex,

MemoryStream ms

);

[C++]

public: enumErrorCodes LoadFromMemoryStream (

Int16 nPlayerIndex,

MemoryStream ms

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
ms	Memory stream containing volume automation procedure 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.