Plex Development Manual

Framework:1.0.0 Last Updated:October 19, 2009

TODO: Constants

• 1. Introduction
  • 1.1. How plug-ins work
  • 1.2. Differences between plug-ins and regular Python programs
    • 1.2.1. The print statement
    • 1.2.2. Code structure
    • 1.2.3. The framework modules
    • 1.2.4. Plug-in execution
• 2. Bundles
  • 2.1. The Info.plist file
  • 2.2. The Code directory
    • 2.2.1. The __init__.py file
  • 2.3. The Resources directory
  • 2.4. The Strings directory
  • 2.5. The Libraries directory
  • 2.6. The Helpers directory
  • 2.7. The DefaultPrefs.json file
  • 2.8. The DefaultDict.json file
  • 2.9. The DefaultDatabase.sql file
• 3. Plug-in functions
  • 3.1. Framework functions
  • 3.2. Handler functions
  • 3.3. Callback functions
  • 3.4. Data functions
• 4. Debugging
• 5. Modules
  • 5.1. Plug-in management
    • 5.1.1. Plugin — Configures the plug-in and the runtime environment
    • 5.1.2. Resource — Bundled resource management
    • 5.1.3. Locale — Localizaion and geolocation
    • 5.1.4. Prefs — Manages user preferences
  • 5.2. Data transfer, parsing and conversion
    • 5.2.1. HTTP — Manages interaction with web services via HTTP
    • 5.2.2. XML — XML markup parsing & generation
    • 5.2.3. JSON — JSON parsing and generation
    • 5.2.4. RSS — RSS feed parsing
    • 5.2.5. YAML — YAML parsing
  • 5.3. Data storage
    • 5.3.1. Dict — Dictionary management
    • 5.3.2. Data — Simple data storage and retrieval
    • 5.3.3. Database — Database management and interaction
  • 5.4. System
    • 5.4.1. Thread — Multithreading
    • 5.4.2. Helper — Runs external helper programs
    • 5.4.3. Client — Information about the client accessing a plug-in
    • 5.4.4. Network — Local network information
  • 5.5. Utilities
    • 5.5.1. String — Manipulates strings
    • 5.5.2. Hash — Hash generation
    • 5.5.3. Datetime — Creates and interacts with date & time objects
• 6. Objects
  • 6.1. Container objects
  • 6.2. Media item objects
  • 6.3. Function objects
  • 6.4. Other objects
• 7. Shortcuts
• 8. Decorators
  • 8.1. Function decorators
  • 8.2. Multithreading decorators
    • 8.2.1. Lock functions (@lock)
    • 8.2.2. Dictionary modifier functions (@modify_dict)
    • 8.2.3. Parallel task sets
• 9. Site Configurations
  • 9.1. Overview
    • 9.1.1. When you should NOT create a Site Config
    • 9.1.2. Where to put them
  • 9.2. Gathering Player Information
    • 9.2.1. URLs
    • 9.2.2. Player Size and Coordinates
    • 9.2.3. Colors
  • 9.3. The XML File
    • 9.3.1. The <site> Element
    • 9.3.2. Seekbars
    • 9.3.3. States and Events
    • 9.3.4. Named Condition Definitions
    • 9.3.5. Advanced
  • 9.4. Reference
    • 9.4.1. Tags (Alphabetical)
    • 9.4.2. XML DTD
    • 9.4.3. Keyboard Keycode Lookup