app/org.scottishtecharmy.soundscape.appfunctions/BaseSoundscapeAppFunctionService

BaseSoundscapeAppFunctionService

abstract class BaseSoundscapeAppFunctionService : AppFunctionService

Exposes Soundscape's actions to Gemini and other agents.

Every function is a thin wrapper over SoundscapeActionExecutor, the same shared vocabulary the iOS App Intents run on, so the two platforms cannot drift into describing different capabilities.

The KDoc on each function below is not decoration: with isDescribedByKDoc = true it becomes the natural-language description the agent reads to decide when to call it.

Requires API 36, well above the app's minSdk of 30. Nothing else references this class, so on older devices the service simply never starts.

Constructors

BaseSoundscapeAppFunctionService

constructor()

Properties

application

val application: Application?

applicationContext

open val applicationContext: Context?

applicationInfo

open val applicationInfo: ApplicationInfo?

assets

open val assets: AssetManager?

attributionSource

open val attributionSource: AttributionSource

attributionTag

open val attributionTag: String?

baseContext

open val baseContext: Context?

cacheDir

open val cacheDir: File?

classLoader

open val classLoader: ClassLoader?

codeCacheDir

open val codeCacheDir: File?

contentResolver

open val contentResolver: ContentResolver?

dataDir

open val dataDir: File?

deviceId

open val deviceId: Int

display

open val display: Display?

externalCacheDir

open val externalCacheDir: File?

externalCacheDirs

open val externalCacheDirs: Array<out File?>?

externalMediaDirs

open val externalMediaDirs: Array<out File?>?

filesDir

open val filesDir: File?

foregroundServiceType

val foregroundServiceType: Int

isDeviceProtectedStorage

open val isDeviceProtectedStorage: Boolean

isRestricted

open val isRestricted: Boolean

isUiContext

open val isUiContext: Boolean

mainExecutor

open val mainExecutor: Executor?

mainLooper

open val mainLooper: Looper?

noBackupFilesDir

open val noBackupFilesDir: File?

obbDir

open val obbDir: File?

obbDirs

open val obbDirs: Array<out File?>?

opPackageName

open val opPackageName: String

packageCodePath

open val packageCodePath: String?

packageManager

open val packageManager: PackageManager?

packageName

open val packageName: String?

packageResourcePath

open val packageResourcePath: String?

params

open val params: ContextParams?

resources

open val resources: Resources?

theme

open val theme: Resources.Theme?

updateableFlags

open val updateableFlags: Context.BindServiceFlags

wallpaper

open val wallpaper: Drawable?

wallpaperDesiredMinimumHeight

open val wallpaperDesiredMinimumHeight: Int

wallpaperDesiredMinimumWidth

open val wallpaperDesiredMinimumWidth: Int

Functions

aheadOfMe

suspend fun aheadOfMe(): SoundscapeResult

Calls out what lies ahead of the user in the direction they are facing.

aroundMe

suspend fun aroundMe(): SoundscapeResult

Calls out the points of interest around the user, positioned in spatial audio.

beaconInfo

suspend fun beaconInfo(): SoundscapeResult

Says the audio beacon's name, distance, direction and street address. Says "No beacon active" when there is no beacon or route playing.

bindIsolatedService

open fun bindIsolatedService(service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

open fun bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

bindService

open fun bindService(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags): Boolean

open fun bindService(service: Intent, conn: ServiceConnection, flags: Int): Boolean

open fun bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection): Boolean

open fun bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection): Boolean

bindServiceAsUser

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags, user: UserHandle): Boolean

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle): Boolean

calloutBeacon

suspend fun calloutBeacon(): SoundscapeResult

Says how far away the audio beacon is, from the beacon's direction. Says "No beacon active" when there is no beacon or route playing.

checkCallingOrSelfPermission

open fun checkCallingOrSelfPermission(permission: String): Int

checkCallingOrSelfUriPermission

open fun checkCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingOrSelfUriPermissions

open fun checkCallingOrSelfUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkCallingPermission

open fun checkCallingPermission(permission: String): Int

checkCallingUriPermission

open fun checkCallingUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingUriPermissions

open fun checkCallingUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkContentUriPermissionFull

open fun checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int): Int

checkPermission

open fun checkPermission(permission: String, pid: Int, uid: Int): Int

checkSelfPermission

open fun checkSelfPermission(permission: String): Int

checkUriPermission

open fun checkUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int): Int

open fun checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int): Int

checkUriPermissions

open fun checkUriPermissions(uris: List<Uri?>, pid: Int, uid: Int, modeFlags: Int): IntArray

clearWallpaper

open fun ~~clearWallpaper~~()

createAttributionContext

open fun createAttributionContext(attributionTag: String?): Context

createConfigurationContext

open fun createConfigurationContext(overrideConfiguration: Configuration): Context?

createContext

open fun createContext(contextParams: ContextParams): Context

createContextForSplit

open fun createContextForSplit(splitName: String?): Context?

createDeviceContext

open fun createDeviceContext(deviceId: Int): Context

createDeviceProtectedStorageContext

open fun createDeviceProtectedStorageContext(): Context?

createDisplayContext

open fun createDisplayContext(display: Display): Context?

createPackageContext

open fun createPackageContext(packageName: String?, flags: Int): Context?

createWindowContext

open fun createWindowContext(type: Int, options: Bundle?): Context

open fun createWindowContext(display: Display, type: Int, options: Bundle?): Context

databaseList

open fun databaseList(): Array<out String?>?

deleteDatabase

open fun deleteDatabase(name: String?): Boolean

deleteFile

open fun deleteFile(name: String?): Boolean

deleteSharedPreferences

open fun deleteSharedPreferences(name: String?): Boolean

enforceCallingOrSelfPermission

open fun enforceCallingOrSelfPermission(permission: String, message: String?)

enforceCallingOrSelfUriPermission

open fun enforceCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforceCallingPermission

open fun enforceCallingPermission(permission: String, message: String?)

enforceCallingUriPermission

open fun enforceCallingUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforcePermission

open fun enforcePermission(permission: String, pid: Int, uid: Int, message: String?)

enforceUriPermission

open fun enforceUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int, message: String?)

open fun enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)

fileList

open fun fileList(): Array<out String?>?

getColor

fun getColor(id: Int): Int

getColorStateList

fun getColorStateList(id: Int): ColorStateList

getDatabasePath

open fun getDatabasePath(name: String?): File?

getDir

open fun getDir(name: String?, mode: Int): File?

getDrawable

fun getDrawable(id: Int): Drawable?

getExternalFilesDir

open fun getExternalFilesDir(type: String?): File?

getExternalFilesDirs

open fun getExternalFilesDirs(type: String?): Array<out File?>?

getFileStreamPath

open fun getFileStreamPath(name: String?): File?

getSharedPreferences

open fun getSharedPreferences(name: String?, mode: Int): SharedPreferences?

getString

fun getString(resId: Int): String

fun getString(resId: Int, vararg formatArgs: Any?): String

getSystemService

fun <T : Any?> getSystemService(serviceClass: Class<T?>): T?

open fun getSystemService(name: String): Any?

getSystemServiceName

open fun getSystemServiceName(serviceClass: Class<*>): String?

getText

fun getText(resId: Int): CharSequence

grantUriPermission

open fun grantUriPermission(toPackage: String?, uri: Uri?, modeFlags: Int)

listMarkers

suspend fun listMarkers(): SoundscapeResult

Lists the names of the user's saved markers. Works whether or not Soundscape is running, because it only reads saved data.

listRoutes

suspend fun listRoutes(): SoundscapeResult

Lists the names of the user's saved routes. Works whether or not Soundscape is running, because it only reads saved data.

moveDatabaseFrom

open fun moveDatabaseFrom(sourceContext: Context?, name: String?): Boolean

moveSharedPreferencesFrom

open fun moveSharedPreferencesFrom(sourceContext: Context?, name: String?): Boolean

myLocation

suspend fun myLocation(): SoundscapeResult

Describes where the user is now — the street, and what is nearby.

nearbyMarkers

suspend fun nearbyMarkers(): SoundscapeResult

Calls out the user's saved markers that are nearby.

nextWaypoint

suspend fun nextWaypoint(): SoundscapeResult

Skips forward to the next waypoint on the route being played.

obtainStyledAttributes

fun obtainStyledAttributes(attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray): TypedArray

fun obtainStyledAttributes(resid: Int, attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int): TypedArray

onBind

fun onBind(intent: Intent?): IBinder

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

onCreate

@CallSuper

open override fun onCreate()

onDestroy

@CallSuper

open override fun onDestroy()

onExecuteFunction

@MainThread

abstract fun onExecuteFunction(request: ExecuteAppFunctionRequest, cancellationSignal: CancellationSignal, callback: Consumer<ExecuteAppFunctionResponse>)

override fun onExecuteFunction(request: ExecuteAppFunctionRequest, callingPackage: String, signingInfo: SigningInfo, cancellationSignal: CancellationSignal, callback: OutcomeReceiver<ExecuteAppFunctionResponse, AppFunctionException>)

onLowMemory

open fun onLowMemory()

onRebind

open fun onRebind(intent: Intent?)

onStart

open fun ~~onStart~~(intent: Intent?, startId: Int)

onStartCommand

open fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int

onTaskRemoved

open fun onTaskRemoved(rootIntent: Intent?)

onTimeout

open fun onTimeout(startId: Int)

open fun onTimeout(startId: Int, fgsType: Int)

onTrimMemory

open fun onTrimMemory(level: Int)

onUnbind

open fun onUnbind(intent: Intent?): Boolean

openFileInput

open fun openFileInput(name: String?): FileInputStream?

openFileOutput

open fun openFileOutput(name: String?, mode: Int): FileOutputStream?

openOrCreateDatabase

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?): SQLiteDatabase?

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?, errorHandler: DatabaseErrorHandler?): SQLiteDatabase?

peekWallpaper

open fun ~~peekWallpaper~~(): Drawable?

previousWaypoint

suspend fun previousWaypoint(): SoundscapeResult

Goes back to the previous waypoint on the route being played.

rebindService

open fun rebindService(conn: ServiceConnection, flags: Context.BindServiceFlags)

registerComponentCallbacks

open fun registerComponentCallbacks(callback: ComponentCallbacks?)

registerDeviceIdChangeListener

open fun registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)

registerReceiver

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, flags: Int): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?, flags: Int): Intent?

removeStickyBroadcast

open fun ~~removeStickyBroadcast~~(intent: Intent?)

removeStickyBroadcastAsUser

open fun ~~removeStickyBroadcastAsUser~~(intent: Intent?, user: UserHandle?)

resolveInventory

open fun resolveInventory(): AppFunctionInventory?

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(permName: String)

revokeSelfPermissionsOnKill

open fun revokeSelfPermissionsOnKill(permissions: Collection<String?>)

revokeUriPermission

open fun revokeUriPermission(uri: Uri?, modeFlags: Int)

open fun revokeUriPermission(targetPackage: String?, uri: Uri?, modeFlags: Int)

sendBroadcast

open fun sendBroadcast(intent: Intent?)

open fun sendBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

sendBroadcastAsUser

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?)

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?)

sendBroadcastWithMultiplePermissions

open fun sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<out String?>)

sendOrderedBroadcast

open fun sendOrderedBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, initialCode: Int, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialData: String?, initialExtras: Bundle?, options: Bundle?)

sendOrderedBroadcastAsUser

open fun sendOrderedBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

sendStickyBroadcast

open fun ~~sendStickyBroadcast~~(intent: Intent?)

open fun ~~sendStickyBroadcast~~(intent: Intent, options: Bundle?)

sendStickyBroadcastAsUser

open fun ~~sendStickyBroadcastAsUser~~(intent: Intent?, user: UserHandle?)

sendStickyOrderedBroadcast

open fun ~~sendStickyOrderedBroadcast~~(intent: Intent?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

sendStickyOrderedBroadcastAsUser

open fun ~~sendStickyOrderedBroadcastAsUser~~(intent: Intent?, user: UserHandle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

setCalloutDetail

suspend fun setCalloutDetail(level: String): SoundscapeResult

Sets how much Soundscape says automatically as the user walks: Silent turns automatic callouts off altogether, leaving beacons, routes and on-demand callouts; Essential calls out only streets, junctions and landmarks; Simplified skips minor paths and repeats itself less; Detailed calls out everything nearby. Useful when a busy street is too noisy, or a quiet one too sparse. The change is saved, the same as choosing it in Settings.

setTheme

open fun setTheme(resid: Int)

setWallpaper

open fun ~~setWallpaper~~(bitmap: Bitmap?)

open fun ~~setWallpaper~~(data: InputStream?)

startActivities

open fun startActivities(intents: Array<out Intent?>?)

open fun startActivities(intents: Array<out Intent?>?, options: Bundle?)

startActivity

open fun startActivity(intent: Intent?)

open fun startActivity(intent: Intent?, options: Bundle?)

startBeacon

suspend fun startBeacon(name: String): SoundscapeResult

Sets an audio beacon on one of the user's saved markers, matched by name. The beacon plays a repeating tone from the direction of the marker until it is stopped.

startForeground