Sound UDF Documentation

[crashdemons]

I just downloaded the SFX for AutoIt v3.3.0.0

I was wondering - is the UDF help file still actively updated in the SFX copy or has the Sound UDF documentation just not been updated?

autoit-v3-sfx.exe => UDFs3.chm

Function Reference

_SoundOpen

...

Return Value

Success: Sound ID

Failure: 0

...

This is exactly as shown in earlier autoit versions, however - _SoundOpen does NOT return a Sound ID (previously "Sound ID" meant the textual ID returned by the function) in the new release, but instead returns an array.

Am I missing some documentation here?

(UDFs3.chm seems to be feeding me some old info, which is quite confusing when updating my scripts...)

Additionally, the help file implies that _SoundPlay will accept an alias string, which does not seem to be the case.

SoundPlay

Play a sound file.

...

_SoundPlay ( $sSnd_id [, $fWait ] )

Parameters

$sSnd_id Sound ID (the 'alias') as returned by _SoundOpen or a file

...

(The above clearly implies a String input, not an array for _SoundPlay ($sSnd_id) )

Thanks in any event.

From Sound.au3

$aSndID[0] = $sSndID
        ...
    $aSndID[1] = $iVBRRatio
    $aSndID[2] = 0

    Return SetError(0, $iRet, $aSndID)

From OLDER Sound.au3

If $sAlias = "" Then
        $sSnd_id = RandomStr(10)
    Else
        $sSnd_id = $sAlias
    EndIf
    ...
    Return SetError(0, $iRet, $sSnd_id)

Edited May 17, 2009 by crashdemons

[Melba23]

crashdemons,

RazerM modified the Sound.au3 code last year, based on some work I did, to get over the problem of the MCI DLL returning incorrect durations from _SoundLen when dealing with VBR files. You can find out more about it here and here if you are interested.

Essentially, _SoundOpen now returns an array in which the [0] element is the alias string (as was the case before) and the [1] and [2] elements hold corrective factors for subsequent _SoundLen calls (these factors are also used in _SoundPos and _SoundSeek, for example). From a user's point of view there is no code breaking problem - the return array from _SoundOpen is used just as the 'old' string value.

I had not realised that the Help file had not been updated along with the UDF - I will raise a ticket and offer to help with the rewrite. Thanks for noticing. :-)

M23

Edit: Ticket raised.

Edited May 17, 2009 by Melba23