Summary: Methods | Inherited Methods | [Expand All]

Added in API level 1

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

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public AudioAttributes getAudioAttributes ()

Added in API level 21

Returns the AudioAttributes used by this object.

Returns

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

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	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 setAudioAttributes (AudioAttributes attributes)

Added in API level 21

Sets the AudioAttributes for this ringtone.

Parameters

attributes	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	The stream, see `AudioManager`.

public void stop ()

Added in API level 1

Stops a playing ringtone.

Results

Interfaces

Classes

Exceptions

Ringtone

Class Overview

See Also

Summary

Public Methods

public AudioAttributes getAudioAttributes ()

Returns

public int getStreamType ()

Returns

public String getTitle (Context context)

Parameters

public boolean isPlaying ()

Returns

public void play ()

public void setAudioAttributes (AudioAttributes attributes)

Parameters

Throws

public void setStreamType (int streamType)

Parameters

public void stop ()