From WikiChip
Editing mirc/identifiers/$sound

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 1: Line 1:
−
{{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.
+
'''$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 identifier is also a part of the {{mIRC|playing music}} section.
+
== Synopsis ==
 +
<pre>$sound(<type|filename>)[.property]</pre>
 +
 
 +
== Properties ==
 +
''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.
  
−
== Synopsis ==
+
<span style="display: inline-block; width: 110px;">'''length'''</span>Returns the full length of the song in milliseconds.
−
<pre>$sound(<type>)</pre>
+
 
 +
<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>Gets the [[variable bit rate]] for the file.
 +
 
 +
<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.
  
−
Possible value for <type>:
+
<span style="display: inline-block; width: 110px;">'''copyright'''</span>Returns any copyright information.
−
* 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.
+
<span style="display: inline-block; width: 110px;">'''private'''</span>Returns ''$true'' or ''$false'' for the private tag.
  
−
<pre>$sound(filename>)[.property]</pre>
+
<span style="display: inline-block; width: 110px;">'''crc'''</span>Returns ''$true'' or ''$false'' if crc is found.
  
−
== Properties ==
+
<span style="display: inline-block; width: 110px;">'''.id3'''</span>Returns the [[id3]] tag information.
−
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;">'''.tag'''</span>Used to retrieve [[id3v2]] information.
  
−
: <span style="display: inline-block; width: 110px;">'''album'''</span>Retrieves the specified album name sound file.
+
<span style="display: inline-block; width: 110px;">'''.tags'''</span>Used to retrieve [[id3v2]] information.
−
: <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 ==
 
== Examples ==
−
Echo the artist name of the currently playing mp3 file to the active window:
+
'''Echo the artist name of the currently playing mp3 file to the active window'''
 
<source lang="mIRC">//echo -a $sound($insong.fname).artist</source>
 
<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:
+
'''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 {
 
<source lang="mIRC">alias id3info {
  
Line 68: Line 73:
  
 
== Compatibility ==
 
== Compatibility ==
−
{{mIRC compatibility|6.0}}
+
Added: mIRC v6.0
 +
 
 +
Added On: 03/02/2002
  
 
== See Also ==
 
== See Also ==
−
* {{mIRC|playing music}}
+
[[On waveend - mIRC|ON WAVEEND Event]]
−
* {{mIRC|on midiend}}
+
 
−
* {{mIRC|on mp3end}}
+
[[/splay command - mIRC|/splay]]
−
* {{mIRC|on nosound}}
+
 
−
* {{mIRC|on waveend}}
+
[[/vol command - mIRC|/vol]]
−
* {{mIRC|$inmidi}}
+
 
−
* {{mIRC|$insong}}
+
[[$inmidi identifier - mIRC|$inmidi]]
−
* {{mIRC|$inwave}}
+
 
−
* {{mIRC|$vol}}
+
[[$insong identifier - mIRC|$insong]]
−
* {{mIRC|/splay}}
+
 
−
* {{mIRC|/vol}}
+
[[$inwave identifier - mIRC|$inwave]]
−
{{mIRC identifier list}}
 
  
−
[[Category:mIRC identifiers|sound]]
+
[[$vol identifier - mIRC|$vol]]

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://en.wikichip.org/wiki/mirc/identifiers/$sound"