Difference between revisions of "Developer:Davaar:VolumeService"
(→Volume) |
(→Volume Actions) |
||
| Line 10: | Line 10: | ||
=== Volume === | === Volume === | ||
=== Set Volume=== | === Set Volume=== | ||
| + | === Volume Inc=== | ||
| + | === Volume Dec === | ||
=== Volume Limit === | === Volume Limit === | ||
=== Balance === | === Balance === | ||
=== Set Balance === | === Set Balance === | ||
| + | === Balance Inc=== | ||
| + | === Balance Dec === | ||
=== Fade === | === Fade === | ||
=== Set Fade === | === Set Fade === | ||
| + | === Fade Inc=== | ||
| + | === Fade Dec === | ||
=== Mute === | === Mute === | ||
=== Set Mute === | === Set Mute === | ||
| + | === Characteristics === | ||
==Preset Name== | ==Preset Name== | ||
Revision as of 11:46, 23 November 2010
Contents
Architecture Overview
The Delay Service maintains a list of delay Presets within the product. The size of this list is fixed for each product and reported by the PresetCount function. Each Preset can then be referenced by a unique index* in the list. Only one Preset, and thus one index, can be active at any given time. Each Preset stores three user configurable parameters; Name, Delay and Visible. When a Preset is activated the value of its Delay parameter is applied to the audio signal path, provided the product's currently active source is delayable. [* index is zero based, ie 0,1,2,3,4,5..n, where n=PresetCount-1]
Volume
Balance
Fade
Mute
Volume Actions
Volume
Set Volume
Volume Inc
Volume Dec
Volume Limit
Balance
Set Balance
Balance Inc
Balance Dec
Fade
Set Fade
Fade Inc
Fade Dec
Mute
Set Mute
Characteristics
Preset Name
Preset Name is a user configurable string parameter used to identify a Preset. The function SetPresetName is used to set the Name parameter.
Preset Delay
Preset Delay is a user configurable parameter that specifies the delay in milliseconds (ms) that should be applied*, to the audio signal path, when the Preset is selected. The function SetPresetDelay is used to set the Delay parameter. [* Note: The delay will only be applied if the currently active source is delayable]
Preset Visible
Preset Visible is a user configurable boolean flag that specifies whether a Preset is visible when browsing the list of Presets via the product's front panel. The function SetPresetVisible is used to set the Visible flag.
PresetXml
The function PresetXml returns, in XML format, a list of all Presets and their associated parameters Name, Delay and Visible.
DelayMinimum
DelayMinimum returns the minimum possible delay which can be applied to any Preset. DelayMinimum is read only.
DelayMaximum
DelayMaximum returns the maximum possible delay which can be applied to any Preset. DelayMaximum is read only.
PresetCount
PresetCount returns the number of presets that exist in the Delay Service (ie the Preset list size). PresetCount is read only.
API Reference
Volume Service Description (XML)
Migration Guide
None.
Upnp Action Name Changes
None.
Obsolete Functions
None.
