AudioX II

User Interface (Optional)

AudioX provides players with the ability to explore 20,653 World of Warcraft sound samples. It also allows you to exchange samples with other AudioX users via chat hyperlinks.

IMPORTANT BETA INFO

The latest version of AudioX II is a beta test version. While the majority of this beta has been tested thoroughly, the AudioX_Who plugin has only received limited testing and requires a public beta to isolate any bugs. It is strongly advised that players using this beta read the associated FAQ

Translators needed - please apply localizations here

Installation

• Extract the AudioX and AudioX_Search folder into World of Warcrafts Interface\Addons folder
  
• Enable both AudioX and AudioX_Search in Mod Settings. Note: Even though AudioX_Search is enabled, it will not normally load until you type /ax or /audiox.
  

Current Features

AudioX:

• Displays samples as chat links.
  
• Clicking on an AudioX chat-link play samples.
  
• AudioX links work in custom channels, without any other chat mods required.
  
• Exchange AudioX chat-links with other AudioX users by shift+clicking to insert the link into your outgoing message.
  
• Insert the full /script PlaySoundFile(...) command into an outgoing message by alt+clicking AudioX links.
  
• Silence audio playback by ctrl+alt+clicking any AudioX link (max of once every 5 seconds).
  
• Ctrl+clicking links adds them to AudioX's favourites list.
  
• Handles AudioX Search loading.
  
• Tooltips on links.
  
• Localization support.
  

• Search through 20,653 World of Warcraft samples.
  
• Sample library contains all of the samples upto and including 3.3.2.
  
• Play samples by a short index number (handy in macros).
  
• Define how many results AudioX returns per search.
  
• Crop links to limit word wrapping.
  
• Continue searches from the end your previous search onwards, or backwards.
  
• Start searching from a specific index (to skip unwanted samples).
  
• Create and display output to a seperate AudioX chat tab.
  
• Allows searching of your AudioX favourites.
  
• Optionally use pattern matching in searches.
  
• Features a miniAPI for 3rd party AudioX UI developers.
  
• Localization support.
  

• Set page length, line cropping, chat filter, index visibility, verbosity, chat tab and search mode via Blizzards Addon Options panel.
  

• Resizable UI that lets you search, link and play.
  
• Adjustable fontsizes.
  
• Allows searching and management of your AudioX favourites.
  
• Demonstrates the use of the AudioX miniAPI.
  

• Right-click draggable
  
• Toggles AudioX UI and AudioX Options.
  

• Builds a list of players in your guild/party/raid/battleground and friends list who can currently see AudioX chat links.
  

Usage

• /ax s <string> Search for a sample patch containing the specified keyword. E.g. /ax s brew
  
• /ax d Page Down. Find next 10 results for current search. E.g. /ax d
  
• /ax u Page Up. Find previous 10 results for current search. E.g. /ax u
  
• ax m <num> Continue search from a specific search match. E.g. /ax m 15
  
• /ax b <num> Continue search beginning at the specified sample index. E.g. /ax b 1500
  
• /ax r Refresh the last page of search results. E.g. /ax r
  
• /ax i <num> Display path details for sample index. E.g. /ax i 12345
  
• /ax p <num> Play the sample with an integer value between 1 and 18873. E.g. /ax p 16539
  
• /ax q Quiet. Stop all sounds playing. E.g. /ax q
  
• /ax favs [true/false] Toggle between searching SoundLib and Favourites. E.g /ax favs false
  
• /ax whoLists who in your guild/party/raid/battleground is using AudioX II. E.g. /ax who
  
• /ax ui Loads / toggles and AudioX II UI. E.g. /ax ui
  
• /ax options Loads / toggles the AudioX II Options. E.g. /ax options
  
• /ax <arg> Results in the equivalent of /ax s <arg>. E.g. /ax brew
  
• /ax ?? Help text page 2: Settings. E.g. /ax ??
  
• /ax l <num> Limit the number samples each search returns. E.g. /ax l 10
  
