Difference between revisions of "Developer:Davaar:VolumeService"

From LinnDocs
Jump to: navigation, search
(Characteristics)
Line 51: Line 51:
  
 
==== Characteristics ====
 
==== Characteristics ====
The Characteristics action reports the current Mute state of the product.
+
The Characteristics action returns all six Volume Characteristic values of the product.
 
 
 
 
 
 
 
 
  
 
= API Reference =
 
= API Reference =

Revision as of 13:31, 23 November 2010

Architecture Overview

The Volume service

Volume

Balance

Fade

Mute

Characterstics

VolumeMax

VolumeUnity

VolumeSteps

VolumeMilliDbPerStep

BalanceMax

FadeMax

Volume Actions

Volume

The Volume action reports the current master volume setting of the product.

SetVolume

The SetVolume action provides a means of setting the Volume to a specific value. The minimum value that can be applied is zero. The maximum value that can be applied is determined by the VolumeMax and VolumeLimit settings. If an attempt is made to set the Volume above VolumeMax, an error will be reported. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the VolumLimit value and no error will be repoprted.

Volume Inc

The VolumeInc action provides a means of increasing the Volume by 1.

Volume Dec

The VolumeDec action provides a means of decreasing the Volume by 1.

VolumeLimit

The VolumeLimit action reports the current VolumeLimit setting.

Balance

The Balance action reports the current Balance setting.

SetBalance

The SetBalance action provides a means of setting the Balance to a specific value.

BalanceInc

The BalanceInc action provides a means of increasing the Balance by 1.

BalanceDec

The BalanceDec action provides a means of decreasing the Balance by 1.

Fade

The Fade action reports the current Fade setting of the product.

SetFade

The SetFade action provides a means of setting the Fade to a specific value.

FadeInc

The FadeIncaction provides a means of increasing the Fade by 1.

FadeDec

The FadeDec action provides a means of decreasing the Fade by 1.

Mute

The Mute action reports the current Mute state of the product.

SetMute

The SetMute action provides a means of setting the Mute state.

Characteristics

The Characteristics action returns all six Volume Characteristic values of the product.

API Reference

Volume Service Description (XML)

Migration Guide

None.

Upnp Action Name Changes

None.


Obsolete Functions

None.