SoundLyricsGet method |
|
Remarks
Retrieves lyrics text previously requested through the SoundLyricsRequest method.
This method must be called only after the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_LYRICS_AVAIL and only if no error is reported by the event itself.
Syntax
[Visual Basic] Public Function SoundLyricsGet ( nPlayerIndex as Int16 ) as String |
[C#] public string SoundLyricsGet ( Int16 nPlayerIndex ); |
[C++] public: string SoundLyricsGet ( Int16 nPlayerIndex ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
Return value
Value |
Meaning |
|
|
Empty string |
An error occurred (see the LastError property for further error details) |
Valid string |
The string containing requested lyrics text |