Developer’s guide

• Getting Started
  • Setting up a Development Environment
    • Linux
    • Windows
    • OSX
    • Other instructions
  • Useful documentation
  • Useful tools
  • Editor setup
    • Atom
    • Eclipse + pydev
  • Running the tests
• Contributing to Exaile
  • Translating Exaile
    • Python string formatting
    • GTK+ keyboard mnemonics
• Debugging Exaile
  • What’s an easy way to test stuff without wrecking my actual collection?
  • Debugging options for Exaile
  • Where can I find log files?
  • Viewing stack traces when Exaile hangs
  • GStreamer Debugging Techniques
    • GST Bin Visualization
  • Using GDB to diagnose issues
    • Preparing GDB
    • Basic Usage
    • Tips for debugging issues related to Gtk+ or GLib
    • Enable diagnostic warnings
    • Eliminating Gtk-WARNING
    • Prevent X server from freezing your Desktop when debugging exaile
    • Debugging segfaults (segmentation violations)
    • Debugging freezes
    • Debugging ignored exceptions
  • Other thoughts
• Code guidelines
  • Basic Style
  • Documentation
  • Events and Signals
  • Managed object access
  • GUI
  • Logging
  • Other
• Plugin Development Guide
  • Style
  • Basic plugin structure
  • Something (slightly) more useful
  • Adding a track to the Playlist
  • Adding another page to the left-hand Notebook
  • Setting the cover art for a track
  • Make strings translatable
  • Saving/Loading arbitrary settings
  • Searching the collection
  • Exaile D-Bus
  • Playback events
  • Distributing the Plugin
    • Create a Plugin Archive
  • Exaile API
    • Building your own version of this documentation
• Windows Installer
  • Install the SDK
  • Build the installer
• Release process
  • Step 0: Upgrading the Exaile SDK for Windows (if needed)
  • Step 1: Translations
  • Step 2: Gather and update release notes
  • Step 3: Tag the release locally
  • Step 4: Update plugin versions (if needed)
  • Step 5: Push the tag
  • Step 6: Release the release
  • Final steps
  • Sending release notices

Exaile API Docs

Core:

• Collection
  • Collections
    • get_collection_by_loc()
    • Collection
      • Collection.add_library()
      • Collection.close()
      • Collection.freeze_libraries()
      • Collection.get_libraries()
      • Collection.remove_library()
      • Collection.rescan_libraries()
      • Collection.serialize_libraries()
      • Collection.stop_scan()
      • Collection.thaw_libraries()
      • Collection.unserialize_libraries()
    • CollectionScanThread
      • CollectionScanThread.on_scan_progress_update()
      • CollectionScanThread.run()
      • CollectionScanThread.stop()
  • Libraries
    • Library
      • Library.add()
      • Library.delete()
      • Library.get_location()
      • Library.get_monitored()
      • Library.get_rescan_interval()
      • Library.monitored
      • Library.rescan()
      • Library.set_location()
      • Library.set_monitored()
      • Library.set_rescan_interval()
      • Library.update_track()
    • LibraryMonitor
• Common utilities
  • General functions
    • order_poset()
  • Filesystem
    • open_file()
    • open_file_directory()
    • walk()
    • walk_directories()
  • Decorators
    • threaded()
    • synchronized()
    • profileit()
    • classproperty()
    • cached()
  • Classes
    • VersionError
    • LimitedCache
    • TimeSpan
      • TimeSpan.days
      • TimeSpan.hours
      • TimeSpan.minutes
      • TimeSpan.seconds
    • MetadataList
    • ProgressThread
      • ProgressThread.run()
      • ProgressThread.stop()
    • PosetItem
• Cover
  • Cover Manager
    • MANAGER
    • CoverManager
      • CoverManager.find_covers()
      • CoverManager.get_cover()
      • CoverManager.get_cover_data()
      • CoverManager.get_cover_for_tracks()
      • CoverManager.get_db_string()
      • CoverManager.get_default_cover()
      • CoverManager.load()
      • CoverManager.on_provider_added()
      • CoverManager.on_provider_removed()
      • CoverManager.remove_cover()
      • CoverManager.save()
      • CoverManager.set_cover()
      • CoverManager.set_preferred_order()
  • Cover Search Methods
    • CoverSearchMethod
      • CoverSearchMethod.find_covers()
      • CoverSearchMethod.get_cover_data()
      • CoverSearchMethod.name
      • CoverSearchMethod.use_cache
    • TagCoverFetcher
    • LocalFileCoverFetcher
• Events
  • log_event()
  • add_callback()
  • remove_callback()
• Formatter
  • Formatters
    • Formatter
      • Formatter.extract()
      • Formatter.format()
    • ProgressTextFormatter
      • ProgressTextFormatter.format()
    • TrackFormatter
      • TrackFormatter.format()
    • TagFormatter
      • TagFormatter.format()
    • TrackNumberTagFormatter
    • DiscNumberTagFormatter
    • ArtistTagFormatter
      • ArtistTagFormatter.format()
    • LengthTagFormatter
      • LengthTagFormatter.format()
      • LengthTagFormatter.format_value()
    • RatingTagFormatter
    • LastPlayedTagFormatter
  • Templates
    • ParameterTemplate
