MagnificationController

addListener

fun addListener(listener: AccessibilityService.MagnificationController.OnMagnificationChangedListener): Unit

Adds the specified change listener to the list of magnification change listeners. The callback will occur on the service's main thread.

addListener

fun addListener(
    listener: AccessibilityService.MagnificationController.OnMagnificationChangedListener, 
    handler: Handler?
): Unit

Adds the specified change listener to the list of magnification change listeners. The callback will occur on the specified Handler's thread, or on the service's main thread if the handler is null.

getCenterX

fun getCenterX(): Float

Deprecated: Use getMagnificationConfig() instead

Returns the unscaled screen-relative X coordinate of the focal center of the magnified region. This is the point around which zooming occurs and is guaranteed to lie within the magnified region.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return a default value of 0.0f.

Note: This legacy API gets the center position of full-screen magnification. To get the magnification center of the current controlling magnifier, use getMagnificationConfig instead.

getCenterY

fun getCenterY(): Float

Deprecated: Use getMagnificationConfig() instead

Returns the unscaled screen-relative Y coordinate of the focal center of the magnified region. This is the point around which zooming occurs and is guaranteed to lie within the magnified region.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return a default value of 0.0f.

Note: This legacy API gets the center position of full-screen magnification. To get the magnification center of the current controlling magnifier, use getMagnificationConfig instead.

getCurrentMagnificationRegion

fun getCurrentMagnificationRegion(): Region

Returns the region of the screen currently active for magnification if the controlling magnification is MagnificationConfig.MAGNIFICATION_MODE_FULLSCREEN. Returns the region of screen projected on the magnification window if the controlling magnification is MagnificationConfig.MAGNIFICATION_MODE_WINDOW.

If the controlling mode is MagnificationConfig.MAGNIFICATION_MODE_FULLSCREEN, the returned region will be empty if the magnification is not active. And the magnification is active if magnification gestures are enabled or if a service is running that can control magnification.

If the controlling mode is MagnificationConfig.MAGNIFICATION_MODE_WINDOW, the returned region will be empty if the magnification is not activated.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return an empty region.

getMagnificationConfig

fun getMagnificationConfig(): MagnificationConfig?

Gets the MagnificationConfig of the controlling magnifier on the display.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return null.

getMagnificationRegion

fun getMagnificationRegion(): Region

Deprecated: Use getCurrentMagnificationRegion() instead

Returns the region of the screen currently active for magnification. Changes to magnification scale and center only affect this portion of the screen. The rest of the screen, for example input methods, cannot be magnified. This region is relative to the unscaled screen and is independent of the scale and center point.

The returned region will be empty if magnification is not active. Magnification is active if magnification gestures are enabled or if a service is running that can control magnification.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return an empty region.

Note: This legacy API gets the magnification region of full-screen magnification. To get the magnification region of the current controlling magnifier, use getCurrentMagnificationRegion() instead.

getScale

fun getScale(): Float

Deprecated: Use getMagnificationConfig() instead

Returns the current magnification scale.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will return a default value of 1.0f.

Note: This legacy API gets the scale of full-screen magnification. To get the scale of the current controlling magnifier, use getMagnificationConfig instead.

removeListener

fun removeListener(listener: AccessibilityService.MagnificationController.OnMagnificationChangedListener): Boolean

Removes the specified change listener from the list of magnification change listeners.

reset

fun reset(animate: Boolean): Boolean

Resets magnification scale and center to their default (e.g. no magnification) values.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

Note: This legacy API reset full-screen magnification. To reset the current controlling magnifier, use resetCurrentMagnification(boolean) ()} instead.

resetCurrentMagnification

fun resetCurrentMagnification(animate: Boolean): Boolean

Resets magnification scale and center of the controlling magnification to their default (e.g. no magnification) values.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

setCenter

fun setCenter(
    centerX: Float, 
    centerY: Float, 
    animate: Boolean
): Boolean

Deprecated: Use setMagnificationConfig(android.accessibilityservice.MagnificationConfig,boolean) instead

Sets the center of the magnified viewport.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

Note: This legacy API sets the center of full-screen magnification. To set the center of the specified magnifier, use setMagnificationConfig instead.

setMagnificationConfig

fun setMagnificationConfig(
    config: MagnificationConfig, 
    animate: Boolean
): Boolean

Sets the MagnificationConfig. The service controls the magnification by setting the config.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

setScale

fun setScale(
    scale: Float, 
    animate: Boolean
): Boolean

Deprecated: Use setMagnificationConfig(android.accessibilityservice.MagnificationConfig,boolean) instead

Sets the magnification scale.

Note: If the service is not yet connected (e.g. AccessibilityService.onServiceConnected() has not yet been called) or the service has been disconnected, this method will have no effect and return false.

Note: This legacy API sets the scale of full-screen magnification. To set the scale of the specified magnifier, use setMagnificationConfig instead.