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

Class: SqueezeAlarm

Source Location: /lib/class.SqueezeAlarm.php

Class Overview

SqueezeAlarm


Author(s):

Copyright:

Methods


 

Class Details

[line 27]
SqueezeAlarm

SqueezePlayer Alarms interface


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

SqueezeAlarm __construct( SqueezeConnection $CLI, string $playerid)

SqueezeAlarm (constructor)



Parameters:

SqueezeConnection   $CLI  
string   $playerid  

[ Top ]

destructor __destruct [line 271]

void __destruct( )

SqueezeAlarm (destructor)



[ Top ]

method add [line 77]

array add( [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = -1], [string $volume = ""], [string $url = ""])

add

Adds a new alarm.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]

method alarms [line 253]

array alarms( [integer $start = 0], [integer $itemsPerResponse = 5], [string $dow = ""], [string $filter = "enabled"])

alarms

The "alarms" query returns information about player alarms.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

integer   $start   <start>
integer   $itemsPerResponse   <itemsPerResponse>
string   $dow   If present, the query returns information about this Day Of Week only. Note this takes precedence over any "filter" parameter. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday.
string   $filter   One of "all" or "enabled" (the default). To get all possible alarms, use "all". To get only enabled alarms, use "enabled"

[ Top ]

method defaultvolume [line 218]

array defaultvolume( [string $id = ""], [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = 0], [string $volume = ""], [string $url = ""])

defaultvolume

Sets the default volume of an alarm.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $id   The id of an existing alarm. This value is mandatory unless you "add" a new alarm.
string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]

method delete [line 134]

array delete( [string $id = ""], [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = 0], [string $volume = ""], [string $url = ""])

delete

Deletes an alarm.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $id   The id of an existing alarm. This value is mandatory unless you "add" a new alarm.
string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]

method disableall [line 190]

array disableall( [string $id = ""], [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = 0], [string $volume = ""], [string $url = ""])

disableall

Disables all alarms.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $id   The id of an existing alarm. This value is mandatory unless you "add" a new alarm.
string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]

method enableall [line 162]

array enableall( [string $id = ""], [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = 0], [string $volume = ""], [string $url = ""])

enableall

Enables all alarms.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $id   The id of an existing alarm. This value is mandatory unless you "add" a new alarm.
string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]

method playlists [line 237]

array playlists( )

playlists

The "alarm playlists" returns all the playlists, sounds, favorites etc. available to alarms.


Tags:

return:  <taggedParameters>
access:  public


[ Top ]

method update [line 106]

array update( [string $id = ""], [string $dow = "0,1,2,3,4,5,6"], [string $dowAdd = ""], [string $dowDel = ""], [boolean $enabled = false], [boolean $repeat = true], [integer $time = 0], [string $volume = ""], [string $url = ""])

update

Updates an alarm.


Tags:

return:  <taggedParameters>
access:  public


Parameters:

string   $id   The id of an existing alarm. This value is mandatory unless you "add" a new alarm.
string   $dow   Day Of Week. 0 is Sunday, 1 is Monday, etc. up to 6 being Saturday. You can define a group of days by concatenating them with "," as separator. Default: 0-6.
string   $dowAdd   Add a single day of the week to the alarm list This takes precendence over anything sent in the dow tag
string   $dowDel   Removes a single day (0-6) of the week from the alarm list This takes precendence over anything sent in the dow tag
boolean   $enabled   1 if the alarm is enabled. Default: 0.
boolean   $repeat  
  1. if the alarm repeats. Default: 1.
integer   $time   Time of the alarm, in seconds from midnight. Mandatory when add command is issued
string   $volume   Mixer volume of the alarm. Default: use the default volume for alarms. Mandatory when defaultvolume command is issued
string   $url   URL of the alarm playlist. Default: the current playlist. url should be a valid Squeezecenter audio url. The special value 0 means the current playlist.

[ Top ]


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