• /ax c <num> Crop sound paths to last N characters. 0 = Don't crop. E.g. /ax c 0
  
• /ax n <num> Limit pathname display. 0 = filename only, 11 = Show all. E.g. /ax n 11
  
• /ax f [true/false] Filter chat so that sample links are clickable. E.g. /ax f true
  
• /ax g [true/false] Play non-.wav sounds as looping game music. E.g. /ax g false
  
• /ax h [true/false] Hide sample index numbers in search results. E.g. /ax h false
  
• /ax x [true/false] Hide file extensions. E.g. /ax x false
  
• /ax v [true/false] Verbose output that shows which sample is playing. E.g. /ax v false
  
• /ax t [true/false] Output to AudioX chat tab. E.g. /ax t false
  
• /ax a [true/false] Autoplay link samples received from other players. E.g. /ax a false
  
• /ax z [true/false] Search with pattern matching. E.g. /ax z false
  
• /ax [?] Help text page 1: Commands. E.g. /ax ? or /ax
  

Macro

Several players have mentioned that they like to keep the number of enabled mods to a bare minimum.
As AudioX is hardly essential in day to day World of Warcraft gameplay, I've created a macro that
allows you to keep the entire AudioX suite disabled (in addon options) when you don't need it. When
you do need it, click the macro button and the AudioX will load for the current game session only,
without any need to reload the game session. The macro is as follows (it's a single, long line):-

/run u="AudioX";v="AudioX_Who";w="AudioX_Search";x="AudioX_Options";y="AudioX_UI";z="AudioX_Minimap"; e=EnableAddOn;d=DisableAddOn;l=LoadAddOn;e(u);e(v);e(w);e(x);e(y);e(z);l(u);l(v);l(w);l(x);l(y);l(z);d(u);d(v);d(w);d(x);d(y);d(z)

A full explanation of how the macro works can be found on my author portal FAQ

Note: You can still configure the AudioX to load whenever you start the game. This macro is just an
additional facility.

Known Bugs/Issues

• Garbage Collection may reset AudioX searches if AudioX has been inactive within the game session for a long time. If this happens you can use /ax b

Notes

• AudioX is my first World of Warcraft mod.
  
• AudioX II uses a different link format from my original AudioX. Please upgrade to AudioX II.
  
• I only upload AudioX to the following sites:
  http://www.wowinterface.com/downloads/info14100-AudioX.html
  http://wow.curse.com/downloads/wow-addons/details/audiox.aspx
  http://wow.curseforge.com/addons/audiox/

AudioX mini-API (for Mod Developers)

• Details in my Author Portal FAQ

Credits

• Krakhaan of Khaz'goroth (Oceanic) for his inspirational AFX mod
  
• Bluspacecow for Sound Commands List
• James Whitehead II for his brilliant book World of Warcraft Programming without which this mod wouldn't exist
  
• Thorinair of EU Ragnaros for motivating me to create my own AudioX UI and accompanying API
  

DISCLAIMER

• While every effort has been made to ensure this mod is error free, you use this mod entirely at your own risk.
  

AudioX Copyright 2009-2010 Eisa of Aggramar (EU). All Rights Reserved.

• 

  Author

  AudioX

  (Project Manager)

  Downloads

  • AudioX II

Version History

AudioX II 3.3.29 BETA 6
Report bugs here

• Search: New SoundLibs for WoW 3.3.2 patch. 162 samples added (total 20653 samples) (Thanks to Bluspacecow for source data)
  

AudioX II 3.3.29 BETA 5

• Who: Fixed "You are not in a guild" bug (Thanks to Lord_Necrovore for bringing the bug to my attention)
  

AudioX II 3.3.29 BETA 4

• Who: Changes to start up
  
• Who: Debug code (switch on by typing "/run AX.DEBUG = true")
  
• Who: Should store name-realm in cross-realm groups in the AudioX_Who roster
  

AudioX II 3.3.29 BETA 3

• Who: New plugin for finding other AudioX users in your guild, friends list, raid, battleground and party (including cross-realm groups/raids/bgs).
  
• Search: Added /ax who command and associated help text.
  
• Core: If MP3 background playback is enabled and the music volume is off, AudioX will increase the volume to 50%, restoring it from 50% to off when playback is stopped or when the players character changes zones. If the volume is adjusted from the temporary value, AudioX will assume you wish to keep the new volume level.
  
• Core: Background playback now uses RaidNotice_AddMessage() to notify of temporary Sound & Voice setting changes, instead of ActionStatus_DisplayMessage() .
  
• Options: Cancel button reverts options to previous value.
  
• Options: Default button reverts options to preset values.
  
• UI: Fontsize maximum increased to 36pt
  
• UI: Cancel button in fontsize options reverts font to previous value.
  
• UI: Default button in fontsize options reverts font to preset value.
  
• Options (internal): Variable and function names start with opt_ and Options_ respectively.
  
• Search/Options/UI/Minimap/Who (internal): Namespace changed from AXUI to AX.
  
• Search/Options/UI/Minimap/Who (internal): Varible and function names start with ui_ and UI_ respectively.
  
• API: Namespace and varible name changes will effect any 3rd party UI heavily. AX.apiout -> AX.api_out, AX.CMD_* -> AX.s_CMD_* . See miniAPI docs for more.
  
• Localisations reduced back to a single file per addon.
  

AudioX II 3.3.28

• Search: New SoundLibs for WoW 3.3 patch. 1618 samples added (total 20491 samples)
  
• Search: Old AudioX link format legacy support removed.
  
• UI: AudioX II UI options panel now nested under AudioX II options as UI Fontsize.
  
• Core: Some minor internal code changes.
  

AudioX II 3.3.27 (Interim)

• TOCs changed for World of Warcraft 3.3 patch.
  

AudioX II 3.2.27

• Core: Pathname filter (/ax n) changed to allow N right-most folder display.
  
• Core: Hyperlink tooltip routines re-written as hooks.
  
• Search: Added /ax z to toggle search pattern matching on and off.
  
• Search: Changed /ax n [true|false] to /ax n <num>, where <num> = 0 to 11. 0 = filename only, 11 = show entire filepath, otherwise show N right-most folders.
  
• UI: Added UI options panel for changing the fontsize of the UI.
  
• UI: Full scaling of rows and row icons to accomodate fontsize variations.
  
• UI: Added /f <num> to search box (where <num> = 6 to 28) for changing fontsize. NOTE: /f is not a slash command. It will only work if typed into the search box.
  
• UI: Redesigned background texture tiling, thereby allowing smaller window dimensions.
  
• UI: Added code to re-search for a keyword if /ax z is toggled.
  
• UI: Added SoundLib indexes to soundpaths when in favourites mode.
  
• UI: Minor changes to account for /ax n changes.
  
• UI: Fixed: <Pending> no longer offset by sound index place holder when indexes off.
  
• UI: Fixed: Minor scaling problem in the first 20 rows.
  
• Options: Added /ax z equivalent.
  
• Options: "Hide path" checkbox changed to "Display right most N folders" slider.
  
• Options: (Experimental) Whole panel is movable.
  
• API: Added AX:API_IndexFromPath(soundpath,usingsoundlib) - see API docs.
  

AudioX II 3.2.26

• Core: Added the option to play non-wav samples as background music.
  
  
  
  • Samples automatically loop until they are stopped or another non-wav is selected.
    
  • Samples play this way automatically cross fade.
    
  • wav files are omitted as they mostly contain dialogue or spot effects.
    
• Core: Automatically changes the Music setting in Audio & Voice settings to "on" as required for the new playback method. If AudioX changes the setting, it will restore it to "off" when the sample is stopped or when a loading screen appears. "Music en/disabled" messages show in the middle of the screen when this happens.
  
• Core: Improved file extension pattern matching.
  
• Core: Added tooltips to chatframe hyperlinks.
  
• Core: Fixed potential error if verbose mode on during playback.
  
• Search: Added /ax g for using the game's background music "channel".
  
• Search: Updated internal playback routine to take account of new play mode.
  
• UI: Added shaded lines in the background to help identify rows visually.
  
• UI: Some tooltip localization has moved to the AudioX Core.
  
• UI: Some internal changes to the way row elements dimensions are set up.
  
• Options: Added /ax g equivalent.
  
• Options: Corrected typo.
  

AudioX II 3.2.25

• Core: Added pathname and file extension filters.
  
• Search: Added /ax n to hide pathnames from sound links.
  
• Search: Added /ax x to hide file extensions from sound links.
  
• Options: Added checkboxes for /ax n and /ax x.
  
• API: Added AX:API_FilterPathAndExt(soundpath) for applying /ax n and /ax x.
  
• UI: Search text box clears focus after pressing return (click it to give it focus). This should make using the chatframe much easier when the AudioX UI is open.
  
• UI: Title appended with footer if there isn't space next to the buttons.
  
• UI: AudioX II part of the title changes red if output is redirected to the chatframe.
  

AudioX II 3.2.24b

• Adding/removing a favourite outputs a notice irrespective of verbose setting (otherwise there's nothing to suggest if the add/remove was successful)
  

AudioX II 3.2.24

• Options: Improved OnUpdate handler to reduce cpu usage.
  
• Options: Indicates which options only effect chatframe results.
  
• UI: Added OnUpdate handler to ensure that checkboxes and output matches any settings changes made outside of the UI while the UI is active.
  
• UI: Now allows hiding of index numbers.
  
• UI: Notifies when chat redirected to the chatframe.
  
• Search & UI: Chat <-> UI "hand over" conditions tweaked.
  
• Search: Added [Refresh] to chatframe results footer.
  
• Search: Notifies when chat redirected to the UI.
  
• Core: Fixed tab hiding/closing bug.
  
• Minimap: Load notice added.
  
• API: AX:API_Play and AX:API_Quiet now force AX.apiout = true (in addition to AX:API_Search)
  
• API: AX:API_UIOutput() and AX:API_ChatOutput(notice_to_chat) functions added. They set AX.apiout=true and AX.apiout=false respectively and notify player.
  
• /ax api removed.
  
• Verbose option bypassed when UI is active. That is, verbose output is effectively on while the UI is visible (ie.AX.apiout=true).
  
• Localization file split into language specific files in a bid to make it easier for any translators who wish to help with the AudioX localization.
  

AudioX II 3.2.23

• Options: Added options UI (Esc > Interface > Addons > AudioX II).
  
• UI: Fixed bug where some buttons could appear with the incorrect width.
  
• UI: Added Options button.
  
• UI: <Pending> text localized and is now coloured grey.
  
• UI: Hides row specific buttons while update <Pending>.
  
• Search: /ax options opens options panel.
  
• Search: Internal changes to config validation.
  
• Minimap: Shift+Click opens options panel.
  
• Core: Generic Plugin loader added.
  
• Core: Removed workaround for hiding chat tab.
  

AudioX II 3.2.22

• Core: Silence audio playback by CTRL+ALT+clicking any AudioX link.
  
• Core: CTRL+click any AudioX sound link to add/remove it to your AudioX favourites.
  
• Search: /ax favs toggles favourite searching on and off.
  
• UI: Added star button to toggle favourite searching on and off.
  
• UI: Added small star buttons for adding/removing individual favourites.
  
• UI: Made the link and play icons smaller.
  
• UI: Added tooltip to the resize handle.
  
• UI: Tidied up the instruction page so it's not lop-sided.
  
• API: Added AX:API_ToggleFavMode(bool) to give equivalent of /ax favs [true|false].
  
• API: Added added = AX:API_ToggleFavSample(sound) to add/remove favourite, where added is true if the same was added to favourites.
  
• SoundLib references replaced with _G[AX.searchmode].
  
• IMPORTANT: AudioX API switches between SoundLib and AUDIOX_FAVS tables. 3rd party AudioX UIs should replace all references to SoundLib with _G[AX.searchmode] .
  

AudioX II 3.2.21

• Linking activity will now open a chatframe editbox if one isn't already open.
  
• Alt+Clicking links results inserts "/script PlaySoundFile(<sound>)" in outgoing chat. Note: There are no restrictions on global channels.
  
• UI: Alt+Clicking link icon or path text inserts "/script PlaySoundFile(<sound>)" in outgoing chat. Note: There are no restrictions on global channels.
  
• UI: Scaling issue fixed.
  
• API: Added AX:API_LinkSlashCmd(soundpath) for linking "/script PlaySoundFile(<sound>)".
  

AudioX II 3.2.20

• Search: Improved search routines that improve overall search speed.
  
• Search: /ax b <num> returns results instead of effecting the next search.
  
• UI: Frame moved to a higher layer so that it's above middle layer detritus.
  
• UI: Minor fix to remove unwanted ellipsis (...) appearing incorrectly appearing both to the left and right of long soundpaths that have been trimmed to fit the UI.
  
• UI: Enter /b <num> or /m <num> directly into the UI search box to jump to a specific result in the current search (same as /ax b <num> and /ax m <num>)
  
• UI: Remembers window size and position.
  
• UI: Play and Link buttons hidden until first search.
  
• UI: Index and Path (overlay) buttons hidden when theres no corresponding result.
  
• UI: Fixed a few typos in the help text.
  
• UI: Buttons have standard UI sounds.
  
• Minimap: Added optional AudioX_Minimap button addon for loading/toggling the UI.
  
• Improved event handling.
  

AudioX II 3.2.19

• UI now resizable.
  
• UI now has tooltips.
  
• UI components restructured so that frames etc have proper names.
  
• Added /ax m <num> to Continue a search from a specific match.
  
• Added /ax r to refresh the last search.
  
• Fixed notices vanishing from AudioX UI if the interface is hidden then shown.
  
• Updated AX:API_Play(sound) so that it's bound by the same 0.5 sec limit on plays to reduce the chance of accidental double-clicking.
  
• Updated AX:API_Search(cmd,keyword) so that cmd can be AX.CMD_MATCH for /ax m <num> functionality. Keyword should be a number. Automatically validated.
  
• Updated AX:API_Search(cmd,keyword) so that c,d can be AX.CMD_REFRESH for /ax r functionality. Keyword is ignored.
  

AudioX II 3.2.18

• Added AudioX_UI (thanks to Thorinair for motivation, after I co-wrote his AudioX UI).
  
• Added /ax ui to open AudioX_UI.
  
• Added AX:API_Notice(msg) capture any notices from AudioX and AudioX_Search.
  
• Added AX:API_Play(sound) plays soundpaths or soundindex.
  
• Added AX:API_Quiet() to silence playback.
  
• Updated AX:API_Search(anything,"#512") is the same as /ax i 512 (so is /ax s #512).
  
• Updated AX:API_LinkSoundPath(soundpath) accepts sound index number or soundpath string.
  
• Fixed page skipping when searching back to the previous page.
  

AudioX II 3.2.17

• Small change to stop the AudioX API potentially blocking /ax based searches.
  
• /ax s, /ax d, /ax u and /ax i all force AX.apiout to false (directing output to chat).
  
• AX:API_Search forces AX.apiout to true (allowing plugins to hook output).
  

AudioX II 3.2.16

• API functions added to AudioX_Search
  
• AX:API_PageSize(resultsperpage)
  
• AX:API_Search(cmd,keyword)
  
• AX:API_LinkSoundPath(soundpath)
  
• AX:API_LineOut(key,path)
  
• AX:API_PageFooter(first,last,total,search)
  
• /ax api added toggles API output mode (for mod developers)
  

AudioX II 3.2.15

• Added /ax <arg> so that /ax orc works like /ax s orc.
  
• Added /ax ? for help. Also shows help if /ax with no arguments.
  
• Internal: garbage collection should be less likely to reset searches.
  
• Internal: Use string.format rather than concat as generates less garbage.
  
• Fixed: Clicking in general tab while undocked AudioX tab is visible no longer results in /ax t false.
  
• Fixed: /ax c validation now allows /ax c 0 (ahem!).
  

AudioX II 3.2.14

• First non-alpha / non-beta release!
  
• Fixed chat tab showing when /ax t false after UI loaded.
  
• Detects if the chat tab closed using mouse and sets /ax t false.
  
• Detects if player creates "AudioX" tab manually, setting /ax t true.
  
• Chat tab code re-jigged and moved to AudioX mod. Necessary evil.
  
• [Quiet] and /ax q notice only displays if /ax v true.
  

AudioX II alpha.13 (extensive rewrite)

• New link format {AudioX2:Sound\Music\ZoneMusic\BrewFest\BF_Goblins1.mp3} .
  
• Split into two modules: Light-weight AudioX for handling links and heavy-weight AudioX-Search for searching.
  
• Removed AddonLoader requirement.
  
• SoundLib only loads with Load-On-Demand AudioX-Search.
  
• Removed requirement for sender and recipient SoundLibs being the same.
  
• Removed soundlib checksum and version code from links.
  
• Removed /ax ! and associated text and link colours.
  
• Any valid linked soundpaths will play whether or not they are in your copy of SoundLibs.
  
• Search module provides some short-term legacy support for old link format.
  
• Added Control+Click on any AudioX link to silence playback (e.g. /ax q).
  
• /ax l limited to values between 1 and 500.
  
• Lots of behind the scenes changes to accomodate the new format.
  

• Corrected SoundLib (18873 samples)
  

AudioX I beta.11

• Added /ax b to allow the next search to start from any given sample index.
  
• Removed limit on /ax s minimum keyword length. Just don't set /ax l too high (500+), else you may get a forced disconnect (something to fix in a future version)
  
• Fixed global channel identification so that guild, raid etc are no longer (incorrectly) identified as global channels.
  

AudioX I beta.10

• TOC changed for WoW 3.2.0
  
• New SoundLib (19307 samples)
  
• Added /ax a to allow autoplay when a link (allowing one every 5 secs)
  
• Added block on any AudioX links that are sent to global channels to prevent AudioX data appearing in General, Trade, LFG etc channels
  

AudioX I alpha.9

• /ax m changed to /ax d (for page Down)
  
• /ax b changed to /ax u (for page Up)
  
• Search results footer now contains [PGDN] and [PGUP] command links that issue /ax d and /ax u commands
  
• Localization now allows /ax <cmd> part to be altered to suit language
  
• Help code re-written to take account of localization changes etc
  
• Internal changes: link colour codes now contain alpha as well as rrggbb values
  

AudioX I alpha.8

• Fixed interfence from Prat's Channel Link module on outbound links
  
• Made provision in case any links broken by Prat's Channel Link module are received from older versions of AudioX (which don't catch links that have been incorrectly converted to {CLINK: } format by Prat's Channel Link module)
  
• Improved /ax t false so that General tab activates and the settings notice displayed there
  
• Improved /ax m so that it doesn't loop round from the final page of search results
  
• AudioX now stores almost all globals in the AX namespace
  
• Consolidated localization into the AX namespace
  
• Changed link colours to make link warning colour codes more obvious
  

AudioX I alpha.7

• Fixed [Quiet] link creation
  

AudioX I alpha.6

• Improved chat tab handling considerably
  
• Chat tab shows if /ax t trueor hides if /ax t false
• Added /ax q to stop sample playback
  
• Added [Quiet] link to search results notice
  
• Added 5 second rule limit to /ax q and [Quiet] use
  
• Added 0.5 second limit on sample playback to reduce unwanted playback from double clicking
  
• Added missing localization for search results notice
  
• Fixed chat tab snapping back to dock
  

AudioX I alpha.5

• Fixed misnamed localization variable reference breaking page limit setup
  

AudioX I alpha.4

• Fixed saved variables table which was nil if audiox not previously loaded
  

AudioX I alpha.3

• Initial public release