Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
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 .

Summary

Public Methods
int getStreamType ()
Gets the stream type where this ringtone will be played.
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 setStreamType (int streamType)
Sets the stream type where this ringtone will be played.
void stop ()
Stops a playing ringtone.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public int getStreamType ()

Added in API level 1

Gets the stream type where this ringtone will be played.

Returns

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 A context used for querying.

public boolean isPlaying ()

Added in API level 1

Whether this ringtone is currently playing.

Returns
  • True if playing, false otherwise.

public void play ()

Added in API level 1

Plays the ringtone.

public void setStreamType (int streamType)

Added in API level 1

Sets the stream type where this ringtone will be played.

Parameters
streamType The stream, see AudioManager .

public void stop ()

Added in API level 1

Stops a playing ringtone.