SoundQuality
class SoundQuality
kotlin.Any | |
↳ | android.media.quality.MediaQualityContract.SoundQuality |
Parameters for sound quality.
Summary
Constants | |
---|---|
static String |
Enable/disable auto volume control sound effect. |
static String |
The audio volume balance. |
static String |
The bass. |
static String |
Dialogue enhancer. |
static String |
Digital output delay in milliseconds. |
static String |
Sets the digital audio output mode. |
static String |
Enables or disables Dolby Atmos processing. |
static String |
Sets the sound mode for Dolby audio processing. |
static String |
Enable/disable the Surround Virtualizer. |
static String |
Enable/disable Volume Leveler. |
static String |
Sets the downmix mode for multi-channel audio. |
static String |
Enable/disable dynamic range compression (DRC) of digital theater system (DTS). |
static String |
Enable/disable virtual X definition. |
static String |
Enable/disable dialog clarity. |
static String |
Enable/disable the processing of virtual height channels. |
static String |
Enable/disable audio limiter. |
static String |
Enable/disable Total Bass Harmonic Distortion (X). |
static String |
Enable/disable the core DTS Virtual:X surround sound processing. |
static String |
Enable/disable DTS TruVolume HD. |
static String |
Enable/disable enhanced audio return channel (eARC). |
static String |
Enable/disable speaker output. |
static String |
Speaker delay in milliseconds. |
static String |
Enable/disable surround sound. |
static String |
The treble. |
Constants
PARAMETER_AUTO_VOLUME_CONTROL
static val PARAMETER_AUTO_VOLUME_CONTROL: String
Enable/disable auto volume control sound effect.
Type: BOOLEAN
Value: "auto_volume_control"
PARAMETER_BALANCE
static val PARAMETER_BALANCE: String
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
Value: "balance"
PARAMETER_BASS
static val PARAMETER_BASS: String
The bass.
Bass controls the intensity of low-frequency sounds. The valid range is 0 - 100 (inclusive).
Type: INTEGER
Value: "bass"
PARAMETER_DIALOGUE_ENHANCER
static val PARAMETER_DIALOGUE_ENHANCER: String
Dialogue enhancer.
Possible values:
The default value isLEVEL_OFF
.
Type: STRING
Value: "dialogue_enhancer"
PARAMETER_DIGITAL_OUTPUT_DELAY_MILLIS
static val PARAMETER_DIGITAL_OUTPUT_DELAY_MILLIS: String
Digital output delay in milliseconds.
Type: INTEGER
Value: "digital_output_delay_millis"
PARAMETER_DIGITAL_OUTPUT_MODE
static val PARAMETER_DIGITAL_OUTPUT_MODE: String
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
Value: "digital_output_mode"
PARAMETER_DOLBY_AUDIO_PROCESSING_DOLBY_ATMOS
static val PARAMETER_DOLBY_AUDIO_PROCESSING_DOLBY_ATMOS: String
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
Value: "dolby_audio_processing_dolby_atmos"
PARAMETER_DOLBY_AUDIO_PROCESSING_SOUND_MODE
static val PARAMETER_DOLBY_AUDIO_PROCESSING_SOUND_MODE: String
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
Value: "dolby_audio_processing_sound_mode"
PARAMETER_DOLBY_AUDIO_PROCESSING_SURROUND_VIRTUALIZER
static val PARAMETER_DOLBY_AUDIO_PROCESSING_SURROUND_VIRTUALIZER: String
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
Value: "dolby_audio_processing_surround_virtualizer"
PARAMETER_DOLBY_AUDIO_PROCESSING_VOLUME_LEVELER
static val PARAMETER_DOLBY_AUDIO_PROCESSING_VOLUME_LEVELER: String
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
Value: "dolby_audio_processing_volume_leveler"
PARAMETER_DOWN_MIX_MODE
static val PARAMETER_DOWN_MIX_MODE: String
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
Value: "down_mix_mode"
PARAMETER_DTS_DRC
static val PARAMETER_DTS_DRC: String
Enable/disable dynamic range compression (DRC) of digital theater system (DTS).
Type: BOOLEAN
Value: "dts_drc"
PARAMETER_DTS_VIRTUAL_X_DEFINITION
static val PARAMETER_DTS_VIRTUAL_X_DEFINITION: String
Enable/disable virtual X definition.
It applies audio processing to improve overall sound definition and clarity.
Type: BOOLEAN
Value: "dts_virtual_x_definition"
PARAMETER_DTS_VIRTUAL_X_DIALOG_CLARITY
static val PARAMETER_DTS_VIRTUAL_X_DIALOG_CLARITY: String
Enable/disable dialog clarity.
It enhances the clarity and intelligibility of speech in audio content.
Type: BOOLEAN
Value: "dts_virtual_x_dialog_clarity"
PARAMETER_DTS_VIRTUAL_X_HEIGHT
static val PARAMETER_DTS_VIRTUAL_X_HEIGHT: String
Enable/disable the processing of virtual height channels.
It creates a more immersive audio experience by simulating sounds from above.
Type: BOOLEAN
Value: "dts_virtual_x_height"
PARAMETER_DTS_VIRTUAL_X_LIMITER
static val PARAMETER_DTS_VIRTUAL_X_LIMITER: String
Enable/disable audio limiter.
It prevents excessive volume peaks that could cause distortion or speaker damage.
Type: BOOLEAN
Value: "dts_virtual_x_limiter"
PARAMETER_DTS_VIRTUAL_X_TBHDX
static val PARAMETER_DTS_VIRTUAL_X_TBHDX: String
Enable/disable Total Bass Harmonic Distortion (X).
TBHDX bass enhancement provides a richer low-frequency experience, simulating deeper bass.
Type: BOOLEAN
Value: "dts_virtual_x_tbhdx"
PARAMETER_DTS_VIRTUAL_X_TRU_SURROUND_X
static val PARAMETER_DTS_VIRTUAL_X_TRU_SURROUND_X: String
Enable/disable the core DTS Virtual:X surround sound processing.
It creates an immersive, multi-channel audio experience from the speaker configuration.
Type: BOOLEAN
Value: "dts_virtual_x_tru_surround_x"
PARAMETER_DTS_VIRTUAL_X_TRU_VOLUME_HD
static val PARAMETER_DTS_VIRTUAL_X_TRU_VOLUME_HD: String
Enable/disable DTS TruVolume HD.
It reduces the dynamic range of audio, minimizing loudness variations between content and channels.
Type: BOOLEAN
Value: "dts_virtual_x_tru_volume_hd"
PARAMETER_EARC
static val PARAMETER_EARC: String
Enable/disable enhanced audio return channel (eARC).
eARC allows for higher bandwidth audio transmission over HDMI.
Type: BOOLEAN
Value: "earc"
PARAMETER_SPEAKERS
static val PARAMETER_SPEAKERS: String
Enable/disable speaker output.
Type: BOOLEAN
Value: "speakers"
PARAMETER_SPEAKERS_DELAY_MILLIS
static val PARAMETER_SPEAKERS_DELAY_MILLIS: String
Speaker delay in milliseconds.
Type: INTEGER
Value: "speakers_delay_millis"
PARAMETER_SURROUND_SOUND
static val PARAMETER_SURROUND_SOUND: String
Enable/disable surround sound. Stereo Pulse-Code Modulation to apply a customizable filter. There is no difference on any use cases.
Type: BOOLEAN
Value: "surround_sound"
PARAMETER_TREBLE
static val PARAMETER_TREBLE: String
The treble.
Treble controls the intensity of high-frequency sounds. The valid range is 0 - 100 (inclusive).
Type: INTEGER
Value: "treble"