i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update SetPaused() and add IsPaused() documentation

Browse Source
This commit is contained in:
John Scipione
2012-12-24 16:05:51 -05:00
parent 05c71c9699
commit 939600d2ad
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/game/FileGameSound.dox
+13 -2
View File
@@ -121,7 +121,18 @@
take to complete in microseconds. Set to 0 for an instantaneous take to complete in microseconds. Set to 0 for an instantaneous
change. change.
\returns A status code indicating the current playback status. \returns A status code.
\retval B_OK The operating was successful. \retval B_OK The playback state was updated.
\retval EALREADY Already in the requested playback state. \retval EALREADY Already in the requested playback state.
*/ */
/*!
\fn int32 BFileGameSound::IsPaused()
\brief Returns the current playback status.
\returns An integer indicating the current playback status.
\retval B_NOT_PAUSED Sound is playing.
\retval B_PAUSE_IN_PROGRESS The sound is transitioning to or from a paused state.
\retval B_PAUSED Sound is paused.
*/