You can customize the the song information provided by AMIP and perform different actions using variables and functions listed below. Open AMIP Options and feel free to modify the presets. If you need the full power of AMIP, consider using AMIP Configurator.

Variables are prefixed with % char. You can use them in Presets, Callbacks and even files.

AMIP has built-in Tag parser supporting a lot of different formats of files and tags. The main song information is presented by the following tags:

In addition to the above tags, AMIP provides a lot of other information about song file, format specification, playlist and player state.

Using these special variables you can control the appearance of output to mIRC. More information about applying these codes you can find in mIRC Help File.

Functions should be written in $name(param) form. For example /me is listening to $lc(%name) will print song title in lower case.

One function can be inserted in another: /me now playing $u2s($cf(%name)).

$lc(string)
Lower cases the string

$uc(string)
Upper cases the string

$cf(string)
Capitalizes First Letter Of Each Word In String

$u2s(string)
Converts %20 and underscores to spaces

$ue(string)
URL encodes the argument. Necessary to pass AMIP variables to the scripts via POST and GET

$next(string)
Provides information about the next song in the playlist (valid only if shuffle is disabled). Example: $next(next song: %name [%pos])

$pad(expr,n)
Pads the result of expr with n digits, for instance, $pad(%min,0) where %min is 01 gives 1

$trunc(text,len)
Truncates string by lenght and appends "…"

$trunc2(text,len,str)
Truncates and appends str if text is longer than len

$chr(dec)
Inserts ASCII character with specified decimal code

$enc(text,enc)
Encodes text to specified encoding. (encoding can be WIN, KOI, OEM, FIDO)

$strip(pattern,subject)
Removes all matches to pattern from subject

$strrep(search,replace,subject)
Returns a string with all occurrences of search in subject replaced with the given replace value

$regrep(pattern,replacement,subject)
Searches subject for matches to pattern and replaces them with replacement

$regmatch(subject,pattern,group)
Matches subject against regexp pattern and returns the contents of parentheses group, use group = 0 for entire match. Sample: $regmatch(text::other,\(.*?\)::.*,1) will return 'text'.

Conditional constructions allow you to choose what to put into preset text depending on some condition. Condition itself can be a flag, a variable or result of other function.

At the moment there are 2 different syntax constructions for conditions. One of them is specially designed for this, second form looks like a $function.

The most basic form is:
%?VARIABLE<TRUE|FALSE>

You should read it as: if %VARIABLE is not empty, then use TRUE, otherwise use FALSE, where TRUE and FALSE can be any parts of templates, can contain text, variables and functions.

Sample: %?4<"%4"|>
The above will print album name only in case if it's not empty.

More advanced form of the above uses regular expression pattern matching:
%?VARIABLE='pattern'<TRUE|FALSE>

Basically, it's the same, but the condition is true if variable matches the pattern and is false otherwise.

Sample: %?id3v1='yes'<File has ID3v1 tag|No tag present>
Pattern must be enclosed in single quotes!

You can also use the so called functional syntax of the above with some variations:

$if(a,b,c)
If a is not an empty string, b will be used, otherwise c: $if(%1,%1 - %2,%name).

$if2(a,b)
Same as $if(a,b,).

$if3(a,b)
Same as $if(a,a,b).

$mat(subj,patt)
Returns 1 if subject matches regexp pattern, otherwise returns empty string. Main purpose is to be used in conditional functions.
Sample: $if($mat(%id3v1,yes),File has ID3v1 tag,No tag present).

$iflen(str,len,shortstr)
If str is longer than len, use shortstr, otherwise use str.

You can use action commands in Presets & Callbacks.

/cmsg
(mIRC specific) If format string starts with this command all output will be directed only to the list of channels specified in options.

/cme
(mIRC specific) Same as /cmsg, but as /me command.

/exec:(application) arguments
Executes the application with specified command line arguments. For example you can execute the FTP client to upload file, prepared by /template command. Note: working directory is set to the directory of the application executable.

/template:(input_file) output_file
Takes the input_file, replaces all the variables and functions and writes the result to output_file.

/fileonce:(filename) command
Writes current song to file instead of mIRC. Useful to integrate AMIP with program without DDE, for example e-mail client, e.g in AMIP: /fileonce:(e:\current.log)%name and in The Bat!: Winamp is playing: %INCLUDE="e:\current.log" as a part of e-mail template. Use \n in command to write multiple lines into file.

/file:(filename) command
Writes log to file (appends to the file!).

/msn(manual)title::artist::album
Use in callbacks to change text in MSN Messenger depending on the player state, replace title, artist and album with AMIP variables.

/msn(alt)format
Sends song info formatted according to format to the MSN Messenger.

/msn(clear)
Clears status in the MSN Messenger. For example, put in Pause callback to clear status when player is paused.

/skype format
Sends song info formatted according to format to Skype. Read tutorial for details.

/yahoo format
Sends song info formatted according to format to Yahoo! Messenger.

/gtalk format
Sends song info formatted according to format to Google Talk.

/aimstatus format
Sets AIM status message to text using format.

/aimprofile format
Sets AIM profile text to format.

/aimreplace format
Replaces %song in AIM profile with the specified text.

/aimrestoreprofile
Restores AIM profile to its original state.

