Class Types

  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

Class Types

API methods are broken down into two classes: system and server.

System methods generally correspond to tasks that would be performed by the administrator, and which would pertain to the overall management and administration of Centova Cast.

Server methods correspond to management tasks for a single streaming server account.

System Class Authentication

Because they operate on a global (server-wide) basis, all methods of the system class (except where otherwise noted) require a password argument specifying the Centova Cast administrator password in addition to the arguments noted for each system class method. Without the administrator password, all methods of the system class will return an authentication failure error.

The methods available under the system class are provided under System Class Method Reference.

Server Class Authentication

Because they operate on a per-account basis, all methods of the server class (except where otherwise noted) require a username argument specifying the username of the streaming server account to be manipulated, and a password argument specifying the password for the account, in addition to the arguments noted for each server class method.

If desired, the password argument may be replaced with the word admin, followed by a pipe character (|) followed by the Centova Cast administrator password. For example, if the Centova Cast administrator password is secret, it is acceptable to specify admin|secret as the password for any streaming server account. This allows the administrator to manage any account without knowing the password for each individual account.

The methods available under the server class are provided under Server Class Method Reference.

Previous: API Types
Section: API Reference
Next: JSON API