Android APIs
public class

Ringtone

extends Object
java.lang.Object
   ↳ android.media.Ringtone

Class Overview

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.

See also:

Summary

Public Methods
AudioAttributes getAudioAttributes()
Returns the AudioAttributes used by this object.
int getStreamType()
This method was deprecated in API level 21. use of stream types is deprecated, see setAudioAttributes(AudioAttributes)
String getTitle(Context context)
Returns a human-presentable title for ringtone.
boolean isPlaying()
Whether this ringtone is currently playing.
void play()
Plays the ringtone.
void setAudioAttributes(AudioAttributes attributes)
Sets the AudioAttributes for this ringtone.
void setStreamType(int streamType)
This method was deprecated in API level 21. use setAudioAttributes(AudioAttributes)
void stop()
Stops a playing ringtone.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public AudioAttributes getAudioAttributes ()

Added in API level 21

Returns the AudioAttributes used by this object.

Returns
AudioAttributes the AudioAttributes that were set with setAudioAttributes(AudioAttributes) or the default attributes if none were set.

public int getStreamType ()

Added in API level 1

This method was deprecated in API level 21.
use of stream types is deprecated, see setAudioAttributes(AudioAttributes)

Gets the stream type where this ringtone will be played.

Returns
int The stream type, see AudioManager.

public String getTitle (Context context)

Added in API level 1

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.
Returns
String

public boolean isPlaying ()

Added in API level 1

Whether this ringtone is currently playing.

Returns
boolean True if playing, false otherwise.

public void play ()

Added in API level 1

Plays the ringtone.

public void setAudioAttributes (AudioAttributes attributes)

Added in API level 21

Sets the AudioAttributes for this ringtone.

Parameters
attributes AudioAttributes: the non-null attributes characterizing this ringtone.
Throws
IllegalArgumentException

public void setStreamType (int streamType)

Added in API level 1

This method was deprecated in API level 21.
use setAudioAttributes(AudioAttributes)

Sets the stream type where this ringtone will be played.

Parameters
streamType int: The stream, see AudioManager.

public void stop ()

Added in API level 1

Stops a playing ringtone.

Protected Methods

protected void finalize ()

Added in API level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.