/socket(host,port,timeout)message
Sends message to AMIP Remote client with the specified host, port and timeout. This allows to announce to multiple clients with different hosts/ports from one preset.

/flash(LAMP)
Flashes keyboard LAMP, LAMP can be NUM, SCROLL or CAPS.

/flash(LAMP,delay_ms,flash_ms,count)
For example, /flash(NUM,0,200,5) will start flashing NUMLOCK with the initial delay 0, in each state (ON/OFF) lamp will be 200ms and will flash 5 times.

These commands are universal and can be used from any client and via AMIP SDK. You can control player, AMIP, request song information, change AMIP configuration and so on.

The main difference is how commands are executed from client. It depends on the communication API being used and on the integration specifics.

For example control pause command triggers playback pause state.
Using mIRC DDE API:

/dde mplug control pause

/dde is mIRC built-in command, mplug is AMIP DDE server name, control pause is the command itself.

From mIRC Socket API (when ac.dll is installed), it can be invoked like:

/dll ac mexec control pause

/dll is mIRC command to invoke functions in libraries, ac is the name of AMIP socket library (ac.dll), mexec is ac library execution command, control pause is again the API command.

Using AMIP Java SDK the code would look like:

Client c = Client.getInstance();
c.init();
c.execute("control pause");

If you are not sure how to use the below commands from your client, please consult the documentation which should be bundled with the integration you are using.

control >
Plays next entry.

control <
Plays previous.

control play
Starts playback.

control stop
Stops playback.

control pause
Pauses playback.

control vol x
Sets volume to x (0-255).

control rew
Rewind 5 sec.

control ff
Fast forward 5 sec.

control vup
Volume up.

control vdwn
Volume down.

control repeat
Toggles repeat.

control shuffle
Toggles shuffle.

setrepeat on/off
Sets repeat to on or off.

setshuffle on/off
Sets shuffle to on or off.

control exit
Shuts down the player. Supports Winamp, ITunes, QCD/QMP, Fooobar.

control minimize/restore
Minimize/restore player window.

jumptotime SS
Jumps to SS seconds from the start of the currently playing song.

setplpos index
Sets playlist position, index is 1-based.

The following API commands were designed to be used from the client command line (like mIRC command line). You can use them to search songs and play search results directly from your client.

rfind handler pattern
This command will find all songs from current playlist matching pattern. Player starts to play matched songs (if autoplay is on, see below). Pattern may be a part of song title and is treated as regular expression. If AMIP has no cached playlist, it will be indexed automatically (see index command below).

find handler keyword
Same as rfind, but doesn't support regular expressions.

play index
Plays song from the playlist with the specified index (1-based!).

getlistlength "" handler
Prints entire playlist length.

getlist idx_from idx_to
Prints a part of playlist from idx_from to idx_to.

reindex
Re-indexes player playlist. If there are changes that AMIP can't detect automatically, invoke this command to synchronize AMIP playlist data with the actual player playlist. It may take some time to complete with large playlists (thousands of entries), therefore progress dialog is displayed. API command call returns only when indexing is finished and may timeout if it takes too long.

reindexq
Quietly re-indexes playlist in async mode (in background thread) without progress dialog. API call returns instantly.

reindexa
Same as reindexq, but progress dialog will be displayed.

clear
Clears local playlist (search results), and cached player playlist.

clearcache
Clears cached song information. Use if you want AMIP to re-read tag information from updated file without restart.

autoplay on/off
Toggles autoplay after find and rfind commands. If set to on, then AMIP will start playing the list of found songs automatically.

announce
Announces current song to the client using current preset. Works even when automatic announcing mode is off. This is the command you should use in mIRC and other clients to trigger song information display. For instance, in mIRC you can use it like /dde mplug announce or /dll ac mexec announce (if ac.dll is present). This can be aliased, for detailed mIRC instructions see this tutorial.

announce preset N
Same as announce, but use preset N (1..5).

announcesong N
Announces song with playlist index N by invoking current preset.

announcesong N X
Announces song N by invoking preset X (1..5).

search
Shows AMIP search dialog.

options
Shows AMIP options screen. If AMIP Configurator is installed, it will be executed automatically instead of native options dialog which is obsolete.

control on
Enables AMIP.

control off
Disables AMIP.

getstrip
Displays current output preset value without the control codes.

cfg_enabled "" handler Prints 1 if AMIP is enabled, 0 - otherwise.

cfg_convert "" handler
Prints 1 if convert check-box is enabled, 0 - otherwise.

cfg_strip "" handler
Prints 1 if strip check-box is enabled, 0 - otherwise.

getplain "" handler
Displays current output preset value.

getcodes "" handler
Displays current output string value translating &xx variables to control codes .

preset N
Changes active preset to N (1..5).

set "" str
Sets output preset to str value.

help
Displays the help.

manual page.htm
Displays page.htm from the AMIP chm help.

format handler format_string
Calls handler using format_string with variables (commands are not handled).

setdde server_name
Changes DDE Server name AMIP communicates with, DDE stack is automatically reinitialized.

setpirch on/off
Allows to switch from mIRC to PIRCH mode and back. Note: you will need to call setdde with appropriate server name to finish the process of IRC client switching.

setmapping on/off
Changes the way how AMIP communicates with mIRC from DDE to FileMapping and back.