Docs For Class AmpacheMpd

constructor __construct [line 41]

AmpacheMpd __construct(
)

Constructor

This returns the array map for the localplay object REQUIRED for Localplay

Tags:

access:

public

[ Top ]

method add [line 276]

void add(

$object)

add

This takes a single object and adds it in, it uses the built in functions to generate the URL it needs

Tags:

access:

public

Overrides localplay_controller::add() (parent method not documented)

Parameters:

$object

[ Top ]

method add_instance [line 125]

void add_instance(

$data)

add_instance

This takes key'd data and inserts a new MPD instance

Tags:

access:

public

Overrides localplay_controller::add_instance() (parent method not documented)

Parameters:

$data

[ Top ]

method clear_playlist [line 316]

void clear_playlist(
)

clear_playlist

This deletes the entire MPD playlist... nuff said

Tags:

access:

public

[ Top ]

method connect [line 561]

void connect(
)

connect

This functions creates the connection to MPD and returns a boolean value for the status, to save time this handle is stored in this class

Tags:

access:

public

Overrides localplay_controller::connect() (parent method not documented)

[ Top ]

method delete_instance [line 155]

void delete_instance(

$uid)

delete_instance

This takes a UID and deletes the instance in question

Tags:

access:

public

Overrides localplay_controller::delete_instance() (parent method not documented)

Parameters:

$uid

[ Top ]

method delete_track [line 304]

void delete_track(

$object_id)

delete_track

This must take a single ID (as passed by get function) from Ampache and delete it from the current playlist

Tags:

access:

public

Overrides localplay_controller::delete_track() (parent method not documented)

Parameters:

$object_id

[ Top ]

method get [line 463]

void get(
)

get_songs

This functions returns an array containing information about The songs that MPD currently has in it's playlist. This must be done in a standardized fashion

Tags:

access:

public

Overrides localplay_controller::get() (parent method not documented)

[ Top ]

method get_active_instance [line 266]

void get_active_instance(
)

get_active_instance

This returns the UID of the current active instance false if none are active

Tags:

access:

public

Overrides localplay_controller::get_active_instance() (parent method not documented)

[ Top ]

method get_description [line 52]

void get_description(
)

get_description

Returns the description

Tags:

access:

public

Overrides localplay_controller::get_description() (parent method not documented)

[ Top ]

method get_instance [line 192]

void get_instance(
[
$instance = ''])

get_instance

This returns the specified instance and all it's pretty variables If no instance is passed current is used

Tags:

access:

public

Parameters:

$instance

[ Top ]

method get_instances [line 172]

void get_instances(
)

get_instances

This returns a key'd array of the instance information with [UID]=>[NAME]

Tags:

access:

public

Overrides localplay_controller::get_instances() (parent method not documented)

[ Top ]

method get_version [line 62]

void get_version(
)

get_version

This returns the version information

Tags:

access:

public

Overrides localplay_controller::get_version() (parent method not documented)

[ Top ]

method install [line 85]

void install(
)

install

This function installs the MPD localplay controller

Tags:

access:

public

Overrides localplay_controller::install() (parent method not documented)

[ Top ]

method instance_fields [line 230]

void instance_fields(
)

instance_fields

This returns a key'd array of [NAME]=>array([DESCRIPTION]=>VALUE,[TYPE]=>VALUE) for the fields so that we can on-the-fly generate a form

Tags:

access:

public

Overrides localplay_controller::instance_fields() (parent method not documented)

[ Top ]

method is_installed [line 72]

void is_installed(
)

is_installed

This returns true or false if MPD controller is installed

Tags:

access:

public

Overrides localplay_controller::is_installed() (parent method not documented)

[ Top ]

method move [line 450]

void move(

$SrcPos, 
$DestPos)

move

This tells MPD to move song from SrcPos to DestPos

Tags:

access:

public

Parameters:

	$SrcPos
	$DestPos

[ Top ]

method next [line 383]

void next(
)

This just tells MPD to skip to the next song

Tags:

access:

public

[ Top ]

method pause [line 405]

void pause(
)

