Audio Volume UI Manager

To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

Input fields accept ENGLISH ONLY.

Queries from MX are not supported on Zebra devices running Android 11 or later. See alternative method.

EMDK For Xamarin - 9.0

Overview

The Audio Volume UI Manager (AudioVolUIMgr) can add, delete and replace Audio Profiles, and can select an Audio Profile to be in effect on the device. It also allows administrators to modify the "Factory Preset" Audio Profile (which cannot be deleted), and to directly control the Mute and Vibrate states of the device, which are independent of all audio streams and Audio Profiles.

Many Zebra Android devices contain a Zebra Volume Control (ZVC), a UI component that allows a device user to easily adjust the volumes of various audio streams in the device. An audio stream is a channel through which audio can be generated and output to a speaker or headset. The number of audio streams supported by an Android device is generally fixed, but the number of possible purposes for which audio can be generated is theoretically unlimited. As a result, a particular audio stream might be used for a purpose other than that for which it was intended.

Main Functionality

Create, delete and modify Audio Profiles
Set an Audio Profile as the current Audio Profile
Set the Factory Preset Audio Profile as the current Audio Profile
Change the volume levels to be the Preset volume levels of the current Audio Profile
Control the global mute and vibrate usage and states of the device

NOTE: The Zebra Volume Control component is included on most Zebra Android devices running KitKat and higher. It is enabled by default on all devices except those running Lollipop, on which it must be enabled manually. AudioVolUIMgr is supported only on devices that include the ZVC.

The standard Android Audio Volume Control UI identifies each audio stream that can be controlled in a fixed manner that is predefined for each audio stream. Such identification might not accurately reflect the purposes for which a given audio stream is being used. This can produce less than optimal user experiences since the device user might change the volume of an audio stream without realizing its affect on other systems.

The ZVC allows configuration of the manner in which audio Streams are identified to the device user, thus allowing the user experience to be customized. The ZVC also provides even more control over the user experience by allowing configuration of the minimum, maximum, and preset values for a given audio stream. For example, the minimum volume for an audio stream could be set as some value greater than zero to prevent a device user from turning it off completely and potentially missing important audio notifications that are performed on that audio stream.

The ZVC also provides support for Audio Profiles, which define different scenarios or use cases in which one or more audio streams can be used. Each Audio Profile can configure the behavior of ZVC for some or all of the available audio streams. By selecting a defined Audio Profile, the configuration of ZVC for multiple audio streams can be configured in a single operation. For example, there might be one Audio Profile for working in a quiet office and another for working in a noisy warehouse.

The ZVC can be invoked by pressing the volume control buttons on a device (when available) or by selecting the Sound -> Volumes screen from the Android Settings panel. The UI presented by the ZVC is based on the most recent configuration applied to ZVC using the AudioVolUIMgr, in particular the set of defined Audio Profiles and the currently selected Audio Profile.

Supported Streams

The following audio streams are supported:

STREAM_MUSIC - Typically for music playback
STREAM_RING - Typically for notification of an incoming call
STREAM_NOTIFICATION - Typically for other notifications
STREAM_SYSTEM - Typically used by system sounds
STREAM_ALARM - Typically used for alarms
STREAM_VOICE_CALL - Typically used for phone calls
STREAM_VVS - This is the Decode Beep Virtual Volume Scale, a special stream that produces audible notifications for barcode scanning on Zebra devices.

An Audio Profile can be defined to configure the following settings for any or all of the above audio streams:

Label - A text label displayed by the ZVC to identify the audio stream.
Icon - An icon displayed by the ZVC to identify the audio stream.
Visibility - Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream. For example, this could be used to prevent a device user from making any changes to the volume of the audio stream used for incoming call notification.

Volume Levels

An Audio Profile can configure the volume levels for each of four audio modes: Speaker, Receiver, Wired headset, and Bluetooth headset. The specified modes are determined based on the physical output path to which an audio stream is directed. For each mode, the following volume levels can be specified.

