Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/identifiers/$vol"
(Created $vol identifier - mIRC) |
m (→Compatibility: This was added in 5.8) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{mirc title|$vol Identifier}}'''$vol''' can be used to retrieve the current volume, from the Windows audio control, for the specified sound type parameter. | ||
| + | |||
'''Note:''' This command is also a part of the [[Playing music - mIRC|playing music]] section. | '''Note:''' This command is also a part of the [[Playing music - mIRC|playing music]] section. | ||
| − | |||
| − | |||
== Synopsis == | == Synopsis == | ||
| Line 8: | Line 8: | ||
== Parameters == | == Parameters == | ||
| − | <span style="display: inline-block; width: 70px;">'''wave'''</span>Returns the current volume for wave files. | + | <span style="display: inline-block; width: 70px;">'''wave'''</span>Returns the current volume for wave files.<br /> |
| − | + | <span style="display: inline-block; width: 70px;">'''midi'''</span>Returns the current volume for midi files.<br /> | |
| − | <span style="display: inline-block; width: 70px;">'''midi'''</span>Returns the current volume for midi files. | + | <span style="display: inline-block; width: 70px;">'''song'''</span>Returns the current volume for mp3, ogg, and wma files.<br /> |
| − | |||
| − | <span style="display: inline-block; width: 70px;">'''song'''</span>Returns the current volume for mp3, ogg, and wma files. | ||
| − | |||
<span style="display: inline-block; width: 70px;">'''master'''</span>This returns the master control volume setting for overall system volume. | <span style="display: inline-block; width: 70px;">'''master'''</span>This returns the master control volume setting for overall system volume. | ||
| Line 20: | Line 17: | ||
== Examples == | == Examples == | ||
| − | + | Echo the mute status for mp3 files to the active window: | |
<source lang="mIRC">//echo -a $vol(song).mute</source> | <source lang="mIRC">//echo -a $vol(song).mute</source> | ||
| − | + | Echo the current master system volume to the active window: | |
<source lang="mIRC">//echo -a $vol(master)</source> | <source lang="mIRC">//echo -a $vol(master)</source> | ||
== Compatibility == | == Compatibility == | ||
| − | + | {{mIRC compatibility|5.8}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[$inwave | + | == See also == |
| + | * [[Playing Music - mIRC|Playing Music]] | ||
| + | * [[On midiend - mIRC|ON MIDIEND]] | ||
| + | * [[On mp3end - mIRC|ON MP3END]] | ||
| + | * [[On nosound - mIRC|ON NOSOUND]] | ||
| + | * [[On waveend - mIRC|ON WAVEEND]] | ||
| + | * {{mIRC|$inmidi}} | ||
| + | * {{mIRC|$insong}} | ||
| + | * {{mIRC|$inwave}} | ||
| + | * {{mIRC|$sound}} | ||
| + | * {{mIRC|/splay}} | ||
| + | * {{mIRC|/vol}} | ||
| + | {{mIRC identifier list}} | ||
| − | [[ | + | [[Category:mIRC identifiers|vol]] |
Latest revision as of 06:21, 17 February 2024
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
$vol can be used to retrieve the current volume, from the Windows audio control, for the specified sound type parameter.
Note: This command is also a part of the playing music section.
Synopsis[edit]
$vol(wave | midi | song | master)
Parameters[edit]
waveReturns the current volume for wave files.
midiReturns the current volume for midi files.
songReturns the current volume for mp3, ogg, and wma files.
masterThis returns the master control volume setting for overall system volume.
Properties[edit]
muteReturns the current mute settings for the specified sound type parameter.
Examples[edit]
Echo the mute status for mp3 files to the active window:
//echo -a $vol(song).mute
Echo the current master system volume to the active window:
//echo -a $vol(master)
Compatibility[edit]
Added: mIRC v5.8
Added on: 05 Sep 2000
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.
See also[edit]
mIRC identifier list