pause

This tells MPD to pause the current song

Tags:

access:

public

[ Top ]

method play [line 329]

void play(
)

play

This just tells MPD to start playing, it does not take any arguments

Tags:

access:

public

Overrides localplay_controller::play() (parent method not documented)

[ Top ]

method prev [line 394]

void prev(
)

This just tells MPD to skip to the prev song

Tags:

access:

public

[ Top ]

method random [line 439]

void random(

$onoff)

random

This tells MPD to turn on or off the playing of songs from the playlist in random order

Tags:

access:

public

Parameters:

$onoff

[ Top ]

method repeat [line 428]

void repeat(

$state)

repeat

This tells MPD to set the repeating the playlist (i.e. loop) to either on or off

Tags:

access:

public

Parameters:

$state

[ Top ]

method set_active_instance [line 245]

void set_active_instance(

$uid, [
$user_id = ''])

set_active_instance

This sets the specified instance as the 'active' one

Tags:

access:

public

Overrides localplay_controller::set_active_instance() (parent method not documented)

Parameters:

	$uid
	$user_id

[ Top ]

method skip [line 352]

void skip(

$song)

skip

This tells MPD to skip to the specified song

Tags:

access:

public

Parameters:

$song

[ Top ]

method status [line 534]

void status(
)

get_status

This returns bool/int values for features, loop, repeat and any other features That this localplay method support

Tags:

access:

public

Overrides localplay_controller::status() (parent method not documented)

[ Top ]

method stop [line 341]

void stop(
)

stop

This just tells MPD to stop playing, it does not take any arguments

Tags:

access:

public

Overrides localplay_controller::stop() (parent method not documented)

[ Top ]

method uninstall [line 110]

void uninstall(
)

uninstall

This removes the localplay controller

Tags:

access:

public

Overrides localplay_controller::uninstall() (parent method not documented)

[ Top ]

method update_instance [line 210]

void update_instance(

$uid, 
$data)

update_instance

This takes an ID and an array of data and updates the instance specified

Tags:

access:

public

Overrides localplay_controller::update_instance() (parent method not documented)

Parameters:

	$uid
	$data

[ Top ]

method volume [line 417]

void volume(

$volume)

volume

This tells MPD to set the volume to the parameter

Tags:

access:

public

Parameters:

$volume

[ Top ]

method volume_down [line 372]

void volume_down(
)

This tells MPD to decrese the volume by 5

Tags:

access:

public

[ Top ]

method volume_up [line 362]

void volume_up(
)

This tells MPD to increase the volume by 5

Tags:

access:

public

[ Top ]

Class: AmpacheMpd

Class Overview

Methods

Inherited Methods

Class: localplay_controller

Class Details

Class Methods

constructor __construct [line 41]

Tags:

method add [line 276]

Tags:

Parameters:

method add_instance [line 125]

Tags:

Parameters:

method clear_playlist [line 316]

Tags:

method connect [line 561]

Tags:

method delete_instance [line 155]

Tags:

Parameters:

method delete_track [line 304]

Tags:

Parameters:

method get [line 463]

Tags:

method get_active_instance [line 266]

Tags:

method get_description [line 52]

Tags:

method get_instance [line 192]

Tags:

Parameters:

method get_instances [line 172]

Tags:

method get_version [line 62]

Tags:

method install [line 85]

Tags:

method instance_fields [line 230]

Tags:

method is_installed [line 72]

Tags:

method move [line 450]

Tags:

Parameters:

method next [line 383]

Tags:

method pause [line 405]

Tags:

method play [line 329]

Tags:

method prev [line 394]

Tags:

method random [line 439]

Tags:

Parameters:

method repeat [line 428]

Tags:

Parameters:

method set_active_instance [line 245]

Tags:

Parameters:

method skip [line 352]

Tags:

Parameters:

method status [line 534]

Tags:

method stop [line 341]

Tags:

method uninstall [line 110]

Tags:

method update_instance [line 210]

Tags:

Parameters:

method volume [line 417]

Tags:

Parameters:

method volume_down [line 372]