From WikiChip
Difference between revisions of "mirc/identifiers/$vol"
< mirc‎ | identifiers

m (Bot: Fixing compatibility)
m
 
(2 intermediate revisions by one other user 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.
  
 
'''$vol''' can be used to retrieve the current volume, from the Windows audio control, for the specified sound type parameter.
 
  
 
== 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'''
+
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'''
+
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>
  
Line 29: Line 26:
 
{{mIRC compatibility|6.0}}
 
{{mIRC compatibility|6.0}}
  
== See Also ==
+
== See also ==
 
* [[Playing Music - mIRC|Playing Music]]
 
* [[Playing Music - mIRC|Playing Music]]
 
* [[On midiend - mIRC|ON MIDIEND]]
 
* [[On midiend - mIRC|ON MIDIEND]]
Line 43: Line 40:
 
{{mIRC identifier list}}
 
{{mIRC identifier list}}
  
[[Category:MIRC identifiers]]
+
[[Category:mIRC identifiers|vol]]

Latest revision as of 18:10, 22 September 2017

$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 v6.0
Added on: 03 Feb 2002
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See also[edit]

v · d · e mIRC identifier list

$ $$, $, $0, $1-, $!, $&, $*, $+, $++, $?

A $abook, $abs, $acos, $active, $activecid, $activewid, $adate, $address, $addtok, $addtokcs, $agent, $agentname, $agentstat, $agentver, $alias, $and, $anick, $ansi2mirc, $aop, $appactive, $appstate, $asc, $asctime, $asin, $atan, $atan2, $auto, $avoice, $away, $awaymsg, $awaytime

B $banlist, $banmask, $base, $beta, $bfind, $bindip, $bitoff, $biton, $bits, $bnick, $bvar, $bytes

C $calc, $caller, $cancel, $cb, $cd, $ceil, $chan, $chanmodes, $channel, $chantypes, $chat, $chr, $cid, $clevel, $click, $cmdbox, $cmdline, $cnick, $color, $colour, $com, $comcall, $comchan, $comchar, $comerr, $compact, $compress, $comval, $cos, $cosh, $count, $countcs, $cr, $crc, $creq, $crlf, $ctime, $ctimer, $ctrlenter

D $date, $day, $daylight, $dbuh, $dbuw, $dccignore, $dccport, $dde, $ddename, $debug, $decode, $decompress, $deltok, $devent, $dialog, $did, $didreg, $didtok, $didwm, $dir, $disk, $dlevel, $dll, $dllcall, $dname, $dns, $dqwindow, $duration

E $ebeeps, $editbox, $email, $emailaddr, $encode, $envvar, $error, $eval, $evalnext, $event, $eventid, $eventparms, $exists, $exiting

F $false, $feof, $ferr, $fgetc, $file, $filename, $filtered, $find, $finddir, $finddirn, $findfile, $findfilen, $findtok, $findtokcs, $fline, $flinen, $floor, $font, $fopen, $fread, $fromeditbox, $fserv, $fserve, $fulladdress, $fulldate, $fullname, $fullscreen

G $get, $getdir, $getdot, $gettok, $gmt, $group

H $halted, $hash, $height, $hfile, $hfind, $hget, $highlight, $hmac $hmatch, $hnick, $host, $hotline, $hotlinepos, $hotlink, $hotp, $hregex, $hypot

I $iaddress, $ial, $ialchan, $ibl, $idle, $iel, $ifmatch, $ifmatch2, $ignore, $iif, $iil, $inellipse, $ini, $initopic, $inmidi, $inmode, $inmp3, $inpaste, $inpoly, $input, $inrect, $inroundrect, $insong, $insongpause, $instok, $int, $intersect, $inwave, $inwho, $ip, $iptype, $iql, $isadmin, $isalias, $isbit, $isdde, $isdir, $isfile, $isid, $islower, $istok, $istokcs, $isupper, $isutf

K $keychar, $keyrpt, $keyval, $knick

L $lactive, $lactivecid, $lactivewid, $left, $leftwin, $leftwincid, $leftwinwid, $len, $level, $lf, $line, $lines, $link, $lock, $locked, $lof, $log, $log10, $logdir, $logstamp, $logstampfmt, $longfn, $longip, $lower, $ltimer

M $maddress, $mask, $matchkey, $matchtok, $matchtokcs, $maxlenl, $maxlenm, $maxlens, $md5, $me, $menu, $menubar, $menucontext, $menutype, $mid, $mididir, $mircdir, $mircexe, $mircini, $mkfn, $mklogfn, $mknickfn, $mnick, $mode, $modefirst, $modelast, $modespl, $mouse, $mousecx, $mousecy, $mousedx, $mousedy, $mousekey, $mouselb, $mousex, $mousey, $mousewin, $mp3, $mp3dir, $msfile, $msgstamp, $msgtags

N $N, $naddress, $network, $newnick, $nhnick, $nick, $nickmode, $no, $nofile, $nopath, $nopnick, $noqt, $not, $notags, $notify, $null, $numeric, $numtok, $nvnick

O $ok, $online, $onlineserver, $onlinetotal $onpoly, $opnick, $or, $ord, $os

P $parmN, $parms, $parseline, $parsetype, $parseutf, $passivedcc, $pi, $pic, $play, $pnick, $portable, $portfree, $pos, $poscs, $prefix, $prop, $protect, $puttok

Q $qt, $query

R $r, $raddress, $rand, $rands, $rawbytes, $rawmsg, $read, $readini, $readn, $regbr, $regerrstr, $regex, $regml, $regmlex, $regsub, $regsubex, $remote, $remove, $removecs, $remtok, $remtokcs, $replace, $replacecs, $replacex, $replacexcs, $reptok, $reptokcs, $result, $rgb, $right, $rnick, $round

S $samepath, $scid, $scon, $script, $scriptdir, $scriptline, $sdir, $send, $server, $serverip, $servertarget, $sfile, $sha1, $sha256, $sha384, $sha512, $shortfn, $show, $signal, $sin, $sinh, $site, $sline, $snick, $snicks, $snotify, $sock, $sockbr, $sockerr, $sockname, $sorttok, $sorttokcs, $sound, $speak, $sqrt, $sreq, $ssl, $sslcertsha1, $sslcertsha256, $sslcertvalid, $ssldll, $ssllibdll, $sslready, $sslversion, $starting, $status, $str, $strip, $stripped, $style, $submenu, $switchbar, $sysdir

T $tan, $tanh, $target, $tempfn, $ticks, $time, $timeout, $timer, $timestamp, $timestampfmt, $timezone, $tip, $tips, $titlebar, $token, $toolbar, $topic, $totp, $treebar, $true, $trust

U $ulevel, $ulist, $unsafe, $upper, $uptime, $url, $usermode, $utfdecode, $utfencode

V $v1, $v2, $var, $vc, $vcmd, $vcmdstat, $vcmdver, $version, $vnick, $vol

W $wavedir, $wid, $width, $wildsite, $wildtok, $wildtokcs, $window, $wrap

X $xor

Y $yes

Z $zip

= =$nick