MediaQualityContract.SoundQuality
public
static
final
class
MediaQualityContract.SoundQuality
extends Object
| java.lang.Object | |
| ↳ | android.media.quality.MediaQualityContract.SoundQuality |
Parameters for sound quality.
Summary
Constants | |
|---|---|
String |
PARAMETER_AD_HEADPHONE_ENABLE
Controls the output routing of the Audio Description track to connected headphones. |
String |
PARAMETER_AD_SPEAKER_ENABLE
Controls the output routing of the Audio Description track to the internal speakers. |
String |
PARAMETER_AD_VOLUME
Sets the relative volume gain for the Audio Description track. |
String |
PARAMETER_AUTO_VOLUME_CONTROL
Enable/disable auto volume control sound effect. |
String |
PARAMETER_BALANCE
The audio volume balance. |
String |
PARAMETER_BALANCE_BLUETOOTH
Adjusts the left/right audio balance for a connected Bluetooth device. |
String |
PARAMETER_BALANCE_HEADPHONES
Adjusts the left/right audio balance for a connected headphone. |
String |
PARAMETER_BALANCE_SPEAKER
Adjusts the left/right audio balance for the built-in speakers. |
String |
PARAMETER_BASS
The bass. |
String |
PARAMETER_BT_LATENCY_US
Reports the audio latency of the connected Bluetooth (BT) media device in microseconds. |
String |
PARAMETER_DIALOGUE_ENHANCER
Dialogue enhancer. |
String |
PARAMETER_DIGITAL_OUTPUT_DELAY_MILLIS
Digital output delay in milliseconds. |
String |
PARAMETER_DIGITAL_OUTPUT_MODE
Sets the digital audio output mode. |
String |
PARAMETER_DOLBY_AUDIO_PROCESSING
Key used to enable or disable Dolby Audio Processing (DAP). |
String |
PARAMETER_DOLBY_AUDIO_PROCESSING_DOLBY_ATMOS
Enables or disables Dolby Atmos processing. |
String |
PARAMETER_DOLBY_AUDIO_PROCESSING_SOUND_MODE
Sets the sound mode for Dolby audio processing. |
String |
PARAMETER_DOLBY_AUDIO_PROCESSING_SURROUND_VIRTUALIZER
Enable/disable the Surround Virtualizer. |
String |
PARAMETER_DOLBY_AUDIO_PROCESSING_VOLUME_LEVELER
Enable/disable Volume Leveler. |
String |
PARAMETER_DOWN_MIX_MODE
Sets the downmix mode for multi-channel audio. |
String |
PARAMETER_DTS_DRC
Enable/disable dynamic range compression (DRC) of digital theater system (DTS). |
String |
PARAMETER_DTS_VIRTUAL_X
Enable/disable DTS Virtual:X. |
String |
PARAMETER_DTS_VIRTUAL_X_DEFINITION
Enable/disable virtual X definition. |
String |
PARAMETER_DTS_VIRTUAL_X_DIALOG_CLARITY
Enable/disable dialog clarity. |
String |
PARAMETER_DTS_VIRTUAL_X_HEIGHT
Enable/disable the processing of virtual height channels. |
String |
PARAMETER_DTS_VIRTUAL_X_LIMITER
Enable/disable audio limiter. |
String |
PARAMETER_DTS_VIRTUAL_X_TBHDX
Enable/disable Total Bass Harmonic Distortion (X). |
String |
PARAMETER_DTS_VIRTUAL_X_TRU_SURROUND_X
Enable/disable the core DTS Virtual:X surround sound processing. |
String |
PARAMETER_DTS_VIRTUAL_X_TRU_VOLUME_HD
Enable/disable DTS TruVolume HD. |
String |
PARAMETER_EARC
Enable/disable enhanced audio return channel (eARC). |
String |
PARAMETER_EQUALIZER_SETTINGS
Equalizer can fine-tune the audio output by adjusting the loudness of different frequency bands; Normally each band have a value of -50 to 50. |
String |
PARAMETER_HI_RES_AUDIO
Toggles the High-Resolution Audio path, which offers better-than-CD quality playback with higher sampling rates and/or bit depth. |
String |
PARAMETER_PAN_FADE_ENABLE
Enables automatic Pan and Fade (Ducking) behavior for the main audio. |
String |
PARAMETER_SOUND_STYLE
The sound style of this profile. |
String |
PARAMETER_SPEAKERS
Enable/disable speaker output. |
String |
PARAMETER_SPEAKERS_DELAY_MILLIS
Speaker delay in milliseconds. |
String |
PARAMETER_SURROUND_SOUND
Enable/disable surround sound. |
String |
PARAMETER_TREBLE
The treble. |
Inherited methods | |
|---|---|
Constants
PARAMETER_AD_HEADPHONE_ENABLE
public static final String PARAMETER_AD_HEADPHONE_ENABLE
Controls the output routing of the Audio Description track to connected headphones.
If set to true, the AD track will be mixed and played through
wired or Bluetooth headsets.
Note: This enables independent consumption of AD content if the audio engine supports dual-routing (e.g., AD on headphones, Main Audio on speakers).
Constant Value: "ad_headphone_enable"
PARAMETER_AD_SPEAKER_ENABLE
public static final String PARAMETER_AD_SPEAKER_ENABLE
Controls the output routing of the Audio Description track to the internal speakers.
If set to true, the AD track will be mixed with the main audio
and played through the device's built-in speakers.
Dependency: This setting is ignored if the device does not have internal speakers or if audio routing is forcibly overridden by system policy.
Constant Value: "ad_speaker_enable"
PARAMETER_AD_VOLUME
public static final String PARAMETER_AD_VOLUME
Sets the relative volume gain for the Audio Description track.
Unit: Integer Percentage (0-100)
Default: Typically defaults to 50 or the system-wide accessibility volume preference.
This value controls the mixing level of the secondary audio stream (AD) before it is combined with the main program audio.
0: AD track is muted.100: AD track is at maximum mixing volume.
Constant Value: "ad_volume"
PARAMETER_AUTO_VOLUME_CONTROL
public static final String PARAMETER_AUTO_VOLUME_CONTROL
Enable/disable auto volume control sound effect.
Type: BOOLEAN
Constant Value: "auto_volume_control"
PARAMETER_BALANCE
public static final String PARAMETER_BALANCE
The audio volume balance.
This parameter controls the balance between the left and right speakers. The valid range is -50 to 50 (inclusive), where: - Negative values shift the balance towards the left speaker. - Positive values shift the balance towards the right speaker. - 0 represents a balanced output.
Type: INTEGER
Constant Value: "balance"
PARAMETER_BALANCE_BLUETOOTH
public static final String PARAMETER_BALANCE_BLUETOOTH
Adjusts the left/right audio balance for a connected Bluetooth device. The range is -50 (left) to 50 (right), with 0 being centered.
Type: INTEGER
Constant Value: "balance_bluetooth"
PARAMETER_BALANCE_HEADPHONES
public static final String PARAMETER_BALANCE_HEADPHONES
Adjusts the left/right audio balance for a connected headphone. The range is -50 (left) to 50 (right), with 0 being centered.
Type: INTEGER
Constant Value: "balance_headphones"
PARAMETER_BALANCE_SPEAKER
public static final String PARAMETER_BALANCE_SPEAKER
Adjusts the left/right audio balance for the built-in speakers. The range is -50 (left) to 50 (right), with 0 being centered.
Type: INTEGER
Constant Value: "balance_speaker"
PARAMETER_BASS
public static final String PARAMETER_BASS
The bass.
Bass controls the intensity of low-frequency sounds. The valid range is 0 - 100 (inclusive).
Type: INTEGER
Constant Value: "bass"
PARAMETER_BT_LATENCY_US
public static final String PARAMETER_BT_LATENCY_US
Reports the audio latency of the connected Bluetooth (BT) media device in microseconds. This value can be used by A/V sync logic to maintain lip-sync.
Type: INTEGER
Constant Value: "bt_latency_us"
PARAMETER_DIALOGUE_ENHANCER
public static final String PARAMETER_DIALOGUE_ENHANCER
Dialogue enhancer.
Possible values:
MediaQualityContract.LEVEL_LOWMediaQualityContract.LEVEL_MEDIUMMediaQualityContract.LEVEL_HIGHMediaQualityContract.LEVEL_OFF
MediaQualityContract.LEVEL_OFF.
Type: STRING
Constant Value: "dialogue_enhancer"
PARAMETER_DIGITAL_OUTPUT_DELAY_MILLIS
public static final String PARAMETER_DIGITAL_OUTPUT_DELAY_MILLIS
Digital output delay in milliseconds.
Type: INTEGER
Constant Value: "digital_output_delay_millis"
PARAMETER_DIGITAL_OUTPUT_MODE
public static final String PARAMETER_DIGITAL_OUTPUT_MODE
Sets the digital audio output mode.
This parameter controls the audio format sent to a digital output like HDMI or S/PDIF. This allows the user to select a specific audio format or let the system decide automatically. The supported values are:
"Auto": The system automatically selects the preferred format supported by the connected device. (Default)"Bypass": The encoded audio stream is sent directly to the output without being decoded by this device."PCM": Audio is decoded to uncompressed Pulse-Code Modulation."Dolby Digital Plus""Dolby Digital""Dolby MAT"
Type: STRING
Constant Value: "digital_output_mode"
PARAMETER_DOLBY_AUDIO_PROCESSING
public static final String PARAMETER_DOLBY_AUDIO_PROCESSING
Key used to enable or disable Dolby Audio Processing (DAP).
Value Type: String
Valid Values:
"on"- Enables Dolby post-processing (volume leveling, dialogue enhancement, surround virtualization)."off"- Disables processing (audio is passed through without modification).
Default Value: "off"
When set to "on", the audio engine applies the currently configured
Dolby profile to the output mix. When set to "off", the system operates
in a "passthrough" or reference mode, preserving the original dynamic range
and frequency response of the content.
Constant Value: "dolby_audio_processing"
PARAMETER_DOLBY_AUDIO_PROCESSING_DOLBY_ATMOS
public static final String PARAMETER_DOLBY_AUDIO_PROCESSING_DOLBY_ATMOS
Enables or disables Dolby Atmos processing.
Dolby Atmos creates a more immersive and realistic sound experience by adding a height dimension to surround sound. It allows sound to be placed and moved precisely around you, including overhead.
When set to true, Dolby Atmos processing is enabled. When set to
false, it is disabled, and the audio will be processed using other
standard settings. Disabling this parameter does not change the list of
available audio formats presented to the audio framework.
Note: This setting is only effective on devices that support Dolby Atmos; on unsupported systems, this option may be ignored or hidden. To experience Dolby Atmos, you need content specifically mixed for it. The immersive effect can be delivered through a dedicated Dolby Atmos sound system or through virtualization technologies for headphones and built-in speakers.
Type: BOOLEAN
Constant Value: "dolby_audio_processing_dolby_atmos"
PARAMETER_DOLBY_AUDIO_PROCESSING_SOUND_MODE
public static final String PARAMETER_DOLBY_AUDIO_PROCESSING_SOUND_MODE
Sets the sound mode for Dolby audio processing.
This parameter allows the selection of a preset audio profile to optimize the listening experience for different types of content. The supported values are:
"Game""Movie""Music""News""Stadium""Standard""User"
The default value is "Standard".
Type: STRING
Constant Value: "dolby_audio_processing_sound_mode"
PARAMETER_DOLBY_AUDIO_PROCESSING_SURROUND_VIRTUALIZER
public static final String PARAMETER_DOLBY_AUDIO_PROCESSING_SURROUND_VIRTUALIZER
Enable/disable the Surround Virtualizer.
The Surround Virtualizer creates a virtual surround sound experience when playing back Atmos, surround, and stereo content over two-channel endpoints like TV built-in speakers and headphones. It expands the soundstage and adds depth to the audio, creating an immersive effect without a multi-speaker setup. Note: When Dolby Atoms playback streams are active, this will always be true.
Type: BOOLEAN
Constant Value: "dolby_audio_processing_surround_virtualizer"
PARAMETER_DOLBY_AUDIO_PROCESSING_VOLUME_LEVELER
public static final String PARAMETER_DOLBY_AUDIO_PROCESSING_VOLUME_LEVELER
Enable/disable Volume Leveler.
Volume Leveler helps to maintain a consistent volume level across different types of content and even within the same program. It minimizes the jarring jumps between loud commercials or action sequences and quiet dialogue.
Type: BOOLEAN
Constant Value: "dolby_audio_processing_volume_leveler"
PARAMETER_DOWN_MIX_MODE
public static final String PARAMETER_DOWN_MIX_MODE
Sets the downmix mode for multi-channel audio.
This parameter determines how multi-channel audio (e.g., 5.1) is converted to a two-channel stereo output. This is useful when the playback device, like headphones or TV speakers, has fewer channels than the source audio.
The supported string values are:
"Stereo": A standard downmix (Lo/Ro) suitable for most stereo playback devices. (Default)"Surround": A downmix that is matrix-encoded with surround sound information (Lt/Rt).
Type: STRING
Constant Value: "down_mix_mode"
PARAMETER_DTS_DRC
public static final String PARAMETER_DTS_DRC
Enable/disable dynamic range compression (DRC) of digital theater system (DTS).
Type: BOOLEAN
Constant Value: "dts_drc"
PARAMETER_DTS_VIRTUAL_X
public static final String PARAMETER_DTS_VIRTUAL_X
Enable/disable DTS Virtual:X.
DTS Virtual:X is an audio post-processing technology that provides an immersive listening experience by virtualizing a height and surround soundstage from any input source. When enabled, it aims to create a wider and taller sound field, enhancing spatial perception without the need for additional speakers.
Type: BOOLEAN
Possible values: true to enable, false to disable.
The default value is false.
Note: When this set to false, other dts relate parameter should also be false.
Constant Value: "dts_virtual_x"
PARAMETER_DTS_VIRTUAL_X_DEFINITION
public static final String PARAMETER_DTS_VIRTUAL_X_DEFINITION
Enable/disable virtual X definition.
It applies audio processing to improve overall sound definition and clarity.
Type: BOOLEAN
Constant Value: "dts_virtual_x_definition"
PARAMETER_DTS_VIRTUAL_X_DIALOG_CLARITY
public static final String PARAMETER_DTS_VIRTUAL_X_DIALOG_CLARITY
Enable/disable dialog clarity.
It enhances the clarity and intelligibility of speech in audio content.
Type: BOOLEAN
Constant Value: "dts_virtual_x_dialog_clarity"
PARAMETER_DTS_VIRTUAL_X_HEIGHT
public static final String PARAMETER_DTS_VIRTUAL_X_HEIGHT
Enable/disable the processing of virtual height channels.
It creates a more immersive audio experience by simulating sounds from above.
Type: BOOLEAN
Constant Value: "dts_virtual_x_height"
PARAMETER_DTS_VIRTUAL_X_LIMITER
public static final String PARAMETER_DTS_VIRTUAL_X_LIMITER
Enable/disable audio limiter.
It prevents excessive volume peaks that could cause distortion or speaker damage.
Type: BOOLEAN
Constant Value: "dts_virtual_x_limiter"
PARAMETER_DTS_VIRTUAL_X_TBHDX
public static final String PARAMETER_DTS_VIRTUAL_X_TBHDX
Enable/disable Total Bass Harmonic Distortion (X).
TBHDX bass enhancement provides a richer low-frequency experience, simulating deeper bass.
Type: BOOLEAN
Constant Value: "dts_virtual_x_tbhdx"
PARAMETER_DTS_VIRTUAL_X_TRU_SURROUND_X
public static final String PARAMETER_DTS_VIRTUAL_X_TRU_SURROUND_X
Enable/disable the core DTS Virtual:X surround sound processing.
It creates an immersive, multi-channel audio experience from the speaker configuration.
Type: BOOLEAN
Constant Value: "dts_virtual_x_tru_surround_x"
PARAMETER_DTS_VIRTUAL_X_TRU_VOLUME_HD
public static final String PARAMETER_DTS_VIRTUAL_X_TRU_VOLUME_HD
Enable/disable DTS TruVolume HD.
It reduces the dynamic range of audio, minimizing loudness variations between content and channels.
Type: BOOLEAN
Constant Value: "dts_virtual_x_tru_volume_hd"
PARAMETER_EARC
public static final String PARAMETER_EARC
Enable/disable enhanced audio return channel (eARC).
eARC allows for higher bandwidth audio transmission over HDMI.
Type: BOOLEAN
Constant Value: "earc"
PARAMETER_EQUALIZER_SETTINGS
public static final String PARAMETER_EQUALIZER_SETTINGS
Equalizer can fine-tune the audio output by adjusting the loudness of different frequency bands; Normally each band have a value of -50 to 50.
Type: String
Constant Value: "equalizer_settings"
PARAMETER_HI_RES_AUDIO
public static final String PARAMETER_HI_RES_AUDIO
Toggles the High-Resolution Audio path, which offers better-than-CD quality playback with higher sampling rates and/or bit depth.
Type: BOOLEAN
Constant Value: "hi_res_audio"
PARAMETER_PAN_FADE_ENABLE
public static final String PARAMETER_PAN_FADE_ENABLE
Enables automatic Pan and Fade (Ducking) behavior for the main audio.
When set to true, the audio engine will apply standard broadcast mixing rules:
- Fade: The main program audio volume is lowered ("ducked") when audio description is present to ensure the narrator is intelligible.
- Pan: The main audio may be spatially shifted (e.g., to background channels) to center the audio description track.
If set to false, the AD track is mixed simply as an overlay without
modifying the volume or position of the main audio track.
Constant Value: "pan_fade_enable"
PARAMETER_SOUND_STYLE
public static final String PARAMETER_SOUND_STYLE
The sound style of this profile.
Must be one of the following values, defined in ERROR(/SoundQuality.SoundStyleValue):
MediaQualityContract.SOUND_STYLE_USERMediaQualityContract.SOUND_STYLE_STANDARDMediaQualityContract.SOUND_STYLE_VIVIDMediaQualityContract.SOUND_STYLE_SPORTSMediaQualityContract.SOUND_STYLE_MOVIEMediaQualityContract.SOUND_STYLE_MUSICMediaQualityContract.SOUND_STYLE_NEWSMediaQualityContract.SOUND_STYLE_AUTO
MediaQualityContract.SOUND_STYLE_STANDARD.
Type: STRING
Constant Value: "sound_style"
PARAMETER_SPEAKERS
public static final String PARAMETER_SPEAKERS
Enable/disable speaker output.
Type: BOOLEAN
Constant Value: "speakers"
PARAMETER_SPEAKERS_DELAY_MILLIS
public static final String PARAMETER_SPEAKERS_DELAY_MILLIS
Speaker delay in milliseconds.
Type: INTEGER
Constant Value: "speakers_delay_millis"
PARAMETER_SURROUND_SOUND
public static final String PARAMETER_SURROUND_SOUND
Enable/disable surround sound. Stereo Pulse-Code Modulation to apply a customizable filter. There is no difference on any use cases.
Type: BOOLEAN
Constant Value: "surround_sound"
PARAMETER_TREBLE
public static final String PARAMETER_TREBLE
The treble.
Treble controls the intensity of high-frequency sounds. The valid range is 0 - 100 (inclusive).
Type: INTEGER
Constant Value: "treble"