From WikiChip
Editing mirc/playing music

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|Playing Music}}
+
{{stub}}
−
'''Playing music''' in mIRC is really a very simple process, easily accomplished through the use of the {{mIRC|/splay}} command. mIRC can also be enhanced by other sounds, not just songs, as well. Depending on how you want your own, custom mIRC experience to be, whether you are a newbie or an advanced scripter, sounds are often added to events in mIRC by some scripters. Creating games in mIRC is an advanced type of script where sounds can greatly enhance a user's experience.
+
{{mIRC Guide}}
  
−
== Enabling mIRC Sounds ==
+
'''Playing music''' in mIRC is really a very simple process, easily accomplished through the use of the [[/splay command - mIRC|/splay command]]. mIRC can also be enhanced by other sounds, not just songs, as well. Depending on how you want your own, custom mIRC experience to be, whether you are a newbie or an advanced scripter, sounds are often added to events in mIRC by some scripters. Creating games in mIRC is an advanced type of script where sounds can greatly enhance a user's experience.
 +
 
 +
= Enabling mIRC Sounds =
 
In order for you to be able to play music or any other type of sound in mIRC, you must first enable sounds. Sounds can be enabled simply by going to the options dialog (Alt+O), then clicking on the 'Sounds' option in the left-hand side list, and then placing a check mark into the ''Enable Sounds''. Below is a screenshot of the options window with the ''Enable Sounds'' option ticked.
 
In order for you to be able to play music or any other type of sound in mIRC, you must first enable sounds. Sounds can be enabled simply by going to the options dialog (Alt+O), then clicking on the 'Sounds' option in the left-hand side list, and then placing a check mark into the ''Enable Sounds''. Below is a screenshot of the options window with the ''Enable Sounds'' option ticked.
  
−
'''Note:''' Alternatively, you may use the {{mIRC|/ebeeps}} command to enable sounds in mIRC: <code>/ebeeps on</code>
+
'''Note:''' you can also use the command /ebeeps to enable sound in mIRC: <code>/ebeeps on</code>
  
 
[[File:Options-sounds2.png|Enabling mIRC Sounds]]
 
[[File:Options-sounds2.png|Enabling mIRC Sounds]]
  
−
== Supported Formats ==
+
= Support =
 
mIRC supports the following media formats: <code>.wma,.mp3,.wav,.mid,.ogg</code>
 
mIRC supports the following media formats: <code>.wma,.mp3,.wav,.mid,.ogg</code>
  
−
'''Note:''' The <code>.mp3,.wma & .ogg</code> formats are all considered the same format when using the <code>/splay</code> command.
+
'''Note:''' the .mp3, .wma and .ogg format are considered the same format when using <code>/splay</code>
  
−
Multiple file formats can be played at the same time. However, you '''cannot''' play multiple files, of the same format, at the same time. For instance, you can play a ''.wav'' file at the same time as an ''.mp3'' file, but you cannot play a ''.wav'' file and another ''.wav'' file at the same time. The second ''.wav'' file will take precedence if you're not queuing the file: the first ''.wav'' file will be stopped and the second one then played. Make sure to keep in mind what has been said regarding the formats <code>.mp3,.wma & .ogg</code>; they are all treated the same with the {{mIRC|/splay}} command, so only one of those types may play at a time.
+
Multiple file formats can be played at the same time, but you '''cannot''' play multiple files, of the same format, at the same time. For instance, you can play a ''.wav'' file at the same time as an ''.mp3'' file, but you cannot play a ''.wav'' file and another ''.wav'' file at the same time. The second ''.wav'' file will take precedence if you're not queuing the file: the first ''.wav'' file will be stopped and the second one then played.
  
−
== Synopsis ==
+
= Synopsis =
 
  <source lang="mIRC">/splay -cwmpq [filename | stop | pause | resume | seek | skip] [pos]</source>
 
  <source lang="mIRC">/splay -cwmpq [filename | stop | pause | resume | seek | skip] [pos]</source>
  
