. DirectXtras Home
        Home

DirectCommunication Xtra
DirectConnection Xtra
DirectControl Xtra
DirectEmail Xtra
DirectFTP Xtra
DirectImage Xtra
DirectInteraction Xtra
DirectOS Xtra
Documentation
License Agreement
Licensing Fees
Order Form
DirectSMS Xtra
DirectSound Xtra
DirectTransition Xtra
DirectTransition3D Xtra Set I
DirectTransition3D Xtra Set II
DirectTransition3D Xtra Set III
DirectTTS Xtra
XtrAgent
DirectXport Xtra

SpeechPlugin

Special Discounted Bundles

The Gallery
How To Order
Order Form
Check for Upgrades

Sign in
Change Your Profile

Contact Us
















    .
DirectXtras
Xtra Power for Director & Authorware



DirectOS Xtra
 Directing Windows and MacOS. The OS at your fingertips!

Authorware 4.x Compatible Authorware 5.x CompatibleAuthorware 6.x CompatibleAuthorware 7.x CompatibleDirector 5.x Compatible Director 6.x CompatibleDirector 7.x Compatible Director 8.x CompatibleDirector MX Compatible     MacOS 8.x and 9.x CompatibleMacOS X CompatibleWindows Compatible   

dosGetVolume(string SoundChannel)

Retrieves the volume and mute information of the specified sound channel.

Parameter :

SoundChannel : A string specifying the sound channel. This parameter is case insensitive. 

Possible Values For Windows And MacOS :
"Master Out Volume"

Possible Values For Windows Only :
"Master Out Mute"

"Master In Volume"

"Wave Out Volume"
"Wave Out Mute"
"Wave In Volume"
"Synthesizer Out Volume"
"Synthesizer Out Mute"
"Synthesizer In Volume"
"PhoneLine Out Volume"
"PhoneLine Out Mute"
"PhoneLine In Volume"
"Aux Out Volume"
"Aux Out Mute"
"Aux In Volume"
"TV Out Volume"
"TV Out Mute"
"TV In Volume"
"Microphone Out Volume"
"Microphone Out Mute"
"Microphone In Volume"
"Line Out Volume"
"Line Out Mute"
"Line In Volume"
"CD Out Volume"
"CD Out Mute"
"CD In Volume"

Possible Values For MacOS Only :
"Beep Out Volume"
"Beep Out Mute"
 

Return Value :  The returned type and value depends on the value of the SoundChannel parameter. For Volume information, this could be a value between 0 (complete silence) to 65535 (maximum volume). For Mute information, this could be 1 if the channel is muted and 0 (zero) otherwise. If the method is unsuccessful, 0 is returned, however 0 does not necessarily imply that the method failed. If 0 is returned, call dosGetLastError() to determine the cause of the error.

Possible Returned Error Codes via dosGetLastError() :
10001 : Invalid value for the sound channel.
10042 :
Sound channel is not available.



DirectXtras Inc.
P.O Box 2645, Menlo Park, CA, 94026, U.S.A
Voice: +1-415-5058249, Fax: +1-801-8585841
Toll Free: 1-800-4453093
E-mail General Information: info@directxtras.com
E-mail Technical Support: support@directxtras.com

Copyright 1996-2004 DirectXtras Inc. All Rights Reserved.
WebMaster: tamar@directxtras.com
Last Updated: 12/18/2002 11:18:02 PM.