Classes > TracksBoard class > Methods > TracksBoard.Load method

Remarks

Loads a session, saved at an earlier time through the TracksBoard.Save method, from the given input file.

A successful call to this method will fire the TracksBoardLoadingStarted event followed by a number of TracksBoardLoadingPerc events and finally by the TracksBoardLoadingDone event.

The format of the saved file is in plain XML format: in case you should need to create this file manually, the format of the file is similar to the one shown below:

XML

<?xml version="1.0" ?>

<Items>

<Pathname>C:\Temp\1\Drums.mp3</Pathname>

<FriendlyName>Drums</FriendlyName>

</Item>

<Pathname>C:\Temp\1\Guitar.mp3</Pathname>

<FriendlyName>Guitar</FriendlyName>

</VolumePoints>

</Item>

<Pathname>C:\Temp\1\voice.mp3</Pathname>

<FriendlyName>Voice 1</FriendlyName>

</Item>

<SpeechPathname>C:\m_sounds\speech_2.txt</SpeechPathname>

<FriendlyName>Spoke voice</FriendlyName>

</Item>

.... other items

</Items>

</TracksBoardSession>

For each item added to the file, the presence of the following set of attributes is mandatory

* Type

* Track

* OffsetMs

* StartPositionMs

* EndPositionMs

* Pathname (audio files only)

* one between SpeechPathname and SpeechString for "Text To Speech" elements

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

Public Function Load (

strPathname as String

) as enumErrorCodes

[C#]

public enumErrorCodes Load (

string strPathname

);

[C++]

public: enumErrorCodes Load (

string strPathname

);

Parameter	Description

strPathname	Absolute pathname of the file containing the session to load

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.
enumErrorCodes.WARN_SESSION_NOT_FULLY_LOADED	Warning about the fact that, although the loading session was completed, one or more items available inside the session file could not be loaded and were discarded; this could happen when a pathname is wrong or when one of the mandatory attributes is missing