Minimum volume level - Prevents a device user from reducing the volume of the audio stream below a specified level. This can be useful in noisy environments, for example, to prevent a user from setting the notification audio stream to an inaudible level.
Maximum volume level - Prevents a device user from increasing the volume of the audio stream above a specified level. This could be useful in quiet environments, for example, to prevent a user from setting music playback above a specified level.
Preset volume level - This causes the ZVC to set the volume of the audio stream to the specified value when this Audio Profile becomes selected as the current Audio Profile.
Out-of-range Settings - If a preset volume level is set to a value that is more than its maximum or less than its minimum, the volume is set to the median value for that stream.

NOTE: The Zebra Volume Control component is included on most Zebra Android devices running KitKat and higher. It is enabled by default on all devices except those running Lollipop, on which it must be enabled manually. AudioVolUIMgr is supported only on devices that include the ZVC.

IMPORTANT: For Zebra Professional-series devices, Zebra Volume Control requires purchase of a Mobility DNA Enterprise License. About MDNA licensing.

Mute/Vibrate Usage Enable/Disable

Controls whether the device user can change the Mute/Vibrate States (On/Off) on the device.

Parm Name: MuteVibrateUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 11.6+
1	Enable	Enables the device user to change the Mute/Vibrate states on the device.	MX: 11.6+
2	Disable	Prevents the device user from changing the Mute/Vibrate states (On/Off) on the device.	MX: 11.6+

Vibrate Icon Usage Enable/Disable

Controls whether the device user can change the state (show/hide) of the vibration icon on the Status Bar of the device. Note: This parameter does NOT control display of the vibration icon; it controls the device user's ability to do so.

Parm Name: VibrateIconUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 13.2+
1	Enable	Enables the device user to change the state (show/hide) of the vibration icon on the Status Bar.	MX: 13.2+
2	Disable	Prevents the device user from changing the state (show/hide) of the vibration icon on the Status Bar.	MX: 13.2+

Set the Active Profile

Used to set a previously created Audio Profile or the Factory Preset Audio Profile to be the current Audio Profile. Also can be used to force the volumes of all audio streams back to the Preset volumes specified for the current Audio Profile.

Note: Since the configuration of the Factory Preset Audio Profile can be modified, resetting to the FactoryPreset profile (option 3) might not result in "Factory Defined" settings.

Parm Name: CurrentProfileAction

Option	Name	Description	Requires
0	Do nothing	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	OSX: 4.4+ MX: 4.4+
1	Set an Audio UI Profile as the current Profile	Causes a previously created Audio Profile to be made the new current Audio Profile.	OSX: 4.4+ MX: 4.4+
2	Adjust to the Preset volume level of the current Profile	Causes the volume levels of all audio streams to be reset to the Preset volume levels configured for the current Audio Profile.	OSX: 4.4+ MX: 4.4+
3	Set the FactoryPreset Profile as the current Profile	Causes the Factory Preset Audio Profile to be the current Audio Profile.	OSX: 4.4+ MX: 4.4+

Current Profile Name

Used to enter the name of an existing Audio Profile to be set as the new current Audio Profile. If the specified name does not match the name of a currently defined Audio Profile, an error will be returned in the Result XML document.

Parm value input rules:

String from 1–255 characters

Shown if: The Current Active Profile Action is "Set an Audio UI Profile as the current Profile"

Parm Name: CurrentProfileName

Requires:

OSX: 4.4+

MX: 4.4+

Set Audio Volume

Used to enter whether the current volume levels of all audio streams affected by the Audio Profile should be set to the Preset volume levels of that Audio Profile.

Shown if: The Current Active Profile Action is "Set an Audio UI Profile as the current Profile"

Parm Name: SetCurrentProfileOption

Option	Name	Description	Note	Status	Requires
1	Do not adjust the volume level	Causes the Preset volume levels specified for all audio streams in the new current Audio Profile to be ignored. If the current volume level of an audio stream is less than the minimum, it will be changed to the minimum and if the current volume level of an audio stream is greater than the minimum, then it will be changed to the maximum. Otherwise, the current volume level of an audio stream will be unchanged.			OSX: 4.4+ MX: 4.4+
2	Adjust the volume level	Causes the Preset volume levels specified for all audio streams in the new Audio Profile to be made the current volume levels for those audio streams. This option ensures that a specific set of volumes will be in effect after setting a new current Audio Profile. This should be used with caution since it could have a noticeable impact on current or future audio output.			OSX: 4.4+ MX: 4.4+

