Editing mirc/identifiers/$sound

{{mirc title|$sound identifier}}'''$sound''' is a powerful identifier that can be used to retrieve various information about sound files, including: directories which contain specific sounds file types, as well as [[ID3 tags]] associated with sound files which support them.

'''Note:''' This command is also a part of the {{mIRC|playing music}} section.

== Synopsis ==
<pre>$sound(<type>)</pre>

Possible value for <type>:
* mp3 - Return the mp3 folder
* midi - Return the midi folder
* wave - Return the wave folder

$sound without parameters returns the default folder for music in general.

<pre>$sound(filename>)[.property]</pre>

== Properties ==
If used with a music filename, the following properties are available:

'''Note:''' Only mp3, ogg, and wma files currently support the following properties. Keep in mind that not all properties may have been set. Each property returns the id3v1 values. For id3v2, use the ''.tag'', and ''.tags'' properties.

: <span style="display: inline-block; width: 110px;">'''album'''</span>Retrieves the specified album name sound file.
: <span style="display: inline-block; width: 110px;">'''title'''</span>Returns the song title for the file.
: <span style="display: inline-block; width: 110px;">'''artist'''</span>Returns the artist name for the file.
: <span style="display: inline-block; width: 110px;">'''year'''</span>Returns the year associated with the song release.
: <span style="display: inline-block; width: 110px;">'''comment'''</span>Returns any comments made by the file creator.
: <span style="display: inline-block; width: 110px;">'''genre'''</span>Grabs the genre for the file, if set.
: <span style="display: inline-block; width: 110px;">'''track'''</span>Retrieves the track number associated with the song.
: <span style="display: inline-block; width: 110px;">'''length'''</span>Returns the full length of the song in milliseconds.
: <span style="display: inline-block; width: 110px;">'''version'''</span>Gets the version number of the song, or track.
: <span style="display: inline-block; width: 110px;">'''bitrate'''</span>Returns the [[bitrate]] for the file.
: <span style="display: inline-block; width: 110px;">'''vbr'''</span>Returns ''$true'' or ''$false'' if variable bit rate is found.
: <span style="display: inline-block; width: 110px;">'''sample'''</span>Returns the [[sampling frequency]].
: <span style="display: inline-block; width: 110px;">'''mode'''</span>Returns the mode: ''mono'', ''stereo'', etc.
: <span style="display: inline-block; width: 110px;">'''copyright'''</span>Returns any copyright information.
: <span style="display: inline-block; width: 110px;">'''private'''</span>Returns ''$true'' or ''$false'' for the private tag.
: <span style="display: inline-block; width: 110px;">'''crc'''</span>Returns ''$true'' or ''$false'' if crc is found.
: <span style="display: inline-block; width: 110px;">'''.id3'''</span>Returns the [[id3]] tag information.
: <span style="display: inline-block; width: 110px;">'''.tag'''</span>Used to retrieve [[id3v2]] information.
: <span style="display: inline-block; width: 110px;">'''.tags'''</span>Used to retrieve [[id3v2]] information.

== Examples ==
Echo the artist name of the currently playing mp3 file to the active window:
<source lang="mIRC">//echo -a $sound($insong.fname).artist</source>

Create a small alias that will open a window, @id3info, and echo some basic info about the currently playing song to it:
<source lang="mIRC">alias id3info {

  ; First, we check to make sure we currently have an mp3, ogg, or wma file playing
  if ($insong) {

    ; If the @id3info window is open, clear it, otherwise create it.
    $iif($window(@id3info),clear @id3info,window @id3info)

    echo @id3info Artist: $sound($insong.fname).artist
    echo @id3info Track: $sound($insong.fname).track
    echo @id3info Title: $sound($insong.fname).title
    echo @id3info Album: $sound($insong.fname).album

    ; The below calculation converts the milliseconds for the sound
    ; file length into the format mm:ss, or minutes:seconds. Note that
    ; this does not properly support lengths over 59 minutes and 59
    ; seconds long.
    echo @id3info Length: $replace($round($calc($sound($insong.fname).length / 1000 / 60),2),.,:)
    echo @id3info Year: $sound($insong.fname).year
  }
}</source>

== Compatibility ==
{{mIRC compatibility|6.0}}

== See Also ==
* {{mIRC|playing music}}
* {{mIRC|on midiend}}
* {{mIRC|on mp3end}}
* {{mIRC|on nosound}}
* {{mIRC|on waveend}}
* {{mIRC|$inmidi}}
* {{mIRC|$insong}}
* {{mIRC|$inwave}}
* {{mIRC|$vol}}
* {{mIRC|/splay}}
* {{mIRC|/vol}}
{{mIRC identifier list}}

[[Category:mIRC identifiers|sound]]