Av:Developer:VolumeService - Revision history

Johnh: added documentation for state variables

2013-08-09T15:24:32Z

added documentation for state variables

← Older revision		Revision as of 15:24, 9 August 2013
Line 80:		Line 80:
	=== Characteristics ===		=== Characteristics ===
	The Characteristics action returns all six characteristic values of the product.		The Characteristics action returns all six characteristic values of the product.
		+
		+
		+	= State Variables =
		+
		+	== Volume ==
		+	the current user volume setting, i.e. an integer value in the range [0..VolumeLimit]
		+
		+	== Mute ==
		+	the boolean setting indicating whether all output channels are currently forced to zero volume
		+
		+	== Balance ==
		+	the current setting of bias between left and right output channels, i.e. an integer value in the range [-BalanceMax..+BalanceMax]
		+
		+	== Fade ==
		+	the current setting of bias between front and back output channels, i.e. an integer value in the range [-FadeMax..+FadeMax]
		+
		+	== VolumeLimit ==
		+	the user-imposed (soft) maximum volume setting, i.e. an integer in the range [0..VolumeMax]; read-only
		+
		+	== VolumeMax ==
		+	the system-imposed (hard) maximum volume setting; read-only
		+
		+	== VolumeUnity ==
		+	the system-specific volume setting that results in the input signal amplitude equalling the output signal amplitude (0dB gain), i.e. an integer in the range [0..VolumeMax]; read-only
		+
		+	== VolumeSteps ==
		+	the system-specific number of user-visible volume steps that would increase the volume from zero to VolumeMax; read-only
		+
		+	== VolumeMilliDbPerStep ==
		+	the system-specific gain increase with each volume step in binary milli decibel (mibi dB); read-only
		+
		+	== BalanceMax ==
		+	the system-specific balance value that leads to maximum bias towards the right between output channels; read-only
		+
		+	== FadeMax ==
		+	the system-specific fade value that leads to maximum bias towards the rear between output channels; read-only

	= Technical Details =		= Technical Details =

Johnh: moved expanded discussion of balance setting to Architecture section

2013-08-09T14:51:05Z

moved expanded discussion of balance setting to Architecture section

← Older revision		Revision as of 14:51, 9 August 2013
Line 9:		Line 9:

	==Balance==		==Balance==
-	Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''') .	+	Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''').
		+
		+	A setting of zero results in neutral balance (i.e. no bias applied) between left and right output channels. Negative values amplify left and attenuate right output channels. Conversely, positive values attenuate left and amplify right output channels. Increasing absolute values result in progressively larger amplification/attenuation being applied to output channels in this asymmetric manner. At or near the maximum settings, the attenuated channels may ended up being effectively reduced to volume zero.

	==Fade==		==Fade==
Line 33:		Line 35:

	====BalanceMax====		====BalanceMax====
-	BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax)~~. A setting of zero results in neutral balance (i.e. no artificial bias) between left and right output channels~~.	+	BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax).

	====FadeMax====		====FadeMax====
-	FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax)~~. A setting of zero results in neutral fade (i.e. no artificial bias) between front and back output channels~~.	+	FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax).

Johnh: /* Actions */ elevated SetFade action to same level as all others

2013-08-09T14:24:04Z

Actions: elevated SetFade action to same level as all others

← Older revision		Revision as of 14:24, 9 August 2013
Line 64:		Line 64:
	=== Fade ===		=== Fade ===
	The Fade action reports the current Fade setting of the product.		The Fade action reports the current Fade setting of the product.
-	==== SetFade ====	+	=== SetFade ===
	The SetFade action provides a means of setting the Fade to a specific value.		The SetFade action provides a means of setting the Fade to a specific value.
	=== FadeInc===		=== FadeInc===

Johnh: /* Characteristics */ de-emphasised number of values returned by Characteristics action

2013-08-09T14:23:17Z

Characteristics: de-emphasised number of values returned by Characteristics action

← Older revision		Revision as of 14:23, 9 August 2013
Line 77:		Line 77:

	=== Characteristics ===		=== Characteristics ===
-	The Characteristics action returns all ~~'''~~six~~'''~~ characteristic values of the product.	+	The Characteristics action returns all six characteristic values of the product.

	= Technical Details =		= Technical Details =

Johnh: expanded def'n of Characteristics; added neutral balance and fade; fixed minor spelling, layout glitches

2013-08-09T14:20:38Z

expanded def'n of Characteristics; added neutral balance and fade; fixed minor spelling, layout glitches

← Older revision		Revision as of 14:20, 9 August 2013
Line 17:		Line 17:
	Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.		Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

		+	==Characteristics==
		+	Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

-	~~==Characterstics==~~
-	~~Each product has '''six''' read only values that define its volume Characteristics.~~
	====VolumeMax====		====VolumeMax====
	VolumeMax defines the absolute maximum Volume setting.		VolumeMax defines the absolute maximum Volume setting.

	====VolumeUnity====		====VolumeUnity====
-	VolumeUnity defines the value of Volume that will result in unity system gain (ie ''output amplitude'' = ''input amplitude'').	+	VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

	====VolumeSteps====		====VolumeSteps====
	VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.		VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.
		+
	====VolumeMilliDbPerStep====		====VolumeMilliDbPerStep====
-	VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (~~bmdB~~). [''~~1024bmdB~~ = 1dB'']	+	VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

	====BalanceMax====		====BalanceMax====
-	BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax)	+	BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax). A setting of zero results in neutral balance (i.e. no artificial bias) between left and right output channels.
		+
	====FadeMax====		====FadeMax====
-	FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax)	+	FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax). A setting of zero results in neutral fade (i.e. no artificial bias) between front and back output channels.

Openhome at 15:16, 5 May 2011

2011-05-05T15:16:38Z

← Older revision		Revision as of 15:16, 5 May 2011
Line 85:		Line 85:

	== Volume Service Description (XML) ==		== Volume Service Description (XML) ==
-	<~~code~~>	+	<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>
	<scpd xmlns="urn:schemas-upnp-org:service-1-0">		<scpd xmlns="urn:schemas-upnp-org:service-1-0">
Line 285:		Line 285:
	</serviceStateTable>		</serviceStateTable>
	</scpd>		</scpd>
-	</~~code~~>	+	</syntaxhighlight>

Joshh: /* Volume Service Description (XML) */

2011-05-05T14:13:56Z

Volume Service Description (XML)

Show changes

Joshh: /* Technical Details */

2011-05-05T14:06:48Z

Technical Details

← Older revision		Revision as of 14:06, 5 May 2011
Line 83:		Line 83:
	Version : 1		Version : 1
	</code>		</code>
-	~~[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Volume1.xml~~ Volume Service Description (XML)]	+
		+	== Volume Service Description (XML) ==
		+	<code>
		+	</code>

Keith: moved Developer:VolumeService to Av:Developer:VolumeService

2011-04-28T13:59:55Z

moved Developer:VolumeService to Av:Developer:VolumeService

← Older revision

Revision as of 13:59, 28 April 2011

Joshh: /* API Reference */

2011-04-28T12:30:31Z

API Reference

← Older revision		Revision as of 12:30, 28 April 2011
Line 77:		Line 77:
	The Characteristics action returns all '''six''' characteristic values of the product.		The Characteristics action returns all '''six''' characteristic values of the product.

-	= ~~API Reference~~ =	+	= Technical Details =
-		+	<code>
		+	Domain : av.openhome.org
		+	Name : Volume
		+	Version : 1
		+	</code>
	[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Volume1.xml Volume Service Description (XML)]		[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Volume1.xml Volume Service Description (XML)]