−
=== Switches ===
+
== Flags ==
−
* <code>-wmp</code> - Indicates that the feature (only Stop or Skip features may be used with these flags) will be done on the specified media format that is currently playing.
+
* -wmp - Indicates that the function (only Stop or Skip can be used with those) will be done on the specified format that are playing where -w indicated a WAVE format, -m a MIDI format and -p a MP3/OGG/WMA format. You can specify more than one switch at the same time for Stop but not for Skip.
−
** <code>-w</code> - '''WAVE format'''
+
* -q - Adds the file to a queue for that format, first file in the queue for that format is played when a song of that format ends its playback.
−
** <code>-m</code> - '''MIDI format'''
+
* [filename] - The file name for the mIRC file.
−
** <code>-p</code> - '''MP3/OGG/WMA formats'''
+
* [stop|pause|resume|seek|skip] - Allows further control over existing playing file; their titles are their respective functions. These are discussed, in more detail, further down.
−
'''Note:''' You may specify more than one of the above switches at the same time for the Stop feature, but not for Skip.
+
* [pos] - This optional parameter is used to point out the location in the music file, in milliseconds, for your sound to either start from or seek.
  
−
=== Parameters ===
+
== Playback Options ==
−
* <code>-q</code> - Adds the file to the queue for that format. The first file in the queue, for that format, is played when a song of that format ends its playback.
+
* Pause - <code>/splay pause</code> is used to pause the playing music
−
* <code>[filename]</code> - The file name for the sound file you wish to use. Typically, this only needs to be specified when you want to play or queue a file; other than those times, you would only use the flag for the sound file's type for manipulating how it acts.
+
* Resume - <code>/splay resume</code> allows you to resume the paused music file.
−
* <code>[stop|pause|resume|seek|skip]</code> - Allows further control over a sound file that is currently playing. These flags' titles are their respective functions. These are discussed, in more detail, further down.
+
* Stop - <code>/splay stop</code> will stop the current music file.
−
* <code>[pos]</code> - This optional parameter is used to point out the location in the music file, in milliseconds, for your sound to either start from or seek into.
+
* Seek - <code>/splay seek [pos]</code> will go to a certain point in the music.
 +
* Skip - <code>/splay skip</code> allows you to skip the currently playing music file. If you have only one format being used (only one queue) you can ommit the -wmp switches, and if you provide a list of switch that is invalid for Skip (for example specifying -wp), mIRC will skip the format that has been used in first to play the file (the oldests playing file)
  
−
== Music Playing, Now What? ==
+
'''Note:''' The .mp3/.wma/.ogg format does not support the Pause/Resume/Seek function nor the [pos] parameter when first playing the song.
 +
 
 +
= Music Playing, Now What? =
 
After the music is playing, you have a few options available for manipulating the playback. If you are making a full Music Player, for example in a dialog form, these options are really helpful.
 
After the music is playing, you have a few options available for manipulating the playback. If you are making a full Music Player, for example in a dialog form, these options are really helpful.
  
−
=== Playback Options ===
+
== Playback Options ==
−
* '''Pause''' - <code>/splay pause</code> is used to pause the playing music
+
* Pause - <code>/splay pause</code> is used to pause the playing music
−
* '''Resume''' - <code>/splay resume</code> allows you to resume the paused music file
+
* Resume - <code>/splay resume</code> allows you to resume the paused music file.
−
* '''Stop''' - <code>/splay stop</code> will stop the current music file.
+
* Stop - <code>/splay stop</code> will stop the current music file.
−
* '''Seek''' - <code>/splay seek [pos]</code> will go to a certain point in the music  
+
* Seek - <code>/splay seek [pos]</code> will go to a certain point in the music. Example: <code>/splay seek 1000</code>
−
* '''Skip''' - <code>/splay skip</code> allows you to skip the currently playing music file. If no other files are present in the queue for that particular sound type, no other file will play.
+
* Skip - <code>/splay skip</code> allows you to skip the currently playing music file.
−
 
 
−
=== Volume Options ===
 
−
You can control the volume of your system (and, therefore, of the music played in mIRC) with the /vol command.
 
−
==== Synopsis ====
 
−
<source lang="mIRC">/vol -wmpvuN [volume]</source>
 
−
 
 
−
==== Flags ====
 
−
* <code>-w</code> - Changes the volume for WAV files only.
 
−
* <code>-m</code> - Changes the volume for MIDI files only.
 
