Ringtone

getAudioAttributes

open fun getAudioAttributes(): AudioAttributes!

Returns the AudioAttributes used by this object.

getStreamType

open fun getStreamType(): Int

Deprecated: use of stream types is deprecated, see setAudioAttributes(android.media.AudioAttributes)

Gets the stream type where this ringtone will be played.

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

getVolume

open fun getVolume(): Float

Returns the volume scalar set on this player.

isHapticGeneratorEnabled

open fun isHapticGeneratorEnabled(): Boolean

Return whether the android.media.audiofx.HapticGenerator effect is enabled or not.

isLooping

open fun isLooping(): Boolean

Returns whether the looping mode was enabled on this player.

isPlaying

open fun isPlaying(): Boolean

Whether this ringtone is currently playing.

play

open fun play(): Unit

Plays the ringtone.

setAudioAttributes

open fun setAudioAttributes(attributes: AudioAttributes!): Unit

Sets the AudioAttributes for 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.

setLooping

open fun setLooping(looping: Boolean): Unit

Sets the player to be looping or non-looping.

setStreamType

open fun setStreamType(streamType: Int): Unit

Deprecated: use setAudioAttributes(android.media.AudioAttributes)

Sets the stream type where this ringtone will be played.

setVolume

open fun setVolume(volume: Float): Unit

Sets the volume on this player.

stop

open fun stop(): Unit

Stops a playing ringtone.

finalize

protected open fun finalize(): Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.