constructor __construct [line 91]
SqueezePlayer (constructor)
Parameters:
destructor __destruct [line 743]
SqueezePlayer (destructor)
method album [line 211]
album
Returns "album" of song currently playing.
Tags:
method artist [line 199]
artist
Returns "artist" of song currently playing.
Tags:
method button [line 585]
boolean button(
[string
$buttoncode = ""])
|
|
button
The "button" command simulates a button press. Valid button codes correspond to the functions defined in the Default.map file.
Tags:
Parameters:
method canpoweroff [line 348]
canpoweroff
Returns whether the player can be powered off or not. Current hardware players and SoftSqueeze would return 1, web clients 0.
Tags:
method client_forget [line 658]
client_forget
The "client forget" command deletes the client/player from the server database.
Tags:
method connect [line 642]
boolean connect(
[string
$ip_address = ""])
|
|
connect
The "connect" command tells a Squeezebox 2 or newer player to connect to a different server address or to SqueezeNetwork.
Tags:
Parameters:
method connected [line 373]
connected
Returns the connected state of the player, 1 or 0 depending on the state of the TCP connection to the player. SLIMP3 players, since they use UDP, always return 1.
Tags:
method current_title [line 259]
current_title
Returns "current_title" of song currently playing.
Tags:
method disconnect [line 671]
boolean disconnect(
[string
$ip_address = ""])
|
|
disconnect
The "disconnect" command tells a Squeezebox 2 or newer player on another SqueezeCenter instance to disconnect from its server and connect to another server or SqueezeNetwork.
Tags:
Parameters:
method display [line 496]
boolean display(
[string
$line1 = ""], [string
$line2 = ""], [integer
$duration = 3])
|
|
display
The "display" command specifies some text to be displayed on the player screen for a specified amount of time (in seconds).
Tags:
Parameters:
method displaynow [line 520]
displaynow
The "displaynow" command provides access to the data currently on the display. This differs from the "display ? ?" display_current() command in that it returns the latest data sent to the display, including any animation, double-size fonts, etc...
Tags:
method displaytype [line 336]
displaytype
Returns the display model of the player. Graphical display types start with "graphic-", non-graphical display type with "noritake-".
Tags:
method display_current [line 508]
string display_current(
)
|
|
display_current
The "display ? ?" command may be used to obtain the text that is currently displayed on the screen.
Tags:
method duration [line 235]
duration
Returns "duration" of song currently playing.
Tags:
method genre [line 187]
genre
Returns "genre" of song currently playing.
Tags:
method id [line 108]
id
Returns the current player id.
Tags:
method ip [line 300]
ip
Returns the IP address (along with port number) of the player.
Tags:
method ir [line 603]
boolean ir(
[string
$ircode = ""], [string
$time = ""])
|
|
ir
The "ir" command simulates an IR code. Valid IR codes are defined in the Default.map file.
Tags:
Parameters:
method irenable [line 620]
boolean irenable(
[string
$state = ""])
|
|
irenable
The "irenable" command enables or disables IR processing for the player on or off. Use 0 to disable, 1 to enable, ? to query and no parameter to toggle IR processing of the player. For remote streaming connections, the command does nothing and the query always returns 1.
Tags:
Parameters:
method isplayer [line 324]
isplayer
Returns the if a player is a known player model. Currently know models are "transporter", "squeezebox2", "squeezebox", "slimp3", "softsqueeze", or "http" (for remote streaming connections). Will return 0 for streaming connections.
Tags:
method mode [line 158]
mode
The "mode" command allows to query the player state and returns one of "play", "stop" or "pause". If the player is off, "mode ?" returned value is undefined.
Tags:
method model [line 312]
model
Returns the model of the player, currently one of "transporter", "squeezebox2", "squeezebox", "slimp3", "softsqueeze", or "http" (for remote streaming connections).
Tags:
method name [line 284]
string name(
[string
$newname = ""])
|
|
name
Sets the name of the player. You may query the player name by passing in "?" or "" (default)
Tags:
Parameters:
method path [line 271]
path
Returns "path" of song currently playing.
Tags:
method pause [line 146]
boolean pause(
[integer
$state = -1], [integer
$fadeInSecs = -1])
|
|
pause
You may use "pause 1" to force the player to pause, "pause 0" to force the player to unpause and "pause" to toggle the pause state.
Tags:
Parameters:
method play [line 120]
boolean play(
[integer
$fadeInSecs = -1])
|
|
play
The "play" command allows to start playing the current playlist.
Tags:
Parameters:
method playerpref [line 534]
mixed playerpref(
[string
$prefname = ""], [string
$prefvalue = ""])
|
|
playerpref
The "playerpref" command allows the caller to set and query the SqueezeCenter's internal player-specific preferences values.
Tags:
Parameters:
method playerpref_validate [line 557]
boolean playerpref_validate(
[string
$prefname = ""], [string
$prefvalue = ""])
|
|
playerpref_validate
The "playerpref validate" command allows the caller to validate a SqueezeCenter's internal player-specific preference value without setting it.
Tags:
Parameters:
method power [line 431]
boolean power(
[string
$state = ""])
|
|
power
The "power" command turns the player on or off. Use 0 to turn off, 1 to turn on, ? to query and no parameter to toggle the power state of the player. For remote streaming connections, the command does nothing and the query always returns 1.
Tags:
Parameters:
method rate [line 453]
mixed rate(
[string
$rate = ""])
|
|
rate
The "rate" command returns or sets the current play rate for the player. 1 is normal, 2 is 2x fast forward, 0 is paused, -1 is rewind, etc.
Tags:
Parameters:
method remote [line 247]
remote
Returns if the song currently playing is a remote stream.
Tags:
method show [line 480]
boolean show(
[string
$line1 = ""], [string
$line2 = ""], [integer
$duration = 3], [string
$brightness = "4"], [string
$font = ""], [string
$centered = ""])
|
|
show
The "show" command displays a message on the player display for a given duration. Various options are provided to customize the appearance of the message (font size, centering). If the mesage is too long to fit on the display, it scrolls. This command is designed to display the message, and by default temporarily cancels any screensaver and increases the brightness to the maximum value. This command is only echoed once the message display is done.
Tags:
Parameters:
method signalstrength [line 361]
integer signalstrength(
)
|
|
signalstrength
Returns the wireless signal strength for the player, range is 1 to 100. Returns 0 if not connected wirelessly.
Tags:
method sleep_time [line 386]
mixed sleep_time(
[string
$number = ""])
|
|
sleep_time
The "sleep" command specifies a number of seconds to continue playing before powering off the player. You may query the amount of time until the player sleeps by passing in "?".
Tags:
Parameters:
method stop [line 132]
stop
The "stop" command allows to stop playing the current playlist.
Tags:
method sync [line 403]
mixed sync(
[string
$playerindex_id = ""])
|
|
sync
The "sync" command specifies the player to synchronise with the given playerid. The command accepts only one playerindex or playerid. To unsync the player, use the "-" parameter. Note that in both cases the first <playerid> is the player which is already a member of a sync group. When adding a player to a sync group, the second specified player will be added to the group which includes the first player, if necessary first removing the second player from its existing sync-group. You may query which players are already synced with this player by passing in a "?" parameter. Multiple playerids are separated by a comma. If the player is not synced, "-" is returned.
Tags:
Parameters:
method syncgroups [line 418]
syncgroups
The "syncgroups" query returns a comma separated list of sync groups members (IDs and names).
Tags:
method time [line 171]
mixed time(
[string
$number = ''])
|
|
time
The "time" command allows you to query the current number of seconds that the current song has been playing by passing in a "?". You may jump to a particular position in a song by specifying a number of seconds to seek to. You may also jump to a relative position within a song by putting an explicit "-" or "+" character before a number of second you would like to seek.
Tags:
Parameters:
method title [line 223]
title
Returns "title" of song currently playing.
Tags:
method __get [line 688]
mixed __get(
string
$property_name)
|
|
__get (getter)
Parameters: