PLAY (function): Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
{{PageParameters}}
{{PageParameters}}
* {{Parameter|notesLeft&}} is the number of notes left to play in the background music queue.
* {{Parameter|notesLeft&}} is the number of notes left to play in the background music queue.
* {{Parameter|numericExpression&}} can be any numeric expression. This is ignored.
* {{Parameter|numericExpression&}} can be any numeric expression.




Line 19: Line 19:
<!-- QB64 = a version or none, QBPE = a version or all, Platforms = yes or no -->
<!-- QB64 = a version or none, QBPE = a version or all, Platforms = yes or no -->
<gallery widths="48px" heights="48px" mode="nolines">
<gallery widths="48px" heights="48px" mode="nolines">
File:Qb64.png|'''none'''
File:Qb64.png|'''v0.934'''
File:Qbpe.png|'''v3.1.0'''
File:Qbpe.png|'''v3.1.0'''
File:Apix.png
File:Apix.png
Line 27: Line 27:
</gallery>
</gallery>
<!-- additional availability notes go below here -->
<!-- additional availability notes go below here -->
* In QB64, this function always returned zero.
* In '''QB64''' and early '''QB64-PE''', this was just implemented as stub function which always returned zero.
* Unlike QuickBASIC, in QB64-PE this function does not return the number of notes left, but the number of audio samples.
* Since '''QB64-PE v3.1.0''' the function is fully implemented, but unlike '''QuickBASIC''', in '''QB64-PE''' this function does not return the number of notes left, but the number of audio samples.
* In '''QB64-PE v3.8.0''' if {{Parameter|numericExpression&}} is a number other than zero, then the function will return the amount of time (seconds) left to play.
* In '''QB64-PE v3.8.0''', if {{Parameter|numericExpression&}} is a number other than zero, then the function will return the amount of time (seconds) left to play.





Revision as of 16:09, 18 June 2023

The PLAY function returns the number of remaining notes in the background music queue.


Syntax

notesLeft& = PLAY (numericExpression&)


Parameters

  • notesLeft& is the number of notes left to play in the background music queue.
  • numericExpression& can be any numeric expression.


Description

  • This function may be used to detect, if the background music queue is still playing.
  • When there is nothing left to play, then this function returns zero.


Availability

  • In QB64 and early QB64-PE, this was just implemented as stub function which always returned zero.
  • Since QB64-PE v3.1.0 the function is fully implemented, but unlike QuickBASIC, in QB64-PE this function does not return the number of notes left, but the number of audio samples.
  • In QB64-PE v3.8.0, if numericExpression& is a number other than zero, then the function will return the amount of time (seconds) left to play.


Examples

PLAY "mb l4cf.l8el4fag.l8fl4gl8agl4f.l8fl4a>cl2dl4dl4c.<l8al4afg.l8fl4gl8agl4f.l8dl4dcl2f>l4dc.<l8al4afg.l8fl4g>dc.<l8al4a>cl2dl4dc.<l8al4afg.l8fl4gl8agl4f.l8dl4dcl1f"

PRINT "Playing tune..."

DO
    playLeft& = PLAY(0)
    LOCATE , 1: PRINT "Left to play ="; playLeft&; " ";
LOOP WHILE playLeft&

PRINT: PRINT "And we are done!"

END


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link