Class: Net_MPD_Admin

Source Location: /Net_MPD-1.0.2/Net/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(): Set connection params
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::getErrorData(): Get the current error data
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 40]
Music Player Daemon API

PHP Version 5

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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: MIT License

[ Top ]

Method Detail

disableOutput [line 59]

bool disableOutput(
$id
$id)

Disables an audio output

Access: public

Parameters:

$id $id — int output Id to disable

[ Top ]

enableOutput [line 73]

bool enableOutput(
$id
$id)

Enables an audio output

Access: public

Parameters:

$id $id — int Id to enable

[ Top ]

getOutputs [line 48]

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 101]

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

Updates the music database

Access: public

Parameters:

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

[ Top ]