You are here: Player Plug-ins > Definitions > Input Plug-ins > QCDModInitIn > QCDModInitIn::toModule > Stop
 QMP Developer Reference Guide |
   |
   |
Stop
|
QMP Developer Reference Guide |
|
|
The player calls this function to stop decoding in the plug-in.
|
Parameters |
Description |
|
medianame |
[in] string of currently playing medianame (encoding determined by version setting) |
|
flags |
[in] the following flags are defined: STOPFLAG_FORCESTOP: stop occurring due to user action (player will enter stopped state) STOPFLAG_PLAYDONE: stop occurring due to current track completion STOPFLAG_SHUTDOWN: stop occurring due to player shutdown STOPFLAG_PLAYSKIP: stop occurring due to current track skip STOPFLAG_ALLDONE: stop occurring due to playlist completion (player will enter stopped state) |
|
Return Values |
Description |
|
0 |
command unsuccessful |
|
1 |
command successful |
Stop should return after it has stopped the all decoding in the plug-in. The medianame parameter is a sanity check that the currently decoding media should match.
In most cases the plug-in should also call OutputStop(flags) to stop the output plug-in. Passing the same flags parameter to OutputStop is important for proper operation.
|
Copyright (c) Quinnware 2007. All rights reserved.
|