SqueezePHPAPI
[ class tree: SqueezePHPAPI ] [ index: SqueezePHPAPI ] [ all elements ] [ doc index ]

Class: SqueezePlayers

Source Location: /lib/class.SqueezePlayers.php

Class Overview

SqueezePlayers


Author(s):

Copyright:

Methods


 

Class Details

[line 27]
SqueezePlayers

Squeeze Center player management.


Tags:

author:  David Broz <db-dev__AT__0r9.org>
copyright:  (c) 2009 by David Broz - Disorganization Zurich, Switzerland
license:  GNU General Public License v2


[ Top ]


Class Methods


constructor __construct [line 44]

SqueezePlayers __construct( SqueezeConnection $CLI)

SqueezePlayers (constructor)



Parameters:

SqueezeConnection   $CLI  

[ Top ]

destructor __destruct [line 197]

void __destruct( )

SqueezePlayers (destructor)



[ Top ]

method canpoweroff [line 160]

boolean canpoweroff( [string $playerindex_id = ""])

canpoweroff

Returns wether a player can be powered off or not. Current hardware players and SoftSqueeze would return 1, web clients 0.


Tags:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method count [line 56]

integer count( )

count

The "player count ?" query returns the number of players connected to the server.


Tags:

access:  public


[ Top ]

method displaytype [line 147]

string displaytype( [string $playerindex_id = ""])

displaytype

The "player displaytype ?" query returns the display model of the player. Graphical display types start with "graphic-", non-graphical display type with "noritake-".


Tags:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method id [line 69]

string id( [string $playerindex = ""])

id

The "player id ?" query returns the unique identifier of a player, (<playerid> parameter of many CLI commands). For physical players this is generally the MAC address. The IP address is used for remote streams.


Tags:

access:  public


Parameters:

string   $playerindex   <playerindex>

[ Top ]

method ip [line 108]

string ip( [string $playerindex_id = ""])

name

The "player ip ?" query returns the IP address (along with port number) of the specified player.


Tags:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method isplayer [line 134]

boolean isplayer( [string $playerindex_id = ""])

isplayer

Whether 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:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method model [line 121]

string model( [string $playerindex_id = ""])

model

The "player model ?" query returns the model of the player, currently one of "transporter", "squeezebox2", "squeezebox", "slimp3", "softsqueeze", or "http" (for remote streaming connections).


Tags:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method name [line 95]

string name( [string $playerindex_id = ""])

name

The "player name ?" query returns the human-readable name for the specified player. If the name has not been specified by the user in the Player Settings, then a default name will be used, usually the IP address.


Tags:

access:  public


Parameters:

string   $playerindex_id   <playerindex|playerid>

[ Top ]

method players [line 187]

array players( [integer $start = 0], [integer $itemsPerResponse = 5], [string $playerprefs = ""])

players

The "players" query returns information about all "players" (physical players as well as streaming clients) known by the SqueezeCenter.


Tags:

access:  public


Parameters:

integer   $start  
integer   $itemsPerResponse  
string   $playerprefs   Comma separated list of preference values to return (for each player).

[ Top ]

method syncgroups [line 172]

string syncgroups( )

syncgroups

The "syncgroups" query returns a comma separated list of sync groups members (IDs and names).


Tags:

access:  public


[ Top ]

method uuid [line 82]

string uuid( [string $playerindex = ""])

uuid

The "player uuid ?" query returns the player uuid. The uuid is used by SqueezeNetwork.


Tags:

access:  public


Parameters:

string   $playerindex   <playerindex>

[ Top ]


Documentation generated on Wed, 16 Sep 2009 18:08:28 +0200 by phpDocumentor 1.4.2