Remarks
Loads a song, previously encrypted through the CryptSound™ application, from the specified file through a secondary thread.
Accepted formats for the original (not encrypted) file are the same supported by the LoadSound method.
A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_SYNC_LOADED.
For further details about encrypted songs usage check the How to protect your music through encryption section.
Syntax
[Visual Basic]
Public Function LoadEncryptedSoundSync (
nPlayerIndex as Int16,
strFileName as String,
strDecriptionKey as String
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes LoadEncryptedSoundSync (
Int16 nPlayerIndex,
string strFileName,
string strDecriptionKey
);
|
|
[C++]
public: enumErrorCodes LoadEncryptedSoundSync (
Int16 nPlayerIndex,
string strFileName,
string strDecriptionKey
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the player that will load the sound
|
strFilename
|
String containing the name of the encrypted song file to load. It can be a full path name (ex. c:\mysounds\sound.mp3) or a filename (ex: sound.mp3) if the SoundsDirectory property has already been specified.
|
strDecriptionKey
|
String containing the key used to originally encrypt the song: its length can be from a minimum of 16 characters to a maximum of 32 characters.
|
Return value
Value
|
Meaning
|
|
|
enumErrorCodes.NOERROR (0)
|
The song file has been loaded successfully.
|
Negative value
|
An error occurred: see the LastError property for further error details or for a list of the possible error values.
|
|