• Metadata
  • formats
  • get_format()
  • Format Objects
    • NotWritable
    • NotReadable
    • BaseFormat
      • BaseFormat.read_all()
      • BaseFormat.read_tags()
      • BaseFormat.write_tags()
• Player
  • PLAYER
  • ExailePlayer.play()
  • ExailePlayer.stop()
  • ExailePlayer.pause()
  • ExailePlayer.unpause()
  • ExailePlayer.toggle_pause()
  • ExailePlayer.seek()
  • ExailePlayer.get_position()
  • ExailePlayer.get_time()
  • ExailePlayer.get_progress()
  • ExailePlayer.set_progress()
  • ExailePlayer.get_volume()
  • ExailePlayer.set_volume()
  • ExailePlayer.modify_volume()
  • ExailePlayer.get_state()
  • ExailePlayer.is_playing()
  • ExailePlayer.is_paused()
  • ExailePlayer.is_stopped()
  • QUEUE
  • PlayQueue
    • PlayQueue.current_playlist
    • PlayQueue.get_current()
    • PlayQueue.get_next()
    • PlayQueue.is_play_enabled()
    • PlayQueue.next()
    • PlayQueue.play()
    • PlayQueue.prev()
    • PlayQueue.queue_length()
    • PlayQueue.set_current_playlist()
• Playlist
  • Playlists
    • Playlist
      • Playlist.append()
      • Playlist.clear()
      • Playlist.clear_shuffle_history()
      • Playlist.count()
      • Playlist.current_position
      • Playlist.dirty
      • Playlist.dynamic_mode
      • Playlist.extend()
      • Playlist.get_current()
      • Playlist.get_current_position()
      • Playlist.get_dynamic_mode()
      • Playlist.get_repeat_mode()
      • Playlist.get_shuffle_history()
      • Playlist.get_shuffle_mode()
      • Playlist.get_spat_position()
      • Playlist.index()
      • Playlist.load_from_location()
      • Playlist.name
      • Playlist.next()
      • Playlist.pop()
      • Playlist.prev()
      • Playlist.randomize()
      • Playlist.repeat_mode
      • Playlist.save_to_location()
      • Playlist.set_current_position()
      • Playlist.set_dynamic_mode()
      • Playlist.set_repeat_mode()
      • Playlist.set_shuffle_mode()
      • Playlist.set_spat_position()
      • Playlist.shuffle_mode
      • Playlist.shuffle_mode_names
      • Playlist.shuffle_modes
      • Playlist.sort()
      • Playlist.spat_position
  • Playlist Converters
    • FormatConverter
      • FormatConverter.export_to_file()
      • FormatConverter.import_from_file()
      • FormatConverter.name_from_path()
    • M3UConverter
    • PLSConverter
    • ASXConverter
    • XSPFConverter
• Providers & Services
  • MANAGER
  • register()
  • unregister()
  • get()
  • get_provider()
  • ProviderManager
  • ProviderHandler
• Settings
  • MANAGER
  • get_option()
  • set_option()
  • SettingsManager
    • SettingsManager.get_option()
    • SettingsManager.has_option()
    • SettingsManager.remove_option()
    • SettingsManager.save()
    • SettingsManager.set_option()
• Trax
  • Tracks
    • Track
      • Track.exists()
      • Track.get_loc_for_io()
      • Track.get_local_path()
      • Track.get_rating()
      • Track.get_tag_display()
      • Track.get_tag_raw()
      • Track.get_tag_sort()
      • Track.get_type()
      • Track.list_tags()
      • Track.read_tags()
      • Track.set_loc()
      • Track.set_rating()
      • Track.set_tag_raw()
      • Track.set_tags()
      • Track.write_tags()
    • is_valid_track()
    • get_uris_from_tracks()
    • get_tracks_from_uri()
    • sort_tracks()
    • sort_result_tracks()
    • get_rating_from_tracks()
  • Track Database
    • TrackDB
      • TrackDB.add()
      • TrackDB.add_tracks()
      • TrackDB.load_from_location()
      • TrackDB.remove()
      • TrackDB.remove_tracks()
      • TrackDB.save_to_location()
  • Searching
    • TracksMatcher
    • search_tracks()
    • search_tracks_from_string()
• D-Bus
  • org.exaile.Exaile Interface
    • DbusManager

GUI:

• Icons & Images
  • Icon management
    • xlgui.icons.MANAGER
    • IconManager
      • IconManager.add_icon_name_from_directory()
      • IconManager.add_icon_name_from_file()
      • IconManager.add_icon_name_from_pixbuf()
      • IconManager.pixbuf_from_icon_name()
      • IconManager.pixbuf_from_rating()
  • Utilities
    • ExtendedPixbuf
      • ExtendedPixbuf.add_horizontal()
      • ExtendedPixbuf.add_vertical()
      • ExtendedPixbuf.composite_simple()
      • ExtendedPixbuf.move()
      • ExtendedPixbuf.multiply_horizontal()
      • ExtendedPixbuf.multiply_vertical()
    • extended_pixbuf_new_from_file()