Copyright © 2005-2019 MultiMedia Soft

SoundComposer.SessionSave method

Previous pageReturn to chapter overviewNext page

Remarks

 

Saves the current sound composer session into a XML file. The same session can be loaded at a later time through a call to the SoundComposer.SessionLoad method.

 

IMPORTANT NOTE: Items eventually added through the SoundComposer.ItemSoundFileMemoryAdd and SoundComposer.ItemSoundFileMemoryRawAdd methods are not saved into the file because their contents, being memory-based, become unavailable once the container application is closed and there would be no way to retrieve the original content of the memory buffer once the container application is launched again.

 

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function SessionSave (

nPlayerIndex as Int16,

strPathname as string

) as enumErrorCodes


 

[C#]

public enumErrorCodes SessionSave (

Int16 nPlayerIndex,

string strPathname

);


 

[C++]

public: enumErrorCodes SessionSave (

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 destination XML file.

 

 

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.