SNDBAL: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
(_SNDBAL per channel no longer works in v3.1.0 with the new audio backend.)
Tag: visualeditor
(Remove extra closing bracket from syntax and update example 1)
Line 4: Line 4:


{{PageSyntax}}
{{PageSyntax}}
: [[_SNDBAL]] {{Parameter|handle&}}[, {{Parameter|x!}}][, {{Parameter|y!}}][, {{Parameter|z!}}][, {{Parameter|channel&}}]]
: [[_SNDBAL]] {{Parameter|handle&}}[, {{Parameter|x!}}][, {{Parameter|y!}}][, {{Parameter|z!}}][, {{Parameter|channel&}}]




Line 25: Line 25:


{{PageExamples}}
{{PageExamples}}
''Example 1:''
''Example 1:'' This example loads, plays, and then bounces the sound between the left and right channels
{{CodeStart}} '' ''
{{CodeStart}}
h& = {{Cl|_SNDOPEN}}("LOL.wav", "SYNC,VOL")
' This examples load, plays and then bounces the sound between the left and right channels
{{Cl|_SNDBAL}} h&, 1
Laff& = {{Cl|_SNDOPEN}}("KONGlaff.ogg", "stream") 'load sound file and get LONG handle value
{{Cl|_SNDPLAY}} h& '' ''
{{Cl|IF}} Laff& > 0 {{Cl|THEN}}
    {{Cl|_SNDPLAY}} Laff& 'play sound
{{Cl|ELSE}}
    {{Cl|PRINT}} "Failed to load sound file."
    {{Cl|END}}
{{Cl|END}} {{Cl|IF}}
 
{{Cl|PRINT}} "Press ESC to stop."
dir = 0.01
{{Cl|DO}}
    {{Cl|IF}} laffx! <= -1 {{Cl|THEN}} dir = 0.01
    {{Cl|IF}} laffx! >= 1 {{Cl|THEN}} dir = -0.01
    laffx! = laffx! + dir
 
    {{Cl|LOCATE}} , 1: {{Cl|PRINT USING}} "Balance = ##.##"; laffx!;
    {{Cl|_SNDBAL}} Laff&, laffx! 'balance sound to left or right speaker
 
    {{Cl|_LIMIT}} 60
{{Cl|LOOP}} {{Cl|WHILE}} {{Cl|_SNDPLAYING}}(Laff&) {{Cl|AND}} {{Cl|_KEYHIT}} <> 27
{{CodeEnd}}
{{CodeEnd}}


Revision as of 16:59, 5 October 2022

The _SNDBAL statement attempts to set the balance or 3D position of a sound.


Syntax

_SNDBAL handle&[, x!][, y!][, z!][, channel&]


Template:Parameters

  • handle& is a valid sound handle created by the _SNDOPEN function.
  • x! distance values go from left (negative) to right (positive).
  • y! distance values go from below (negative) to above (positive).
  • z! distance values go from behind (negative) to in front (positive).
  • channel& value 1 denotes left (mono) and 2 denotes right (stereo) channel (beginning with build 20170811/60)
    • The ability to set the balance per channel is gone in version 3.1.0 and higher.

Description

  • Attempts to position a sound in 3D space, or as close to it as the underlying software libraries allow. In some cases, this will be true 3D positioning, in others, a mere volume adjustment based on distance alone.
  • Omitted x!, y! or z! SINGLE values are set to 0 or not changed in build 20170811/60 onward.
  • By setting the x! value to -1 or 1 it plays the sound at full volume from the appropriate speaker.
  • Sounds at a distance of 1 or -1 are played at full volume. Sounds further than a distance of 1000 cannot be heard.
  • The volume decreases linearly (at a constant gradient) over distance. Half volume = 500.
  • An "Illegal Function Call" error can occur if another sound is using the primary or same channel position.
  • Opened sound files must have the "VOL" capability to use this statement in versions before build 20170811/60.


Examples

Example 1: This example loads, plays, and then bounces the sound between the left and right channels 

' This examples load, plays and then bounces the sound between the left and right channels
Laff& = _SNDOPEN("KONGlaff.ogg", "stream") 'load sound file and get LONG handle value
IF Laff& > 0 THEN
    _SNDPLAY Laff& 'play sound
ELSE
    PRINT "Failed to load sound file."
    END
END IF

PRINT "Press ESC to stop."
dir = 0.01
DO
    IF laffx! <= -1 THEN dir = 0.01
    IF laffx! >= 1 THEN dir = -0.01
    laffx! = laffx! + dir

    LOCATE , 1: PRINT USING "Balance = ##.##"; laffx!;
    _SNDBAL Laff&, laffx! 'balance sound to left or right speaker

    _LIMIT 60
LOOP WHILE _SNDPLAYING(Laff&) AND _KEYHIT <> 27


Example: Loading a sound after build 20170811/60 - no need to specify "sound capabilities" in _SNDOPEN. 

s& = _SNDOPEN("song.ogg")
PRINT "READY"; s&
_SNDPLAY s&
_SNDLOOP s&


xleft = -1
xright = 1
DO
    k$ = INKEY$
    SELECT CASE k$
        CASE "f"
            xleft = xleft - 0.1
            _SNDBAL s&, xleft, , , 1
        CASE "g"
            xleft = xleft + 0.1
            _SNDBAL s&, xleft, , , 1
        CASE "h"
            xright = xright - 0.1
            _SNDBAL s&, xright, , , 2
        CASE "j"
            xright = xright + 0.1
            _SNDBAL s&, xright, , , 2
        CASE "n"
            volume = volume - 0.1
            _SNDVOL s&, volume
        CASE "m"
            volume = volume + 0.1
            _SNDVOL s&, volume
        CASE "p"
            _SNDPAUSE s&
        CASE " "
            _SNDPLAY s&
        CASE "i"
            PRINT _SNDPLAYING(s&)
            PRINT _SNDPAUSED(s&)
            SLEEP
        CASE "b"
            _SNDSETPOS s&, 110
        CASE "l"
            _SNDLIMIT s&, 10
            PRINT "LIM"
            SLEEP
        CASE "k"
            _SNDSTOP s&
        CASE "c"
            _SNDCLOSE s&
            SLEEP
            s2& = _SNDOPEN("song.ogg")
        CASE "d"
            s2& = _SNDCOPY(s&)
            _SNDPLAY s2&
    END SELECT
    LOCATE 1, 1
    PRINT xleft, xright, volume, _SNDGETPOS(s&); "   "
LOOP
Code by Johny B


See also


Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
Retrieved from "https://qb64phoenix.com/qb64wiki/index.php?title=SNDBAL&oldid=4431"