static method get_controllers [line 140]
static void get_controllers(
)
|
|
get_controllers
This returns the controllers that are currently loaded into this instance
Tags:
static method is_enabled [line 173]
static void is_enabled(
$controller)
|
|
is_enabled
This returns true or false depending on if the specified controller is currently enabled
Tags:
Parameters:
constructor __construct [line 39]
Localplay __construct(
$type)
|
|
Constructor
This must be called with a localplay type, it then loads the config file for the specified type and attempts to load in the function map, the preferences and the template
Tags:
Parameters:
method add [line 270]
add This function takes a single object and then passes it to to the player, this is a required function.
Tags:
Parameters:
method add_instance [line 558]
void add_instance(
$data)
|
|
add_instance
This adds a new instance for the current controller type
Tags:
Parameters:
method add_url [line 286]
add_url
This directly adds an array of URLs to the localplay module. This is really how I should have done add, will migrate to this eventually
Tags:
Parameters:
method connect [line 222]
connect
This function attempts to connect to the localplay player that we are using
Tags:
method current_instance [line 522]
current_instance
This returns the UID of the current Instance
Tags:
method delete_all [line 606]
delete_all
This removes every song from the players playlist as defined by the delete_all function map
Tags:
method delete_instance [line 568]
void delete_instance(
$instance_uid)
|
|
delete_instance
This removes an instance (it actually calls the players function)
Tags:
Parameters:
method delete_track [line 589]
void delete_track(
$object_id)
|
|
delete_track
This removes songs from the players playlist it takes a single ID as provided by the get command
Tags:
Parameters:
method format [line 81]
format
This makes the localplay/plugin information human readable
Tags:
method format_name [line 128]
void format_name(
$name,
$id)
|
|
format_name
This function takes the track name and checks to see if 'skip' is supported in the current player, if so it returns a 'skip to' link, otherwise it returns just the text
Tags:
Parameters:
method get [line 358]
get
This calls the get function of the player and then returns the array of current songs for display or whatever an empty array is passed on failure
Tags:
method get_instance [line 534]
get_instance
This returns the specified instance
Tags:
Parameters:
method get_instances [line 510]
get_instances
This returns the instances of the current type
Tags:
method get_instance_fields [line 622]
void get_instance_fields(
)
|
|
get_instance_fields
This loads the fields from the localplay player and returns them
Tags:
method get_user_playing [line 659]
get_user_playing
This attempts to return a nice user friendly currently playing string
Tags:
method get_user_state [line 635]
void get_user_state(
$state)
|
|
get_user_state
This function returns a user friendly version of the current player state
Tags:
Parameters:
method install [line 189]
install
This runs the install for the localplay controller we've currently got pimped out
Tags:
method next [line 462]
next
This isn't a required function, it tells the daemon to go to the next song
Tags:
method pause [line 495]
pause
This isn't a required function, it tells the daemon to pause the song
Tags:
method play [line 238]
play
This function passes NULL and calls the play function of the player object
Tags:
method player_loaded [line 65]
player_loaded
This returns true / false if the player load failed / worked
Tags:
method prev [line 478]
prev
This isn't a required function, it tells the daemon to go the the previous song
Tags:
method random [line 322]
random
This turns on the random feature of a localplay method It takes a 0/1 value
Tags:
Parameters:
method repeat [line 305]
repeat
This turns the repeat feature of a localplay method on or off, takes a 0/1 value
Tags:
Parameters:
method set_active_instance [line 578]
void set_active_instance(
$instance)
|
|
set_active_instance
This sets the active instance of the localplay controller
Tags:
Parameters:
method skip [line 446]
skip
This isn't a required function, it tells the daemon to skip to the specified song
Tags:
Parameters:
method status [line 339]
status
This returns current information about the state of the player There is an expected array format
Tags:
method stop [line 254]
stop
This functions passes NULl and calls the stop function of the player object, it should recieve a true/false boolean value
Tags:
method uninstall [line 203]
uninstall
This runs the uninstall for the localplay controller we've currently pimped out
Tags:
method update_instance [line 546]
void update_instance(
$uid,
$data)
|
|
update_instance
This updates the specified instance with a named array of data (_POST most likely)
Tags:
Parameters:
method volume_down [line 415]
volume_down This function isn't required. It tells the daemon to decrese the volume by a pre-defined amount controlled by the controller.
Tags:
method volume_mute [line 431]
volume_mute
This function isn't required, It tells the daemon to mute all output It's up to the controller to decide what that actually entails
Tags:
method volume_set [line 377]
volume_set
This isn't a required function, it sets the volume to a specified value as passed in the variable it is a 0 - 100 scale the controller is responsible for adjusting the scale if nessecary
Tags:
Parameters:
method volume_up [line 399]
volume_up
This function isn't required. It tells the daemon to increase the volume by a pre-defined amount controlled by the controller
Tags:
