VoiceInstructionsPlayerOptions

class VoiceInstructionsPlayerOptions

VoiceInstructionsPlayerOptions.

Types

Link copied to clipboard
class Builder

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Regenerate whenever a change is made

Link copied to clipboard
open override fun hashCode(): Int

Regenerate whenever a change is made

Link copied to clipboard
fun toBuilder(): VoiceInstructionsPlayerOptions.Builder

Get a builder to customize a subset of current options.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.

Properties

Link copied to clipboard
val checkIsLanguageAvailable: Boolean

Checks if the specified language as represented by the Locale is available and supported by TTS. Defaults to True

Link copied to clipboard
val contentType: Int

Defines what the sound is and expresses the general category of the content such as movie, speech, or beep/ringtone. The audio framework uses content type information to selectively configure audio post-processing blocks. While supplying the content type is optional, you should include type information whenever the content type is known Defaults to AudioAttributes.CONTENT_TYPE_MUSIC

Link copied to clipboard
Link copied to clipboard
val streamType: Int

Defines which stream will be used for playing Defaults to AudioManager.STREAM_MUSIC See AudioManager for a list of stream types. Supports pre Oreo and above implementations

Link copied to clipboard
val ttsStreamType: Int

Defines which stream will be used for playing TTS Defaults to AudioManager.STREAM_MUSIC See AudioManager for a list of stream types. Supports pre Oreo and above implementations

Link copied to clipboard
val usage: Int

Defines the context in which the stream is used, providing information about why the sound is playing and what the sound is used for. Usage information is more expressive than a stream type and allows platforms or routing policies to refine volume or routing decisions Defaults to AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE

Link copied to clipboard
val useLegacyApi: Boolean

Specifies attributes as inferred from the legacy stream types. Defaults to False Warning: When this value is true any other attributes such as usage, content type, flags or haptic control will be ignored.