Provisioning XML Document for Sound Scheme Configuration Service Provider (Compact 2013)

  • Article

3/26/2014

Configuration Manager uses this XML document to configure the scheme that is used for system sound events and for the volume of sounds on a Windows Embedded Compact powered device.

Syntax

<wap-provisioningdoc>
   <characteristic type="SndScheme">
     <characteristic type="<RegistryPath>">
      <parm name="<ParmName>" value="<ParmValue>" datatype="<DataType>" />
      <parm-query name="<ParmName>" />
     </characteristic>
   </characteristic>
</wap-provisioningdoc>

Elements

Element name

Description

Attributes

characteristic

Groups settings for a configuration service provider.

TermDescription
typeThe type of group. It can be one of the following:

ValueDescription
SndSchemeIndicates the root characteristic element for the Sound Scheme configuration service provider.
HKLM\Snd\EventIndicates settings for sound events.
HKCU\ControlPanel\VolumeIndicates settings for volume.

parm

Metadata that describes a device setting.
name

The name of the device setting to configure. It can be one of the following:

ValueDescription
EventMaskA mask that allows a device to hide some sound events. Available when the parent characteristic element uses a type of "HKLM\Snd\Event." When used, the corresponding value attribute is a mask that specifies the sound events to hide. The sound events are from the following ordered list:
  • Asterisk
  • Close
  • Critical
  • Default
  • Empty
  • Exclam
  • Infbeg
  • Infend
  • Infintr
  • MenuPop
  • MenuSel
  • OpenProg
  • Question
  • Netbeg
  • Netend
  • Netintr
  • Startup
  • WindMax
  • WindMin
  • RecStart
  • RecEnd
The mask is a DWORD. Its default value is FFFFF, which means that all sounds work. From bit 0 to bit 20, each bit can mask an event in the ordered list. For example, 1FFFF masks Window-Maximize and Window-Minimize sounds. For example, FFFFFE masks Asterisk sounds.
EventCacheSound event cache. Available when its parent characteristic element's type is "HKLM\Snd\Event." When used, the corresponding value attribute specifies the cache popup menu and menu selection. This value is not writeable.
.NoSoundsThe "No Sounds" sound scheme. Available when its parent characteristic element's type is "HKLM\Snd\Event." When used, the corresponding value attribute sets the "No Sounds" sound scheme that can be selected by the device user. The value is a string of sound events and DWORD values, separated by semicolons.
.SchemeThe current sound scheme. Available when its parent characteristic element's type is "HKLM\Snd\Event." When used, the corresponding value attribute is a string that sets the current sound scheme on the device, for example, "DefaultSounds."
.DefaultSoundsThe default sound scheme. Available when its parent characteristic element's type is "HKLM\Snd\Event." When used, the corresponding value attribute sets the default sound scheme on the device. The value is a string of sound events and DWORD values, separated by semicolons.
.AllSoundsThe "All Sounds" sound scheme. Available when its parent characteristic element's type is "HKLM\Snd\Event." When used, the corresponding value attribute sets the "All Sounds" sound scheme that can be selected by the device user. The value is a string of sound events and DWORD values, separated by semicolons.
Key
The volume of taps on the on-screen keyboard.Available when its parent characteristic element's type is "HKCU\ControlPanel\Volume."When used, the corresponding value attribute can be one of the following:

ValueDescription
0Mute
1Soft
2Loud
Screen
The volume for screen taps.Available when its parent characteristic element's type is "HKCU\ControlPanel\Volume."When used, the corresponding value attribute can be set to one of the following:

ValueDescription
0Mute
1Soft
2Loud
Mute
The kinds of sounds that are audible.Available when its parent characteristic element's type is "HKCU\ControlPanel\Volume."When used, the corresponding value attribute is a bitwise OR of the following values:

ValueDescription
1Notification sounds are audible.
2Application sounds are audible.
4Event sounds are audible.
PlaySoundThe volume level for playing sounds on the device. Available when its parent characteristic element's type is "HKCU\ControlPanel\Volume." When used, the corresponding value attribute is a volume-level value that ranges from 0 (zero) to 0xFFFFFFFF.
VolumeThe default volume. Available when its parent characteristic element's type is "HKCU\ControlPanel\Volume." When used, the corresponding value attribute is a volume-level value that ranges from 0 (zero) to 0xFFFFFFFF.
value

See descriptions in name attribute for possible values.

parm-query

Specifies a request for the current value of a setting.
name

Any supported name attribute listed above.

value

On return, contains the value of the setting provided in name.

Remarks

To change device settings for the system sound scheme, you can write a provisioning XML file that you customize for the Sound Scheme configuration service provider. However, the Sound Scheme configuration service provider supports only a subset of elements and its own attribute values for the characteristic and parm elements.

For more information about elements, see Provisioning XML Document.

Example

The following code example sets the volume level for playing sounds on the device.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

<wap-provisioningdoc>
 <characteristic type="SndScheme">
  <characteristic type="HKCU\ControlPanel\Volume">
      <parm name="PlaySound" value="65538" datatype="integer" />
  </characteristic>
 </characteristic>
</wap-provisioningdoc>

See Also

Reference

Configuration Service Provider Reference
IConfigManager