Class: Net_MPD_Admin

Source Location: /Net_MPD-0.1.0dev1/MPD/Admin.php

Class Overview

Net_MPD_Common
   |
   --Net_MPD_Admin

Music Player Daemon API

Author(s):

Graham Christensen <graham.christensen at itrebal.com>

Version:

CVS: $ID:$

Copyright:

2006 Graham Christensen

Inherited Variables

Class: Net_MPD_Common

Net_MPD_Common::$_commands
Net_MPD_Common::$_errors
Net_MPD_Common::$_output

Inherited Methods

Class: Net_MPD_Common

Net_MPD_Common::__construct(): Placeholder
Net_MPD_Common::connect(): Connect to MPD
Net_MPD_Common::disconnect(): Disconnect from MPD
Net_MPD_Common::getCommands(): Used to discover which commands are available
Net_MPD_Common::getErrors(): A method to access errors
Net_MPD_Common::getNotCommands(): Used to discover commands that are not available
Net_MPD_Common::getStats(): Get various statistics about the MPD server
Net_MPD_Common::getStatus(): Get the status of the MPD server
Net_MPD_Common::isConnected(): Check connection status
Net_MPD_Common::parseOutput(): Parse MPD output on a line-by-line basis creating output that is easy to work with
Net_MPD_Common::ping(): Ping the MPD server to keep the connection running
Net_MPD_Common::read(): Read data from the socket
Net_MPD_Common::runCommand(): Run command
Net_MPD_Common::write(): Write data to the socket

Class Details

[line 28]
Music Player Daemon API

PHP Version 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available thorugh the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.

API for the administrative portion of Music Player Daemon commands

Used for maintaining and controlling various administrative tasks of the MPD software.

Author: Graham Christensen <graham.christensen@itrebal.com>
Version: CVS: $ID:$
Copyright: 2006 Graham Christensen
License: http://www.php.net/license/3_0.txt

[ Top ]

Method Detail

disableOutput [line 51]

bool disableOutput(
$id
$id)

Disables an audio output

Access: public

Parameters:

$id $id — int output Id to disable

[ Top ]

enableOutput [line 69]

bool enableOutput(
$id
$id)

Enables an audio output

Access: public

Parameters:

$id $id — int Id to enable

[ Top ]

getOutputs [line 36]

array getOutputs(
)

List available audio outputs

Return: or int on failure
Access: public

[ Top ]

kill [line 86]

bool kill(
)

Kills the MPD server in a safe way, saving state if possible

Access: public

[ Top ]

updateDatabase [line 105]

bool updateDatabase(
[$path
$path = ''])

Updates the music database

Access: public

Parameters:

$path $path — string path which to search for music, optional

[ Top ]