Ringtone
open class Ringtone
| kotlin.Any | |
| ↳ | android.media.Ringtone |
Ringtone provides a quick method for playing a ringtone, notification, or other similar types of sounds.
For ways of retrieving Ringtone objects or to show a ringtone picker, see RingtoneManager.
Summary
| Public methods | |
|---|---|
| open AudioAttributes! | Returns the |
| open Int | Gets the stream type where this ringtone will be played. |
| open String! | Returns a human-presentable title for ringtone. |
| open Float | Returns the volume scalar set on this player. |
| open Boolean | Return whether the |
| open Boolean | Returns whether the looping mode was enabled on this player. |
| open Boolean | Whether this ringtone is currently playing. |
| open Unit | play()Plays the ringtone. |
| open Unit | setAudioAttributes(attributes: AudioAttributes!)Sets the |
| open Boolean | setHapticGeneratorEnabled(enabled: Boolean)Enable or disable the |
| open Unit | setLooping(looping: Boolean)Sets the player to be looping or non-looping. |
| open Unit | setStreamType(streamType: Int)Sets the stream type where this ringtone will be played. |
| open Unit | Sets the volume on this player. |
| open Unit | stop()Stops a playing ringtone. |
| Protected methods | |
|---|---|
| open Unit | finalize() |
Public methods
getAudioAttributes
open fun getAudioAttributes(): AudioAttributes!
Returns the AudioAttributes used by this object.
| Return | |
|---|---|
AudioAttributes! | the AudioAttributes that were set with setAudioAttributes(android.media.AudioAttributes) or the default attributes if none were set. |
getStreamType
open fungetStreamType(): Int
Deprecated: use of stream types is deprecated, see setAudioAttributes(android.media.AudioAttributes)
Gets the stream type where this ringtone will be played.
| Return | |
|---|---|
Int | The stream type, see AudioManager. |
getTitle
open fun getTitle(context: Context!): String!
Returns a human-presentable title for ringtone. Looks in media content provider. If not in either, uses the filename
| Parameters | |
|---|---|
context | Context!: A context used for querying. |
getVolume
open fun getVolume(): Float
Returns the volume scalar set on this player.
| Return | |
|---|---|
Float | a value between 0.0f and 1.0f. |
isHapticGeneratorEnabled
open fun isHapticGeneratorEnabled(): Boolean
Return whether the android.media.audiofx.HapticGenerator effect is enabled or not.
| Return | |
|---|---|
Boolean | true if the HapticGenerator is enabled. |
isLooping
open fun isLooping(): Boolean
Returns whether the looping mode was enabled on this player.
| Return | |
|---|---|
Boolean | true if this player loops when playing. |
isPlaying
open fun isPlaying(): Boolean
Whether this ringtone is currently playing.
| Return | |
|---|---|
Boolean | True if playing, false otherwise. |
setAudioAttributes
open fun setAudioAttributes(attributes: AudioAttributes!): Unit
Sets the AudioAttributes for this ringtone.
| Parameters | |
|---|---|
attributes | AudioAttributes!: the non-null attributes characterizing this ringtone. |
setHapticGeneratorEnabled
open fun setHapticGeneratorEnabled(enabled: Boolean): Boolean
Enable or disable the android.media.audiofx.HapticGenerator effect. The effect can only be enabled on devices that support the effect.
| Return | |
|---|---|
Boolean | true if the HapticGenerator effect is successfully enabled. Otherwise, return false. |
setLooping
open fun setLooping(looping: Boolean): Unit
Sets the player to be looping or non-looping.
| Parameters | |
|---|---|
looping | Boolean: whether to loop or not. |
setStreamType
open funsetStreamType(streamType: Int): Unit
Deprecated: use setAudioAttributes(android.media.AudioAttributes)
Sets the stream type where this ringtone will be played.
| Parameters | |
|---|---|
streamType | Int: The stream, see AudioManager. |
setVolume
open fun setVolume(volume: Float): Unit
Sets the volume on this player.
| Parameters | |
|---|---|
volume | Float: a raw scalar in range 0.0 to 1.0, where 0.0 mutes this player, and 1.0 corresponds to no attenuation being applied. |
Protected methods
finalize
protected open fun finalize(): Unit
| Exceptions | |
|---|---|
java.lang.Throwable | the Exception raised by this method |