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

Class: SqueezeMixer

Source Location: /lib/class.SqueezeMixer.php

Class Overview

SqueezeMixer


Author(s):

Copyright:

Methods


 

Class Details

[line 27]
SqueezeMixer

SqueezePlayer Mixer 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]

SqueezeMixer __construct( SqueezeConnection $CLI, [string $playerid = ""])

SqueezeMixer (constructor)



Parameters:

SqueezeConnection   $CLI  
string   $playerid  

[ Top ]

destructor __destruct [line 160]

void __destruct( )

SqueezeMixer (destructor)



[ Top ]

method bass [line 95]

mixed bass( [string $value = ""])

bass

The "mixer bass" command returns or sets the current bass setting for the player. This is only supported by SliMP3 and SqueezeBox (SB1) players. For more information on the 0 to 100 scale, please refer to the "mixer volume" command.


Tags:

return:  (boolean success) or (integer value)
access:  public


Parameters:

string   $value   <0 .. 100|-100 .. +100|?>

[ Top ]

method muting [line 83]

mixed muting( [string $value = ""])

muting

The "mixer muting" command mutes or unmutes the player. Use 0 to unmute, 1 to mute, ? to query and no parameter to toggle the muting state of the player. Note also the "mixer volume" command returns a negative value if the player is muted.


Tags:

return:  (boolean success) or (integer value)
access:  public


Parameters:

string   $value   <0|1|?|>

[ Top ]

method pitch [line 121]

mixed pitch( [string $value = ""])

pitch

The "mixer pitch" command returns or sets the current pitch setting for the player (only supported by SqueezeBox (SB1) players).


Tags:

return:  (boolean success) or (integer value)
access:  public


Parameters:

string   $value   <80 .. 120|-40 .. +40|?>

[ Top ]

method treble [line 108]

mixed treble( [string $value = ""])

treble

The "mixer treble" command returns or sets the current treble setting for the player. This is only supported by SliMP3 and SqueezeBox (SB1) players. For more information on the 0 to 100 scale, please refer to the "mixer volume" command.


Tags:

return:  (boolean success) or (integer value)
access:  public


Parameters:

string   $value   <0 .. 100|-100 .. +100|?>

[ Top ]

method volume [line 70]

mixed volume( [string $value = ""])

volume

The "mixer volume" command returns or sets the current volume setting for the player. The scale is 0 to 100, in real numbers (i.e. 34.5 is valid). If the player is muted, the volume is returned as a negative value. Note that players display a 0 to 40 scale, that is, the 0..100 volume divided by 2,5.


Tags:

return:  (boolean success) or (integer value)
access:  public


Parameters:

string   $value   <0 .. 100|-100 .. +100|?>

[ Top ]


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