Maps SDK for Android/com.magiclane.sdk.core/SoundPlayer

SoundPlayer

class SoundPlayer(address: Long, isRef: Boolean) : GemNativeObj

Sound player interface. To be used by user-defined players.

Constructors

SoundPlayer

constructor(address: Long, isRef: Boolean)

Types

Companion

object Companion

SoundPlayer companion object.

Properties

address

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Functions

cancel

external fun cancel(listener: ISoundPlayingListener): Int

Cancels the play operation associated with the provided listener.

canPlayMimeType

fun canPlayMimeType(type: EMimeType): Boolean

Checks if this player supports the specified MIME type

canPlayMimeTypeAsInt

fun canPlayMimeTypeAsInt(type: Int): Boolean

Checks if this player supports the specified MIME type

canPlayTtsMimeType

fun canPlayTtsMimeType(type: EMimeType): Boolean

Checks if this player supports the specified TTS EMimeType.

canPlayTtsMimeTypeAsInt

fun canPlayTtsMimeTypeAsInt(type: Int): Boolean

Checks if this player supports the specified TTS EMimeType.

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

getDefaultLanguage

external fun getDefaultLanguage(): Language?

Returns an ILanguage instance describing the language currently being used in system as the default TTS language. This is required for TTS players.

getLanguage

external fun getLanguage(): Language?

Gets the TTS language. Returns the last language set by this by a SetLanguage call to the same instance.

getLanguageList

external fun getLanguageList(): ArrayList<Language>?

Gets the list of languages natively supported by the player. This is required for TTS players.

getTtsSupportLevel

fun getTtsSupportLevel(langCode: String, regionCode: String, scriptCode: String): ETtsSupportLevel

Get the TTS support level for specified language This is required for TTS players.

getTtsSupportLevelAsInt

fun getTtsSupportLevelAsInt(langCode: String, regionCode: String, scriptCode: String): Int

Get the TTS support level for specified language This is required for TTS players.

isReference

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

not

operator fun not(): Boolean

Checks if this object is valid.

play

external fun play(source: ISoundSource, preferences: SoundPlayingPreferences, listener: ISoundPlayingListener): Int

Play the requested sound. The provided progress listener will be used also for canceling the play. A progress listener can be attached to only one play operation at a time. The player will release the source when no more needed.

playingSoundsCount

external fun playingSoundsCount(): Int

Returns the number of sounds currently playing on this player.

playSources

external fun playSources(sources: ArrayList<ISoundSource>, preferences: SoundPlayingPreferences, listener: ISoundPlayingListener): Int

Play the requested sounds list. The provided progress listener will be used also for canceling the play. A progress listener can be attached to only one play operation at a time. The player will release the source when no more needed.

release

fun release()

Releases the native referenced value of this object if:

setLanguage

external fun setLanguage(value: Language): Int

Sets the TTS language. This is required for TTS players. Use getLanguageList and getDefaultLanguage methods to check the level of support before choosing the language to use for the next utterances.