Option

Name

Description

Note

Status

Requires

Do not adjust the volume level

Causes the Preset volume levels specified for all audio streams in the new current Audio Profile to be ignored. If the current volume level of an audio stream is less than the minimum, it will be changed to the minimum and if the current volume level of an audio stream is greater than the minimum, then it will be changed to the maximum. Otherwise, the current volume level of an audio stream will be unchanged.

OSX: 4.4+

MX: 4.4+

Adjust the volume level

Causes the Preset volume levels specified for all audio streams in the new Audio Profile to be made the current volume levels for those audio streams. This option ensures that a specific set of volumes will be in effect after setting a new current Audio Profile. This should be used with caution since it could have a noticeable impact on current or future audio output.

OSX: 4.4+

MX: 4.4+

Audio UI Profile Action

Used to create a new Audio Profile, modify the "FactoryPreset" Audio Profile or modify or delete an existing Audio Profile. If an Audio Profile with the specified name exists in the device, it will be replaced by the newly defined one. If an Audio Profile with the specified name does not exist in the device, an error will be returned in the Result XML document.

Note: The "Remove an Audio UI Profile" feature (option 2) works only on inactive Profiles.

Parm Name: UIProfileAction

Option

Name

Description

Note

Status

Requires

Do nothing

This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.

OSX: 4.4+

MX: 4.4+

Add an Audio UI Profile

Causes a new Audio Profile to be created, or an existing Audio Profile or the Factory Preset Audio Profile to be modified.

OSX: 4.4+

MX: 4.4+

Remove an Audio UI Profile

Deletes the named Audio Profile (must not be an active Profile).

OSX: 4.4+

MX: 4.4+

Audio UI Profile Name

Used to enter the name of the Audio Profile to Create, Modify or Delete. Specified name must match exactly the name specified when setting the current Audio Profile using the CurrentProfileName parameter.

NOTE: This value cannot be "FactoryPreset" since this is a reserved name for the FactoryPreset Profile built into the device.

Parm value input rules:

String from 1–255 characters

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile" or "Remove an Audio UI Profile"

Parm Name: ProfileName

Requires:

OSX: 4.4+

MX: 4.4+

Music Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used for music playback.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_Label

Requires:

OSX: 4.4+

MX: 4.4+

Music Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used for music playback. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: he Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Music Control Parameters

