Sounds Configuration Service Provider

4/8/2010

Use the Sounds Configuration Service Provider to configure the sounds associated with various events on the device.

Note

This Configuration Service Provider is not available on Windows Mobile Professional and Windows Mobile Classic.

Note

This Configuration Service Provider can be managed over both the OMA Client Provisioning (formerly WAP Client Provisioning) and the OMA DM protocol.

In the root characteristic, the default security roles are defined. The default security role maps to each subnode unless specific permission is granted to the subnode.

Permissions

Read/write

Roles allowed to query and update setting

Manager

AuthenticatedUser

UnauthenticatedUser

The following image shows the management object used by OMA DM.

Bb737393.c59f7f8e-2562-483a-a7c8-c96c9b0ab466(en-us,MSDN.10).gif

The following image shows the Configuration Service Provider in tree format as used by OMA Client Provisioning.

Bb737393.19e33c30-baab-43be-a030-9d94ed1188de(en-us,MSDN.10).gif

Characteristics

  • HKCU\ControlPanel\Sounds\BusyTone
    Busy tone sound.
  • HKCU\ControlPanel\Sounds\CallWaiting
    Call waiting sound.
  • HKCU\ControlPanel\Sounds\CellBroadcast
    New Cell broadcast message.
  • HKCU\ControlPanel\Sounds\Clock
    Alarm 1 sound.
  • HKCU\ControlPanel\Sounds\Clock2
    Alarm 2 sound.
  • HKCU\ControlPanel\Sounds\E-Mail
    New e-mail sound.
  • HKCU\ControlPanel\Sounds\IM
    New IM message.
  • HKCU\ControlPanel\Sounds\KeyPress
    Key press sound.
  • KCU\ControlPanel\Sounds\Loudest
    The sound played on max volume change.
  • KCU\ControlPanel\Sounds\LoudestInCall
    The sound played on max volume change while in a call.
  • HKCU\ControlPanel\Sounds\MenuCommand
    Menu sound.
  • HKCU\ControlPanel\Sounds\MenuPopup
    Menu popup sound.
  • HKCU\ControlPanel\Sounds\Password
    Password sound.
  • HKCU\ControlPanel\Sounds\Reminder
    Reminder sound.
  • HKCU\ControlPanel\Sounds\RingTone0
    Ring Tone for Line 1.
  • HKCU\ControlPanel\Sounds\RingTone1
    Ring Tone for line 2.
  • HKCU\ControlPanel\Sounds\SMS
    New Short Message Service (SMS) message sound.
  • KCU\ControlPanel\Sounds\Standard
    The sound played on a normal (i.e. non-max) volume change.
  • KCU\ControlPanel\Sounds\StandardInCall
    The sound played on a normal (i.e. non-max) volume change while in a call.
  • HKCU\ControlPanel\Sounds\SystemAsterisk
    System asterisk sound.
  • HKCU\ControlPanel\Sounds\SystemDefault
    System default sound.
  • HKCU\ControlPanel\Sounds\SystemExclamation
    System exclamation sound.
  • HKCU\ControlPanel\Sounds\SystemHand
    System hand sound.
  • HKCU\ControlPanel\Sounds\SystemStart
    Boot up sound.
  • HKCU\ControlPanel\Sounds\SystemQuestion
    System Question sound.
  • HKCU\ControlPanel\Sounds\Toolkit
    SIM Toolkit event sound.
  • HKCU\ControlPanel\Sounds\VoiceMail
    New voice mail message sound.
  • HKCU\ControlPanel\Sounds\Warning
    System warning sound.