−
* <code>-p</code> - Changes the volume for MP3/WMA/OGG only.
 
−
* <code>-v</code> - Sets the master volume for the system, which increases volume across all levels.
 
−
* <code>-uN</code> - Sets the mute setting: N = 1 turns the mute on, N = 2 turns the mute off.
 
−
* <code>[volume]</code> - A number indicating the volume, range from 0 (no sound) to 65535 (max).
 
−
 
 
−
== Sound Finished, Now What? ==
 
−
After a sound file has finished playing, it will trigger an event. These events '''will not''' trigger for a file stopped with <code>/splay stop</code> or skipped with <code>/splay skip</code> commands, regardless of the switches/parameters used.
 
−
 
 
−
The <code>ON MP3END, ON WAVEEND & ON MIDIEND</code> events will trigger for the <code>.mp3,.wma,.ogg</code>, the <code>.wav</code> & the <code>.mid</code> formats, respectively. The ''undocumented'' <code>ON SONGEND</code> event will trigger for any of these five formats.
 
−
 
 
−
=== Synopsis ===
 
−
<source lang="mIRC">
 
−
on <level>:mp3end|midiend|waveend|songend:<commands>
 
−
</source>
 
−
 
 
−
The local identifier, {{mIRC|$filename}}, will return the complete file name that has finished playing.
 
−
 
 
−
== Any useful $identifier I can use? ==
 
−
Of course! Here is the list:
 
−
 
 
−
* $vol(<wave | midi | song | master>) - Returns a number between 0 and 65535 for the specified type.
 
−
** '''Property:''' If the .mute property is used, it returns a $true/$false value, the mute setting for that type.
 
−
* $inwave, $inmidi, $insong - Return $true if the specified wave, midi, mp3/wma/ogg type is playing, $false otherwise.
 
−
** '''Properties:'''
 
−
** .fname - Returns the complete filename
 
−
** .pos - Returns the current position in the file
 
−
** .length - Returns the length of the song
 
−
** .pause - Returns $true if the song is paused
 
−
* $sound(<type>) - Returns the directory specified in the Sound Requests section of the Options dialog, where type can be wave, midi, mp3, wma, or ogg.
 
−
* $sound(<filename>) - Returns either the directory for that file type, as above, or information about the sound file. Currently, only mp3 files are supported.
 
−
** '''Properties:''' .album, .title, .artist, .year, .comment, .genre, .track, .length, .version, .bitrate, .vbr, .sample, .mode, .copyright, .private, .crc, .id3, .tag, .tags
 
−
** Return the corresponding value, the above properties always return the id3v1 values of the mp3 file. If you want to retrieve the id3v2 values, you can use the .tag and .tags properties:
 
−
<source lang="mIRC">alias showtags {
 
−
if ($1- == $null) { echo 2 -e * /showtags: please specify filename, eg. /showtags file.mp3 | halt }
 
−
echo 1 id3: $sound($1-).id3
 
−
echo 1 tags: $sound($1-).tags
 
−
var %n = $sound($1-,0).tag
 
−
while (%n > 0) {
 
−
  echo 1 tag: $sound($1-,%n).tag
 
−
  dec %n
 
−
}
 
−
}
 
−
</source>
 
  
 
== Examples ==
 
== Examples ==
−
<source lang="mIRC">
+
<code>
 
  ;Play the mp3 file, if an mp3 file is already playing, it is stopped before.
 
  ;Play the mp3 file, if an mp3 file is already playing, it is stopped before.
 
  /splay C:\Directory_To_Music_File\MusicFile.mp3
 
  /splay C:\Directory_To_Music_File\MusicFile.mp3
Line 112: Line 65:
  
 
  ;Skip the song currently playing for the wave format
 
  ;Skip the song currently playing for the wave format
−
  /splay -w skip
+
  /splay -w skip 1000
−
 
+
</code>
−
;Set the master volume to 32200
 
−
/vol -v 32200
 
−
 
 
−
;Warn if song finish while having no sound on the master volume
 
−
on *:songend:if ($vol(master) == 0) || ($vol(master).mute) echo -s * You should turn up the volume!
 
−
</source>
 
  
−
[[Category:mIRC|playing music]]
+
[[Category:mIRC]]

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/playing_music"