Controls whether the ZVC allows the user to view and modify the volume settings for the audio stream that is typically used for music playback. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Music Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for music playback when the device is in speaker mode. Valid range for music playback stream is 0–15 (0=inaudible; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the music volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the audio stream that is typically used for music playback to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–15.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Music Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for music playback when the device is in receiver mode. Valid range for this stream is 0–15 (0=inaudible; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the music volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–15.

Note: DEPRECATED on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Music Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for music playback when the device is in wired headset mode. Valid range for this stream is 0–15 (0=inaudible; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the music volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

IMPORTANT: In accordance with an EU health and safety rule, the volume for this parameter cannot be set to a level greater than 10. Attempts to do so through the Android Settings panel are rejected, and remote configuration through DNA Cloud, OEMConfig, StageNow, or an EMM system cause the level to revert to its most recent setting (if any) or to the Android-default setting.

Parm value input rules:

String containing the minimum, maximum, and preset volumes in this order separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–15.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Music Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for music playback when the device is in Bluetooth headset mode mode. Valid range for this stream is 0–15 (0=inaudible; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the music volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–15.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_MUSIC_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Music HDMI Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for media when the device is connected via HDMI cable to an external monitor. Valid range for this stream is 1–15 (1=lowest; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the voice call volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,15,12" sets a minimum of 1, a maximum of 15 and a preset of 12.
Positive integers from 1–15.

Parm Name: STREAM_MUSIC_HDMI_LEVEL

Requires:

MX: 11.2+

Incoming Call Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used for the incoming call notification.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_Label

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used for the incoming call notification. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream that is typically used for the typically used for the incoming call notification. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for the incoming call notification when the device is in speaker mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the ring tone volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11 (and later), this parameter controls RING, NOTIFICATION and SYSTEM stream parameters for all output types (BTHS, RCVR, SPK and WHS). Android 11 does not permit separate control of those audio streams or output devices.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for the incoming call notification when the device is in receiver mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the ring tone volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for the incoming call notification when the device is in wired headset mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the ring tone volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Incoming Call Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for the incoming call notification when the device is in Bluetooth headset mode mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the ring tone volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_RING_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Notification Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used for other notifications.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_Label

Requires:

OSX: 4.4+

MX: 4.4+

Notification Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used for other notifications. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Notification Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream that is typically used for other notifications. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Notification Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for other notifications when the device is in speaker mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the notification volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

IMPORTANT: If NOTIFICATIONS are "muted" then decode beeps are also muted. Device decode beep sounds operate on a sub-channel of the NOTIFICATIONS channel and cannot operate independently.

For devices running Android 11+, see additional "Note" below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Notification Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for other notifications when the device is in receiver mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the notification volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Notification Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for other notifications when the device is in wired headset mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the notification volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Notification Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for other notifications when the device is in Bluetooth headset mode mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the notification volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_NOTIFICATION_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used by system sounds.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_Label

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used by system sounds. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_Icon

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream that is typically used by system sounds. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used by system sounds when the device is in speaker mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used by system sounds when the device is in receiver mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used by system sounds when the device is in wired headset mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

System Sounds Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used by system sounds when the device is in Bluetooth headset mode mode. Valid range for this stream is 0–7 (0=inaudible; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–7.

Note: On devices running Android 11, this parameter is superseded by STREAM_RING. Settings for this parameter applied to a device running Android 11 from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_SYSTEM_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used for alarms.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_Label

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used for alarms. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream that is typically used for alarms. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for alarms when the device is in speaker mode. Valid range for this stream is 1–7 (1=min; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the alarm volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the audio stream that is typically used for alarms to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–7.

Note: On some devices running Android 8.x Oreo and earlier, a setting of 0 (sound off) is supported.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for alarms when the device is in wired headset mode. The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–7.

Note: SUPERSEDED by STREAM_ALARM_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored. On some devices running Android 8.x Oreo and earlier, a setting of 0 (sound off) is supported.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Alarm Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for alarms when the device is in receiver mode. Valid range for this stream is 1–7 (1=min; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the alarm volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the audio stream that is typically used for alarms to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–7.

Note: DEPRECATED on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored. On some devices running Android 8.x Oreo and earlier, a setting of 0 (sound off) is supported.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Bluetooth Alarm Volume

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for alarms when the device is in Bluetooth headset mode mode. Valid range for this stream is 1–7 (1=min; 7=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the system volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–7.

Note: SUPERSEDED by STREAM_ALARM_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored. On some devices running Android 8.x Oreo and earlier, a setting of 0 (sound off) is supported.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_ALARM_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Label

Used to set a customized label that the ZVC will display to visually identify the audio stream that is typically used for phone calls.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_Label

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Icon

Used to set a customized icon that the ZVC will display to visually identify the audio stream that is typically used for phone calls. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the audio stream that is typically used for phone calls. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for phone calls when the device is in speaker mode. Valid range for this stream is 1–5 (1=lowest; 5=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the voice call volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–5.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for phone calls when the device is in receiver mode. Valid range for this stream is 1–5 (1=lowest; 5=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the voice call volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–5.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for phone calls when the device is in wired headset mode. Valid range for this stream is 1–5 (1=lowest; 5=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the voice call volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 1–5.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Voice Call Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream that is typically used for phone calls when the device is in Bluetooth headset mode mode. Valid range for this stream is 1–15 (1=lowest; 15=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the voice call volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,15,12" sets a minimum of 1, a maximum of 15 and a preset of 12.
Positive integers from 1–15.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VOICECALL_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Label

Used to set a customized label that ZVC displays to visually identify the decode beep virtual volume stream.

NOTE: If the value of this parm is empty (a length of 0), no customized label is created for the Audio Stream and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_Label

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Icon

Used to set a customized icon that the ZVC will display to visually identify the decode beep virtual volume stream. If specified, the value must be the full path and file name of an icon file in PNG format that resides in the device file system. An icon size of 48x48 pixels is recommended.

NOTE: If the value of this parm is empty (a length of 0), or if the value provided does not reference an icon file, then no customized icon will be specified for the audio stream. This causes ZVC to display the default icon defined for the audio stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_Icon

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Control Parameters

Controls whether the ZVC allows the device user to view and modify the volume settings for the decode beep virtual volume stream. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to this audio stream's visibility.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible to the device user; "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_Ctrl

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the decode beep virtual stream when the device is in speaker mode. Valid range for this stream is 0–10 (0=inaudible; 10=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the decode beep virtual volume level was outside of this range at the time that this range is set, the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the decode beep virtual stream to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

IMPORTANT: "STREAM_VVS" signals operate on a sub-channel of the NOTIFICATIONS channel and cannot operate independently of it. If NOTIFICATIONS are "muted" then decode beeps are also muted.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–10.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_SPK_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the decode beep virtual stream when the device is in receiver mode. Valid range for this stream is 0–10 (0=inaudible; 10=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the decode beep virtual volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–10.

Note: DEPRECATED on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_RCVR_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the decode beep virtual stream when the device is in wired headset mode. The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the decode beep virtual volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the decode beep virtual stream to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String containing comma-separated list of minimum, maximum, and preset volumes in that order. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
The volume levels must be positive integers that are less than the maximum value for this stream.

Note: SUPERSEDED by STREAM_VVS_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_WHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Decode Beep Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the decode beep virtual stream when the device is in Bluetooth headset mode mode. Valid range for this stream is 0–10 (0=inaudible; 10=max). The user will not be able to lower or raise the volume outside of the minimum/maximum range that is set. If the decode beep virtual volume level was outside of this range at the time that this range is set, then the volume of this stream will be equal to the minimum or maximum level depending on whether it was below or above this volume range.

The preset volume level is a third volume level that must be greater than or equal to the minimum volume level and less than or equal to the maximum volume level. If the preset volume is outside of the minimum/maximum range, this value will be equal to the minimum or maximum level depending on whether it was below or above this volume range. This will be used by the SetCurrentProfileOption feature to adjust the volume of the decode beep virtual stream to this set level.

Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

String that contains the minimum, maximum, and preset volumes in this order and separated by commas. For example, "1,5,3" sets a minimum of 1, a maximum of 5 and a preset of 3.
Positive integers from 0–10.

Note: SUPERSEDED by STREAM_VVS_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Shown if: The Audio UI Profile Action is "Add an Audio UI Profile"

Parm Name: STREAM_VVS_BTHS_LEVEL

Requires:

OSX: 4.4+

MX: 4.4+

Keypad Tone Label

Used to set a custom label that the ZVC displays to identify the tone used to indicate audible keypad feedback. NOTE: If the value of this parameter is empty (a length of 0), no customized label is created for the keypad tone and the default label is displayed.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Parm Name: STREAM_KEYPADTONE_Label

Requires:

MX: 10.2+

Keypad Tone Icon

Used to set a custom icon that the ZVC displays to identify the stream used for keypad feedback. If specified, the value must be the full path and file name of an icon file in .PNG format that resides in the device file system. Zebra recommends an icon size of 48x48 pixels.

NOTE: If the value of this parameter is empty (a length of 0), or if the value provided does not reference an icon file, ZVC displays the default icon defined for the stream.

Parm value input rules:

String from 0–255 characters

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Parm Name: STREAM_KEYPADTONE_Icon

Requires:

MX: 10.2+

Keypad Tone Control Parameters

Controls whether the ZVC allows the device user to view and modify the settings for the keypad tone typically used to indicate a key-press. Entering an empty (length of zero) value (or the absence of this parameter from the XML) causes no change to this setting.

Parm value input rules:

String from 0–255 characters
A value of "1" makes the stream visible; a "0" makes it invisible.

Note: This parameter is deprecated; it will no longer be available beginning with MX 11.0.

Parm Name: STREAM_KEYPADTONE_Ctrl

Requires:

MX: 10.2+

Keypad Tone Speaker Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream used for keypad feedback when the device is in speaker mode. Valid range for this stream is 0–4 (0=off; 4=max), with values separated by commas. The device user cannot reduce or increase the volume outside of the set minimum/maximum range. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

Integers from 0–4
String with the minimum, maximum, and preset volumes in order, separated by commas. For example, "1,4,3" sets a minimum of 1, a maximum of 4 and a preset of 3.

Parm Name: STREAM_KEYPADTONE_SPK_LEVEL

Requires:

MX: 10.2+

Keypad Tone Receiver Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream used for keypad feedback when the device is in receiver mode. Valid range for this stream is 0–4 (0=off; 4=max), with values separated by commas. The device user cannot reduce or increase the volume outside of the set minimum/maximum range. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

Parm value input rules:

Integers from 0–4
String with the minimum, maximum, and preset volumes in order, separated by commas. For example, "1,4,3" sets a minimum of 1, a maximum of 4 and a preset of 3.

Note: DEPRECATED on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Parm Name: STREAM_KEYPADTONE_RCVR_LEVEL

Requires:

MX: 10.2+

Keypad Tone Wired Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream used for keypad feedback when the device is in wired headset mode. Valid range for this stream is 0–4 (0=off; 4=max), with values separated by commas. The device user cannot reduce or increase the volume outside of the set minimum/maximum range. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

Integers from 0–4
String with the minimum, maximum, and preset volumes in order, separated by commas. For example, "1,4,3" sets a minimum of 1, a maximum of 4 and a preset of 3.

Note: SUPERSEDED by STREAM_KEYPAD_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Parm Name: STREAM_KEYPADTONE_WHS_LEVEL

Requires:

MX: 10.2+

Keypad Tone Bluetooth Headset Levels

Used to set the minimum, maximum, and preset volume levels for the audio stream used for keypad feedback when the device is in Bluetooth headset mode. Valid range for this stream is 0–4 (0=off; 4=max), with values separated by commas. The device user cannot reduce or increase the volume outside of the set minimum/maximum range. Entering an empty (length of zero) value (or the absence of this parm from the XML) causes no change to the volume levels.

For devices running Android 11+, see Note below.

Parm value input rules:

Integers from 0–4
String with the minimum, maximum, and preset volumes in order, separated by commas. For example, "1,4,3" sets a minimum of 1, a maximum of 4 and a preset of 3.

Note: SUPERSEDED by STREAM_KEYPAD_SPK_LEVEL on devices running Android 11; settings applied from a Profile designed for an older Android version are ignored.

Parm Name: STREAM_KEYPADTONE_BTHS_LEVEL

Requires:

MX: 10.2+

Examples

Add a New Audio Profile


<wap-provisioningdoc>
    <characteristic type="AudioVolUIMgr" version="4.4" >
        <parm name="UIProfileAction" value="1"/>
    <characteristic type="UIProfile">
        <parm name="ProfileName" value="Test2"/>
            <characteristic type="UIProfile-streamconfig">
                <parm name="STREAM_MUSIC_Label" value="MUSIC"/>
                <parm name="STREAM_MUSIC_Icon" value="/internal/xmltest/in/Speaker.png"/>
                <parm name="STREAM_MUSIC_Ctrl" value="1"/>
                <parm name="STREAM_MUSIC_SPK_LEVEL" value="1,14,8"/>
                <parm name="STREAM_MUSIC_RCVR_LEVEL" value="2,13,8"/>
                <parm name="STREAM_MUSIC_WHS_LEVEL" value="3,12,8"/>
                <parm name="STREAM_MUSIC_BTHS_LEVEL" value="4,11,8"/>
                <parm name="STREAM_RING_Label" value="RING"/>
                <parm name="STREAM_RING_Icon" value="/internal/xmltest/in/Ring.png"/>
                <parm name="STREAM_RING_Ctrl" value="1"/>
                <parm name="STREAM_RING_SPK_LEVEL" value="1,7,5"/>
                <parm name="STREAM_RING_RCVR_LEVEL" value="3,7,5"/>
                <parm name="STREAM_RING_WHS_LEVEL" value="3,7,5"/>
                <parm name="STREAM_RING_BTHS_LEVEL" value="4,7,5"/>
                <parm name="STREAM_NOTIFICATION_Label" value="NOTIFY"/>
                <parm name="STREAM_NOTIFICATION_Icon" value="/internal/xmltest/in/Notify.png"/>
                <parm name="STREAM_NOTIFICATION_Ctrl" value="1"/>
                <parm name="STREAM_NOTIFICATION_SPK_LEVEL" value="1,7,5"/>
                <parm name="STREAM_NOTIFICATION_RCVR_LEVEL" value="3,7,5"/>
                <parm name="STREAM_NOTIFICATION_WHS_LEVEL" value="3,7,5"/>
                <parm name="STREAM_NOTIFICATION_BTHS_LEVEL" value="4,7,5"/>
                <parm name="STREAM_SYSTEM_Label" value="SYSTEM"/>
                <parm name="STREAM_SYSTEM_Icon" value="/internal/xmltest/in/System.png"/>
                <parm name="STREAM_SYSTEM_Ctrl" value="1"/>
                <parm name="STREAM_SYSTEM_SPK_LEVEL" value="1,7,5"/>
                <parm name="STREAM_SYSTEM_RCVR_LEVEL" value="1,7,5"/>
                <parm name="STREAM_SYSTEM_WHS_LEVEL" value="1,7,5"/>
                <parm name="STREAM_SYSTEM_BTHS_LEVEL" value="4,7,5"/>
                <parm name="STREAM_ALARM_Label" value="ALARM"/>
                <parm name="STREAM_ALARM_Icon" value="/internal/xmltest/in/ALARM.png"/>
                <parm name="STREAM_ALARM_Ctrl" value="1"/>
                <parm name="STREAM_ALARM_SPK_LEVEL" value="1,7,4"/>
                <parm name="STREAM_ALARM_RCVR_LEVEL" value="1,7,4"/>
                <parm name="STREAM_ALARM_WHS_LEVEL" value="1,7,4"/>
                <parm name="STREAM_ALARM_BTHS_LEVEL" value="1,7,4"/>
                <parm name="STREAM_VOICECALL_Label" value="PHONE"/>
                <parm name="STREAM_VOICECALL_Icon" value="/internal/xmltest/in/Phone.png"/>
                <parm name="STREAM_VOICECALL_Ctrl" value="1"/>
                <parm name="STREAM_VOICECALL_SPK_LEVEL" value="1,5,3"/>
                <parm name="STREAM_VOICECALL_RCVR_LEVEL" value="1,5,3"/>
                <parm name="STREAM_VOICECALL_WHS_LEVEL" value="1,5,3"/>
                <parm name="STREAM_VOICECALL_BTHS_LEVEL" value="1,5,3"/>
                <parm name="STREAM_VVS_Label" value="SCAN"/>
                <parm name="STREAM_VVS_Icon" value="/internal/xmltest/in/ScanGun.png"/>
                <parm name="STREAM_VVS_Ctrl" value="1"/>
                <parm name="STREAM_VVS_SPK_LEVEL" value="2,10,8"/>
                <parm name="STREAM_VVS_RCVR_LEVEL" value="2,10,8"/>
                <parm name="STREAM_VVS_WHS_LEVEL" value="2,10,8"/>
                <parm name="STREAM_VVS_BTHS_LEVEL" value="2,10,8"/>
            </characteristic>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>