Parameters

  • DeleteRingTone
    This parm is used only under the root Sounds characteristic. This parm is passed in containing the fully qualified path of the sound that is to be deleted. Only sound files that are stored in the %CE18%\Application Data\Sounds directory can be deleted using this parm, and only *.wav, *.mid, *.rmi files can be deleted by the Sound Configuration Service Provider. %CE18% represents the default volume. The translation="install" attribute informs the Configuration Manager to translate the CE string to the designated directory in Windows Mobile Standard.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    String

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • InitVol
    Identifies the initial volume for System sound category.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    Integer

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • MessageBox
    This parm is used in the HKCU\ControlPanel\Sounds\SystemExclamation characteristic to identify the sound associated for the system critical stop, exclamation and asterisk message types.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    Integer

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • ModeGSM
    This parm is used in the HKCU\ControlPanel\Sounds\KeyPress characteristic to identify the beep mode for keypress sounds on a GSM phone.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    Integer

    Label

    Keypad control :

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • ModeCDMA
    This parm is used in the HKCU\ControlPanel\Sounds\KeyPress characteristic to identify the beep mode for keypress sounds on a CDMA phone.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    Integer

    Label

    Keypad control :

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • RingTypeAll
    This parm is used to identify the script that determines how a ring is played.

    The following table shows the default settings.

    Permissions

    Read/write

    Data type

    String

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

  • Sound
    This parm is used in all Sounds characteristics. Under each characteristic, this parm is passed as a string specifying the fully qualified path of the sound file to play when the corresponding event occurs (for example, when the alarm clock time is up). Alternatively, you can specify the special values *vibrate* or *none*.

    Value Description

    string

    Sound file to play on event.

    *vibrate*

    Causes the phone to vibrate on event.

    *none*

    Causes the phone to do nothing on event.

    The following table shows the default settings:

    Permissions

    Read/write

    Data type

    String

    Roles allowed to query and update setting

    Manager

    AuthenticatedUser

    UnauthenticatedUser

    The following table shows how this parm is used in the Registry Configuration Service Provider:

    • DeleteRingTone has the Delete sound: label.
    • HKCU\ControlPanel\Sounds\CallWaiting\Sound has the Call waiting: label.
    • HKCU\ControlPanel\Sounds\CellBroadcast\Sound has the New channel message: label.
    • HKCU\ControlPanel\Sounds\Clock\Sound has the Alarm 1 sound: label.
    • HKCU\ControlPanel\Sounds\Clock2\Sound has the Alarm 2 sound: label.
    • HKCU\ControlPanel\Sounds\E-Mail\Sound has the New e-mail: label.
    • HKCU\ControlPanel\Sounds\IM\Sound has the Ring tone for line 1: label.
    • HKCU\ControlPanel\Sounds\KeyPress\ModeGSM has the Keypad control: label.
    • HKCU\ControlPanel\Sounds\KeyPress\ModeCDMA has the Keypad control: label.
    • HKCU\ControlPanel\Sounds\MenuCommand\Sound has the Menu command: label.
    • HKCU\ControlPanel\Sounds\MenuPopup\Sound has the Menu popup: label.
    • HKCU\ControlPanel\Sounds\Password\Sound has the Password: label.
    • HKCU\ControlPanel\Sounds\Reminder\Sound has the Reminders: label.
    • HKCU\ControlPanel\Sounds\RingTone0\Sound has the Ring tone for line 1: label.
    • HKCU\ControlPanel\Sounds\RingTone1\Sound has the Ring tone for line 2: label.
    • HKCU\ControlPanel\Sounds\SMS\Sound has the New SMS: label.
    • HKCU\ControlPanel\Sounds\SystemAsterisk\Sound has the Asterisk: label.
    • HKCU\ControlPanel\Sounds\SystemDefault\Sound has the System default: label.
    • HKCU\ControlPanel\Sounds\SystemExclamation\MessageBox has the Exclamation: label.
    • HKCU\ControlPanel\Sounds\SystemHand\Sound has the Critical stop: label.
    • HKCU\ControlPanel\Sounds\SystemQuestion\Sound has the Question: label.
    • HKCU\ControlPanel\Sounds\SystemStart\Sound has the Start up: label.
    • HKCU\ControlPanel\Sounds\Toolkit\Sound has the SIM toolkit messages: label.
    • HKCU\ControlPanel\Sounds\VoiceMail\Sound has the New voice message: label.
    • HKCU\ControlPanel\Sounds\Warning\Sound has the Warnings: label.
    • HKCU\ControlPanel\Sounds\BusyTone\Sound has the Busy: label.

Microsoft Custom Elements

The following table shows the Microsoft custom elements that this Configuration Service Provider supports for OMA Client Provisioning.

Elements Available

parm-query

Yes

noparm

No

nocharacteristic

No

characteristic-query

No

Use these elements to build standard OMA Client Provisioning (formerly WAP Client Provisioning) configuration XML. For information about specific elements, see MSPROV DTD Elements. For examples of how to generally use the Microsoft custom elements, see OMA Client Provisioning XML File Examples.

For information about OMA Client Provisioning, see OMA Client Provisioning Files.

See Also

Tasks

Sounds Configuration Service Provider Examples for OMA Client Provisioning

Concepts

Configuration Service Provider Reference for Windows Mobile Devices