SoundLyricsRequest method |
|
Remarks
Given an author and title of a song, requests a connection to the MultiMedia Soft server in order to search for the lyrics text of the song.
Once completed the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_LYRICS_AVAIL and, if found, lyrics text can be retrieved through the SoundLyricsGet method.
Syntax
[Visual Basic] Public Function SoundLyricsRequest ( nPlayerIndex as Int16, strArtist as String, strTitle as String ) as enumErrorCodes |
[C#] public enumErrorCodes SoundLyricsRequest ( Int16 nPlayerIndex, string strArtist, string strTitle ); |
[C++] public: enumErrorCodes SoundLyricsRequest ( Int16 nPlayerIndex, string strArtist, string strTitle ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
strArtist |
String representing the artist name |
strTitle |
String representing the song title |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |