Docs For Class AmpacheHttpq

constructor __construct [line 42]

AmpacheHttpq __construct(
)

Constructor

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

Tags:

access:

public

[ Top ]

method add [line 278]

void add(

$object)

add

This must take an array of URL's from Ampache and then add them to HttpQ

Tags:

access:

public

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

Parameters:

$object

[ Top ]

method add_instance [line 127]

void add_instance(

$data)

add_instance

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

Tags:

access:

public

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

Parameters:

$data

[ Top ]

method clear_playlist [line 315]

void clear_playlist(
)

clear_playlist

This deletes the entire Httpq playlist... nuff said

Tags:

access:

public

[ Top ]

method connect [line 554]

void connect(
)

connect

This functions creates the connection to HttpQ 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 159]

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

void delete_track(

$object_id)

delete_track

This must take an array of ID's (as passed by get function) from Ampache and delete them from Httpq

Tags:

access:

public

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

Parameters:

$object_id

[ Top ]

method get [line 462]

void get(
)

get

This functions returns an array containing information about The songs that HttpQ 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 268]

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

void get_description(
)

get_description

This returns the description of this localplay method

Tags:

access:

public

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

[ Top ]

method get_instance [line 229]

void get_instance(
[
$instance = ''])

get_instance

This returns a single instance and all it's variables

Tags:

access:

public

Parameters:

$instance

[ Top ]

method get_instances [line 175]

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

void get_version(
)

get_version

This returns the current version

Tags:

access:

public

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

[ Top ]

method install [line 87]

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

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

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 next [line 391]

void next(
)

This just tells HttpQ to skip to the next song

Tags:

access:

public

[ Top ]

method pause [line 415]

void pause(
)

pause

This tells HttpQ to pause the current song

Tags:

access:

public

[ Top ]

method play [line 331]

void play(
)

play

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

Tags:

access:

public

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

[ Top ]

method prev [line 403]

void prev(
)

This just tells HttpQ to skip to the prev song

Tags:

access:

public

[ Top ]

method random [line 449]

void random(

$onoff)

random

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

Tags:

access:

public

Parameters:

$onoff

[ Top ]

method repeat [line 438]

void repeat(

$state)

repeat

This tells HttpQ 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 247]

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

void skip(

$song)

skip

This tells HttpQ to skip to the specified song

Tags:

access:

public

Parameters:

$song

[ Top ]

method status [line 529]

void status(
)

status

This returns bool/int values for features, loop, repeat and any other features That this localplay method supports. required function

Tags:

access:

public

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

[ Top ]

method stop [line 349]

void stop(
)

stop

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

Tags:

access:

public

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

[ Top ]

method uninstall [line 111]

void uninstall(
)

uninstall

This removes the localplay controller

Tags:

access:

public

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

[ Top ]

method update_instance [line 194]

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

void volume(

$volume)

volume

This tells HttpQ to set the volume to the specified amount this is 0-100

Tags:

access:

public

Parameters:

$volume

[ Top ]

method volume_down [line 380]

void volume_down(
)

This tells HttpQ to decrease the volume by Winamps default amount

Tags:

access:

public

[ Top ]

method volume_up [line 370]

void volume_up(
)

This tells Httpq to increase the volume by WinAmps default amount

Tags:

access:

public

[ Top ]

Class: AmpacheHttpq

Class Overview

Methods

Inherited Methods

Class: localplay_controller

Class Details

Class Methods

constructor __construct [line 42]

Tags:

method add [line 278]

Tags:

Parameters:

method add_instance [line 127]

Tags:

Parameters:

method clear_playlist [line 315]

Tags:

method connect [line 554]

Tags:

method delete_instance [line 159]

Tags:

Parameters:

method delete_track [line 300]

Tags:

Parameters:

method get [line 462]

Tags:

method get_active_instance [line 268]

Tags:

method get_description [line 53]

Tags:

method get_instance [line 229]

Tags:

Parameters:

method get_instances [line 175]

Tags:

method get_version [line 63]

Tags:

method install [line 87]

Tags:

method instance_fields [line 214]

Tags:

method is_installed [line 73]

Tags:

method next [line 391]

Tags:

method pause [line 415]

Tags:

method play [line 331]

Tags:

method prev [line 403]

Tags:

method random [line 449]

Tags:

Parameters:

method repeat [line 438]

Tags:

Parameters:

method set_active_instance [line 247]

Tags:

Parameters:

method skip [line 360]

Tags:

Parameters:

method status [line 529]

Tags:

method stop [line 349]

Tags:

method uninstall [line 111]

Tags:

method update_instance [line 194]

Tags:

Parameters:

method volume [line 427]

Tags:

Parameters:

method volume_down [line 380]

Tags:

method volume_up [line 370]

Tags: