Developer:Davaar:VolumeService

From LinnDocs
Revision as of 11:56, 23 November 2010 by Eamonnb (talk | contribs) (Volume Actions)
Jump to: navigation, search

Architecture Overview

The Volume service

Volume

Balance

Fade

Mute

Characterstics

VolumeMax

VolumeUnity

VolumeSteps

VolumeMilliDbPerStep

BalanceMax

FadeMax

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.