Docs For Class AmpacheShoutCast

constructor __construct [line 45]

AmpacheShoutCast __construct(
)

Constructor

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

Tags:

access:

public

[ Top ]

method add [line 281]

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

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

void clear_playlist(
)

clear_playlist

This deletes the entire MPD playlist... nuff said

[ Top ]

method connect [line 500]

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

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

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

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

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

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

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

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_pid [line 519]

void get_pid(
)

get_pid

This returns the pid for the current instance

Tags:

access:

public

[ Top ]

method get_playlist [line 558]

void get_playlist(
)

get_playlist

This reads in the playlist and returns an array of filenames

Tags:

access:

public

[ Top ]

method get_version [line 67]

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

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

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

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

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

void next(
)

This just tells MPD to skip to the next song

Tags:

access:

public

[ Top ]

method pause [line 415]

void pause(
)

pause

Tags:

access:

public

[ Top ]

method play [line 337]

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

void prev(
)

This just tells MPD to skip to the prev song

Tags:

access:

public

[ Top ]

method random [line 446]

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

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 send_command [line 578]

void send_command(

$command, [
$options = array()])

send_command

This is the single funciton that's used to send commands to the shoutcast server, one function makes it easier to ensure we've escaped our input

Tags:

access:

public

Parameters:

	$command
	$options

[ Top ]

method set_active_instance [line 250]

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

void skip(

$song)

skip

This tells MPD to skip to the specified song

Parameters:

$song

[ Top ]

method status [line 488]

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

void stop(
)

stop

This just stops the shoutcast server

Tags:

access:

public

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

[ Top ]

method uninstall [line 115]

void uninstall(
)

uninstall

This removes the localplay controller

Tags:

access:

public

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

[ Top ]

method update_instance [line 215]

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

void volume(

$volume)

volume

This tells MPD to set the volume to the parameter

Tags:

access:

public

Parameters:

$volume

[ Top ]

method volume_down [line 385]

void volume_down(
)

This tells MPD to decrese the volume by 5

Tags:

access:

public

[ Top ]

method volume_up [line 376]

void volume_up(
)

This tells MPD to increase the volume by 5

Tags:

access:

public

[ Top ]

method write_playlist [line 536]

void write_playlist(
)

write_playlist

This takes the files that we've got in our array and writes them out

Tags:

access:

public

[ Top ]

Class: AmpacheShoutCast

Class Overview

Methods

Inherited Methods

Class: localplay_controller

Class Details

Class Methods

constructor __construct [line 45]

Tags:

method add [line 281]

Tags:

Parameters:

method add_instance [line 130]

Tags:

Parameters:

method clear_playlist [line 326]

method connect [line 500]

Tags:

method delete_instance [line 160]

Tags:

Parameters:

method delete_track [line 316]

Tags:

Parameters:

method get [line 468]

Tags:

method get_active_instance [line 271]

Tags:

method get_description [line 57]

Tags:

method get_instance [line 197]

Tags:

Parameters:

method get_instances [line 177]

Tags:

method get_pid [line 519]

Tags:

method get_playlist [line 558]

Tags:

method get_version [line 67]

Tags:

method install [line 90]

Tags:

method instance_fields [line 235]

Tags:

method is_installed [line 77]

Tags:

method move [line 457]

Tags:

Parameters:

method next [line 395]

Tags:

method pause [line 415]

Tags:

method play [line 337]

Tags:

method prev [line 406]

Tags:

method random [line 446]

Tags:

Parameters:

method repeat [line 435]

Tags:

Parameters:

method send_command [line 578]

Tags:

Parameters:

method set_active_instance [line 250]

Tags:

Parameters:

method skip [line 367]

Parameters:

method status [line 488]

Tags:

method stop [line 356]

Tags:

method uninstall [line 115]

Tags:

method update_instance [line 215]

Tags: