Added in API level 1
Deprecated in API level 29

RingtonePreference

open class RingtonePreference : Preference, PreferenceManager.OnActivityResultListener
kotlin.Any
   ↳ android.preference.Preference
   ↳ android.preference.RingtonePreference

A Preference that allows the user to choose a ringtone from those on the device. The chosen ringtone's URI will be persisted as a string.

If the user chooses the "Default" item, the saved string will be one of System#DEFAULT_RINGTONE_URI, System#DEFAULT_NOTIFICATION_URI, or System#DEFAULT_ALARM_ALERT_URI. If the user chooses the "Silent" item, the saved string will be an empty string.

Summary

XML attributes
android:ringtoneType Which ringtone type(s) to show in the picker.
android:showDefault Whether to show an item for a default sound.
android:showSilent Whether to show an item for 'Silent'.
Inherited XML attributes
Inherited constants
Public constructors
RingtonePreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)

RingtonePreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

Public methods
open Int

Returns the sound type(s) that are shown in the picker.

open Boolean

Returns whether to a show an item for the default sound/ringtone.

open Boolean

Returns whether to a show an item for 'Silent'.

open Boolean
onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)

open Unit

Sets the sound type(s) that are shown in the picker.

open Unit
setShowDefault(showDefault: Boolean)

Sets whether to show an item for the default sound/ringtone.

open Unit
setShowSilent(showSilent: Boolean)

Sets whether to show an item for 'Silent'.

Protected methods
open Unit

open Unit

open Any!

open Unit
onPrepareRingtonePickerIntent(ringtonePickerIntent: Intent!)

Prepares the intent to launch the ringtone picker.

open Uri!

Called when the chooser is about to be shown and the current ringtone should be marked.

open Unit
onSaveRingtone(ringtoneUri: Uri!)

Called when a ringtone is chosen.

open Unit
onSetInitialValue(restorePersistedValue: Boolean, defaultValueObj: Any!)

Inherited functions

XML attributes

android:ringtoneType

android:ringtoneType
Which ringtone type(s) to show in the picker.

Must be one or more (separated by '|') of the following constant values.

Constant Value Description
alarm 4 Alarm sounds.
all 7 All available ringtone sounds.
notification 2 Notification sounds.
ringtone 1 Ringtones.

android:showDefault

android:showDefault
Whether to show an item for a default sound.

May be a boolean value, such as "true" or "false".

android:showSilent

android:showSilent
Whether to show an item for 'Silent'.

May be a boolean value, such as "true" or "false".

Public constructors

RingtonePreference

Added in API level 1
RingtonePreference(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int,
    defStyleRes: Int)

RingtonePreference

Added in API level 1
RingtonePreference(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int)

RingtonePreference

Added in API level 1
RingtonePreference(
    context: Context!,
    attrs: AttributeSet!)

RingtonePreference

Added in API level 1
RingtonePreference(context: Context!)

Public methods

getRingtoneType

Added in API level 1
open fun getRingtoneType(): Int

Deprecated: Deprecated in Java.

Returns the sound type(s) that are shown in the picker.

Return
Int The sound type(s) that are shown in the picker.

getShowDefault

Added in API level 1
open fun getShowDefault(): Boolean

Deprecated: Deprecated in Java.

Returns whether to a show an item for the default sound/ringtone.

Return
Boolean Whether to show an item for the default sound/ringtone.

getShowSilent

Added in API level 1
open fun getShowSilent(): Boolean

Deprecated: Deprecated in Java.

Returns whether to a show an item for 'Silent'.

Return
Boolean Whether to show an item for 'Silent'.

onActivityResult

Added in API level 1
open fun onActivityResult(
    requestCode: Int,
    resultCode: Int,
    data: Intent!
): Boolean

Deprecated: Deprecated in Java.

Return
Boolean Whether the request code was handled (in which case subsequent listeners will not be called.

setRingtoneType

Added in API level 1
open fun setRingtoneType(type: Int): Unit

Deprecated: Deprecated in Java.

Sets the sound type(s) that are shown in the picker.

Parameters
type Int: The sound type(s) that are shown in the picker.

setShowDefault

Added in API level 1
open fun setShowDefault(showDefault: Boolean): Unit

Deprecated: Deprecated in Java.

Sets whether to show an item for the default sound/ringtone. The default to use will be deduced from the sound type(s) being shown.

Parameters
showDefault Boolean: Whether to show the default or not.

setShowSilent

Added in API level 1
open fun setShowSilent(showSilent: Boolean): Unit

Deprecated: Deprecated in Java.

Sets whether to show an item for 'Silent'.

Parameters
showSilent Boolean: Whether to show 'Silent'.

Protected methods

onAttachedToHierarchy

Added in API level 1
protected open fun onAttachedToHierarchy(preferenceManager: PreferenceManager!): Unit

Deprecated: Deprecated in Java.

Parameters
preferenceManager PreferenceManager!: The PreferenceManager of the hierarchy.

onClick

Added in API level 1
protected open fun onClick(): Unit

Deprecated: Deprecated in Java.

onGetDefaultValue

Added in API level 1
protected open fun onGetDefaultValue(
    a: TypedArray!,
    index: Int
): Any!

Deprecated: Deprecated in Java.

Parameters
a TypedArray!: The set of attributes.
index Int: The index of the default value attribute.
Return
Any! The default value of this preference type.

onPrepareRingtonePickerIntent

Added in API level 1
protected open fun onPrepareRingtonePickerIntent(ringtonePickerIntent: Intent!): Unit

Deprecated: Deprecated in Java.

Prepares the intent to launch the ringtone picker. This can be modified to adjust the parameters of the ringtone picker.

Parameters
ringtonePickerIntent Intent!: The ringtone picker intent that can be modified by putting extras.

onRestoreRingtone

Added in API level 1
protected open fun onRestoreRingtone(): Uri!

Deprecated: Deprecated in Java.

Called when the chooser is about to be shown and the current ringtone should be marked. Can return null to not mark any ringtone.

By default, this restores the previous ringtone URI from the persistent storage.

Return
Uri! The ringtone to be marked as the current ringtone.

onSaveRingtone

Added in API level 1
protected open fun onSaveRingtone(ringtoneUri: Uri!): Unit

Deprecated: Deprecated in Java.

Called when a ringtone is chosen.

By default, this saves the ringtone URI to the persistent storage as a string.

Parameters
ringtoneUri Uri!: The chosen ringtone's Uri. Can be null.

onSetInitialValue

Added in API level 1
protected open fun onSetInitialValue(
    restorePersistedValue: Boolean,
    defaultValueObj: Any!
): Unit

Deprecated: Deprecated in Java.

Parameters
restorePersistedValue Boolean: True to restore the persisted value; false to use the given defaultValue.
defaultValue The default value for this Preference. Only use this if restorePersistedValue is false.