Plugins API

  1. API Reference
    1. API Types
    2. Class Types
    3. JSON API
    4. XML API
    5. Session API
    6. JSON and XML APIs - Asynchronous API Responses
    7. Server Class Method Reference {#apiserverclass}
    8. System Class Method Reference {#apisystemclass}
  2. System Accounts
  3. Advanced Configurations
    1. Dual v3/v2 Deployment
    2. Using centovacast.conf
  4. Command-line Tools
    1. Controlling Centova Cast
    2. Diagnostic Report Generator
    3. Fixing Problems
    4. Centova Cast Management Utility
      1. Management Utility Invocation
      2. Output Formats
    5. Reinstalling Centova Cast
    6. Uninstalling Centova Cast
    7. Update Utility
  5. Customizations
    1. Init Script
    2. Menu Customizations
    3. Wrapping Server Applications
  6. Event Scripts
    1. Event Script Reference
    2. Event Notification Scripts
    3. Event Script Structure
  7. Files and Paths
    1. Account Files and Paths
    2. Core Files and Paths
    3. Formats
      1. nextsong.log File Format
  8. Plugins
    1. Event Script Reference
    2. Example Plugin
    3. Plugins API
    4. Plugin Structure

Plugins API

Introduction

Centova Cast v3 and up support a new plugin system allowing developers to integrate third-party functionality directly into Centova Cast.

Overview

Plugins are written in the PHP programming language. To extend Centova Cast using other programming languages, the Event Scripts interface should be used instead.

At the beginning of each request, all plugins register callbacks to be invoked when specific actions are performed by Centova Cast. When Centova Cast performs an action for which a callback is registered, it invokes the callback passing parameters containing the details of the event.

Environment

Note that Centova Cast v3 and up provides its own operating environment including a self-contained PHP engine, and does not rely on any existing PHP interpreter or settings on the server. As such, the list of supported extensions and functions may not match those which you have used on other PHP installations.

Most notably, for security reasons, Centova Cast's PHP engine has no notion of exec() or any other process execution functions, so it is not possible to launch external applications from within Centova Cast plugins.

Previous: Example Plugin
Section: Plugins
Next: Plugin Structure