Plex Plug-in Framework documentation

• Introduction
• How plug-ins work
  • Differences between plug-ins and regular Python programs
    • Code structure
    • The framework APIs
    • Plug-in execution
• Bundles
  • Configuration files
    • The Info.plist file
    • The DefaultPrefs.json file
  • Directories
    • The Code directory
      • The __init__.py file
    • The Services directory
    • The Resources directory
    • The Strings directory
• Channel Plug-ins
  • Getting started with channel development
    • What are channels?
    • Understanding contexts
    • Configuring the Info.plist file
    • Adding a prefix
    • Creating a menu hierarchy
    • Predefined functions
  • Site Configurations
    • Overview
      • When you should NOT create a Site Config
      • Where to put them
    • Gathering Player Information
      • URLs
      • Player Size and Coordinates
      • Colors
    • The XML File
      • The <site> Element
      • Seekbars
      • States and Events
      • Named Condition Definitions
      • Advanced
  • Services
    • URL Services
      • Defining a URL service
      • Creating a source file
      • Writing the code
      • Testing the service
      • Calling the service from plug-in code
    • Search Services
      • Defining a search service
      • Creating a source file
      • Writing the code
      • Testing the service
    • Related Content Services
      • Defining a related content service
      • Creating a source file
      • Writing the code
      • Testing the service
• Agent Plug-ins
  • Getting started with agent development
    • What are agents?
    • Understanding the metadata retrieval process
    • Configuring the Info.plist file
    • Defining an agent class
  • Searching for results to provide matches for media
  • Adding metadata to media
  • Metadata Model Classes
    • Proxy objects
• API Reference
  • Standard API
    • Controlling the runtime environment
      • Global functions
      • Plugin
      • Route
      • Platform
      • Request
      • Response
      • Client
    • Objects
      • Object classes
      • Containers
      • Metadata objects
      • Generic browsing objects
      • Media objects
      • URL generating functions
    • Accessing bundled resources
      • Resource
    • Threading
      • Thread
    • Networking
      • Network
      • HTTP
      • XMLRPC
    • Parsing and manipulating data
      • XML
      • HTML
      • JSON
      • YAML
      • RSS
      • Plist
    • Data storage and caching
      • Data
      • Dict
    • Location Services
      • Locale
    • Reading user preferences
      • Prefs
      • Preference files
    • Utilities
      • Hash
      • String
      • Datetime
      • Util
    • Debugging
      • Log
    • Constants
      • Client Platforms
      • Protocols
      • View Types
      • Summary Text Types
      • Audio Codecs
      • Video Codecs
      • Container File Types
      • Object Container Content Types
• Site Configuration Reference
  • Tags (Alphabetical)
    • <action>
    • <and>
    • <bigStep>
    • <condition>
    • <color>
    • <click>
    • <command>
    • <crop>
    • <dead>
    • <end>
    • <event>
    • <frameLoaded>
    • <goto>
    • <javascript>
    • <lockPlugin>
    • <move>
    • <not>
    • <or>
    • <pause>
    • <percentComplete>
    • <played>
    • <pre>
    • <pref>
    • <run>
    • <seekbar>
    • <setCookie>
    • <site>
    • <start>
    • <state>
    • <smallStep>
    • <title>
    • <type>
    • <url>
    • <visit>
  • XML DTD
  • Keyboard Keycode Lookup

Indices and tables

• Index
• Module Index
• Search Page