Audio 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.

Overview

The Audio Manager (AudioMgr) controls a small number of specialized audio functions on Zebra devices, including whether audio on a device plays only through a connected headset or is replicated on the built-in device speaker (so that it plays on both). AudioMgr also controls whether a sound is played when the device is connected to a charger.

The replication feature was developed for the VC80x vehicle-mount computer, which has a custom port for attaching the Zebra M1000 headset. AudioMgr can force audio normally sent only to the M1000 speaker to be replicated on the VC80x's built-in speaker. This addresses the issue of missed communications that can arise when the headset is not being worn.

AudioMgr is supported only on Zebra KC50 kiosk and VC80x vehicle mount computers.

Main Functionality

  • Turn On/Off:
    • Replication of headset audio on device speaker (VC80x only)
    • Sound when device connects to a charger
    • Device vibration on incoming calls
  • Control user access to Call Vibration settings
  • Specify device type(s) to exclude as the best path for media output
  • Control the state (on/off) of the device microphone

Charging Sounds On/Off

Controls whether the device plays a sound when a battery charger is connected.

Parm Name: ChargingSounds

Option Name Description Note Status 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: 9.3+

Android API: 26+

1 Turn On Causes device to play a sound when a battery charger is connected.

MX: 9.3+

Android API: 26+

2 Turn Off Causes device to remain silent when a battery charger is connected.

MX: 9.3+

Android API: 26+

Audio Replication Action

Controls whether audio on the device plays only through a connected Zebra M1000 handset or is replicated on the built-in speaker.

Note: Supported on VC80x and WS50 devices only.

Parm Name: AudioReplicationAction

Option Name Description Note Status 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: 7.2+

Android API: 25+

1 Replicate handset audio on built-in speaker Plays device audio through handset and device speaker.

MX: 7.2+

Android API: 25+

2 Do not replicate handset audio on built-in speaker Plays device audio only through the connected handset.

MX: 7.2+

Android API: 25+

Call Vibration User Control

Used to select whether the device user can make changes to vibration settings for incoming calls on the device.

This parameter does NOT control vibration options; it controls the device user's ability to do so.

Parm Name: VibrateForCallsUsage

Option Name Description Note Status 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.3+

1 Enable Allows the device user to make changes to vibration options for incoming calls on the device.

MX: 11.3+

2 Disable Prevents the device user from making changes to vibration options for incoming calls on the device.

MX: 11.3+

Vibration Icon Show/Hide

Used to select whether to display the vibration icon on the Status Bar, which indicates whether the device vibrates when Notifications are received.

Parm Name: VibrateIcon

Option Name Description Note Status 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 Hide Prevents display of the vibration setting icon on the Status Bar.

MX: 13.2+

2 Show Allows display of the vibration setting icon on the Status Bar.

MX: 13.2+

Call Vibration

Used to select the vibration option for incoming calls on the device.

Parm Name: CallVibration

Option Name Description Note Status 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.3+

1 Never Vibrate Disables vibration for incoming calls.

MX: 11.3+

2 Always Vibrate Enables vibration for incoming calls.

MX: 11.3+

3 Vibrate first then ring gradually Sets the device to vibrate briefly for each call, then sound the ringer with gradually increased volume.

MX: 11.3+

Microphone On/Off

This is the On/Off switch for the device microphone, which controls audio input through the built-in mic on the device.

Note: Supported only on Zebra KC50 devices running Android 13 or later.

Parm Name: Microphone

Option Name Description Note Status 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.5+

Android API: 34+

1 Turn on Activates the device microphone, allowing audio input through the mic.

MX: 13.5+

Android API: 34+

2 Turn off Deactivates the device microphone, preventing audio input through the mic.

MX: 13.5+

Android API: 34+

Media Output Exclusion

Used to select an Action to be performed for managing the list of devices to be excluded from consideration as the best path for media output. Individual media output device types are selected using the Best Path Exclude Device parameter.

Parm Name: BestPathExcludeAction

Option Name Description Note Status 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.3+

1 Add Audio Peripheral Exclusion Adds selected device type to the exclusion list.

MX: 11.3+

2 Remove Audio Peripheral Exclusion Removes selected device from the exclusion list.

MX: 11.3+

3 Remove All Audio Peripheral Exclusions Removes all devices from the exclusion list, resetting it to empty.

MX: 11.3+

Media Output Devices

Used to select a device to add to or remove from the list of devices excluded from consideration as the best path for media output. If a single device type is to be used for all media output, excluding the remaining device types helps ensure that media output is always routed to the desired device.

Shown if: The Best Path Exclude Action is "Add Device" or "Remove Device"

Parm Name: BestPathExcludeDevice

Option Name Description Note Status Requires
2 WIRED_HEADSET_DEVICE Excludes wired (3.5mm) headsets from consideration as the best path for media output.

MX: 11.3+

3 USB_DEVICE Excludes any peripheral connected via USB from consideration as the best path for media output.

MX: 11.3+

4 BT_A2DP_DEVICE Excludes any Bluetooth peripheral that uses the Advanced Audio Distribution Profile (A2DP) standard from consideration as the best path for media output.

MX: 11.3+

5 HDMI_DEVICE Excludes any device connected via HDMI cable from consideration as the best path for media output.

MX: 11.3+

Examples

Replicate audio

Send audio to handset and built-in speaker


<wap-provisioningdoc>
    ​<characteristic type="AudioMgr">
        ​​<parm name="AudioReplicationAction" value="1" />
    ​</characteristic>
</wap-provisioningdoc>