Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]

Class: HttpQPlayer

Source Location: /modules/httpq/httpqplayer.class.php

Class Overview


HttpQPlayer


Variables

Methods



Class Details

[line 30]
HttpQPlayer

This player controls an instance of HttpQ which in turn controls WinAmp all functions return null on failure




[ Top ]


Class Variables

$host =

[line 32]


Type:   mixed


[ Top ]

$password =

[line 34]


Type:   mixed


[ Top ]

$port =

[line 33]


Type:   mixed


[ Top ]



Class Methods


constructor HttpQPlayer [line 41]

HttpQPlayer HttpQPlayer( [ $h = "localhost"], [ $pw = ""], [ $p = 4800])

HttpQPlayer

This is the constructor, it defaults to localhost with port 4800




Parameters:

   $h  
   $pw  
   $p  

[ Top ]

method add [line 55]

void add( $name, $url)

add

append a song to the playlist $name Name to be shown in the playlist $url URL of the song




Parameters:

   $name  
   $url  

[ Top ]

method clear [line 90]

void clear( )

clear

clear the playlist




[ Top ]

method clear_playlist [line 323]

void clear_playlist( )

clear_playlist

this flushes the playlist cache (I hope this means clear)




[ Top ]

method delete_pos [line 224]

void delete_pos( $track)

delete_pos

This deletes a specific track




Parameters:

   $track  

[ Top ]

method get_now_playing [line 365]

void get_now_playing( )

get_now_playing

This returns the file information for the currently playing song




[ Top ]

method get_random [line 351]

void get_random( )

get_random

This returns the current state of shuffle




[ Top ]

method get_repeat [line 338]

void get_repeat( )

get_repeat

This returns the current state of the repeat




[ Top ]

method get_tracks [line 382]

void get_tracks( )

get_tracks

This returns a delimiated string of all of the filenames current in your playlist




[ Top ]

method get_volume [line 256]

void get_volume( )

get_volume

This returns the current volume




[ Top ]

method next [line 104]

void next( )

next

go to next song




[ Top ]

method pause [line 164]

void pause( )

pause

toggle pause mode on current song




Tags:

access:  public


[ Top ]

method play [line 149]

void play( )

play

play the current song




[ Top ]

method prev [line 119]

void prev( )

prev

go to previous song




[ Top ]

method random [line 209]

void random( $value)

random

this toggles the random state of HttpQ




Tags:

access:  public


Parameters:

   $value  

[ Top ]

method repeat [line 194]

void repeat( $value)

repeat

This toggles the repeat state of HttpQ




Tags:

access:  public


Parameters:

   $value  

[ Top ]

method set_volume [line 306]

void set_volume( $value)

set_volume

This sets the volume as best it can, we go from a resolution of 100 --> 255 so it's a little fuzzy




Parameters:

   $value  

[ Top ]

method skip [line 134]

void skip( $pos)

skip

This skips to POS in the playlist




Parameters:

   $pos  

[ Top ]

method state [line 239]

void state( )

state

This returns the current state of the httpQ player




[ Top ]

method stop [line 179]

void stop( )

stop

stops the current song amazing!




Tags:

access:  public


[ Top ]

method version [line 73]

void version( )

version

This gets the version of winamp currently running, use this to test for a valid connection




[ Top ]

method volume_down [line 290]

void volume_down( )

volume_down

This decreases the volume by Winamp's defined amount




[ Top ]

method volume_up [line 275]

void volume_up( )

volume_up

This increases the volume by Wimamp's defined amount




[ Top ]


Documentation generated on Thu, 12 Feb 2009 07:59:58 +0900 by phpDocumentor 1.4.2