Ringtone
public
class
Ringtone
extends Object
java.lang.Object | |
↳ | 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
.
See also:
Summary
Public methods | |
---|---|
AudioAttributes
|
getAudioAttributes()
Returns the |
int
|
getStreamType()
This method was deprecated
in API level 21.
use of stream types is deprecated, see
|
String
|
getTitle(Context context)
Returns a human-presentable title for ringtone. |
float
|
getVolume()
Returns the volume scalar set on this player. |
boolean
|
isHapticGeneratorEnabled()
Return whether the |
boolean
|
isLooping()
Returns whether the looping mode was enabled on this player. |
boolean
|
isPlaying()
Whether this ringtone is currently playing. |
void
|
play()
Plays the ringtone. |
void
|
setAudioAttributes(AudioAttributes attributes)
Sets the |
boolean
|
setHapticGeneratorEnabled(boolean enabled)
Enable or disable the |
void
|
setLooping(boolean looping)
Sets the player to be looping or non-looping. |
void
|
setStreamType(int streamType)
This method was deprecated
in API level 21.
use |
void
|
setVolume(float volume)
Sets the volume on this player. |
void
|
stop()
Stops a playing ringtone. |
Inherited methods | |
---|---|
Public methods
getAudioAttributes
public AudioAttributes getAudioAttributes ()
Returns the AudioAttributes
used by this object.
Returns | |
---|---|
AudioAttributes |
the AudioAttributes that were set with
setAudioAttributes(android.media.AudioAttributes) or the default attributes if none were set. |
getStreamType
public int getStreamType ()
This method was deprecated
in API level 21.
use of stream types is deprecated, see
setAudioAttributes(android.media.AudioAttributes)
Gets the stream type where this ringtone will be played.
Returns | |
---|---|
int |
The stream type, see AudioManager . |
getTitle
public String getTitle (Context context)
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 |
getVolume
public float getVolume ()
Returns the volume scalar set on this player.
Returns | |
---|---|
float |
a value between 0.0f and 1.0f. |
isHapticGeneratorEnabled
public boolean isHapticGeneratorEnabled ()
Return whether the HapticGenerator
effect is enabled or not.
Returns | |
---|---|
boolean |
true if the HapticGenerator is enabled. |
isLooping
public boolean isLooping ()
Returns whether the looping mode was enabled on this player.
Returns | |
---|---|
boolean |
true if this player loops when playing. |
isPlaying
public boolean isPlaying ()
Whether this ringtone is currently playing.
Returns | |
---|---|
boolean |
True if playing, false otherwise. |
setAudioAttributes
public void setAudioAttributes (AudioAttributes attributes)
Sets the AudioAttributes
for this ringtone.
Parameters | |
---|---|
attributes |
AudioAttributes : the non-null attributes characterizing this ringtone. |
Throws | |
---|---|
IllegalArgumentException |
setHapticGeneratorEnabled
public boolean setHapticGeneratorEnabled (boolean enabled)
Enable or disable the HapticGenerator
effect. The effect can
only be enabled on devices that support the effect.
Parameters | |
---|---|
enabled |
boolean |
Returns | |
---|---|
boolean |
true if the HapticGenerator effect is successfully enabled. Otherwise, return false. |
See also:
setLooping
public void setLooping (boolean looping)
Sets the player to be looping or non-looping.
Parameters | |
---|---|
looping |
boolean : whether to loop or not. |
setStreamType
public void setStreamType (int streamType)
This method was deprecated
in API level 21.
use setAudioAttributes(android.media.AudioAttributes)
Sets the stream type where this ringtone will be played.
Parameters | |
---|---|
streamType |
int : The stream, see AudioManager . |
setVolume
public void setVolume (float volume)
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. |