chromex.app.system.display — binaryage/chromex 0.9.3

clj

Use the system.display API to query display metadata.

• available since Chrome 36
• https://developer.chrome.com/apps/system.display

api-table clj

clear-touch-calibration clj/s macro

(clear-touch-calibration id)

Resets the touch calibration for the display and brings it back to its default state by clearing any touch calibration data associated with the display.

|id| - The display's unique identifier.

https://developer.chrome.com/apps/system.display#method-clearTouchCalibration.

clear-touch-calibration* cljs

(clear-touch-calibration* config id)

complete-custom-touch-calibration clj/s macro

(complete-custom-touch-calibration pairs bounds)

Sets the touch calibration pairs for a display. These |pairs| would be used to calibrate the touch screen for display with |id| called in startCustomTouchCalibration(). Always call |startCustomTouchCalibration| before calling this method. If another touch calibration is already in progress this will throw an error.

|pairs| - The pairs of point used to calibrate the display. |bounds| - Bounds of the display when the touch calibration was performed. |bounds.left| and |bounds.top| values are ignored.

https://developer.chrome.com/apps/system.display#method-completeCustomTouchCalibration.

complete-custom-touch-calibration* cljs

(complete-custom-touch-calibration* config pairs bounds)

enable-unified-desktop clj/s macro

(enable-unified-desktop enabled)

Enables/disables the unified desktop feature. If enabled while mirroring is active, the desktop mode will not change until mirroring is turned off. Otherwise, the desktop mode will switch to unified immediately. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

|enabled| - True if unified desktop should be enabled.

https://developer.chrome.com/apps/system.display#method-enableUnifiedDesktop.

enable-unified-desktop* cljs

(enable-unified-desktop* config enabled)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-display-layout clj/s macro

(get-display-layout)

Requests the layout info for all displays. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [layouts] where:

|layouts| - https://developer.chrome.com/apps/system.display#property-callback-layouts.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-getDisplayLayout.

get-display-layout* cljs

(get-display-layout* config)

get-info clj/s macro

(get-info)

(get-info flags)

Requests the information for all attached display devices.

|flags| - Options affecting how the information is returned.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [display-info] where:

|display-info| - https://developer.chrome.com/apps/system.display#property-callback-displayInfo.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-getInfo.

get-info* cljs

(get-info* config flags)

on-display-changed* cljs

(on-display-changed* config channel & args)

overscan-calibration-adjust clj/s macro

(overscan-calibration-adjust id delta)

Adjusts the current overscan insets for a display. Typically this should either move the display along an axis (e.g. left+right have the same value) or scale it along an axis (e.g. top+bottom have opposite values). Each Adjust call is cumulative with previous calls since Start.

|id| - The display's unique identifier. |delta| - The amount to change the overscan insets.

https://developer.chrome.com/apps/system.display#method-overscanCalibrationAdjust.

overscan-calibration-adjust* cljs

(overscan-calibration-adjust* config id delta)

overscan-calibration-complete clj/s macro

(overscan-calibration-complete id)

Complete overscan adjustments for a display by saving the current values and hiding the overlay.

|id| - The display's unique identifier.

https://developer.chrome.com/apps/system.display#method-overscanCalibrationComplete.

overscan-calibration-complete* cljs

(overscan-calibration-complete* config id)

overscan-calibration-reset clj/s macro

(overscan-calibration-reset id)

Resets the overscan insets for a display to the last saved value (i.e before Start was called).

|id| - The display's unique identifier.

https://developer.chrome.com/apps/system.display#method-overscanCalibrationReset.

overscan-calibration-reset* cljs

(overscan-calibration-reset* config id)

overscan-calibration-start clj/s macro

(overscan-calibration-start id)

Starts overscan calibration for a display. This will show an overlay on the screen indicating the current overscan insets. If overscan calibration for display |id| is in progress this will reset calibration.

|id| - The display's unique identifier.

https://developer.chrome.com/apps/system.display#method-overscanCalibrationStart.

overscan-calibration-start* cljs

(overscan-calibration-start* config id)

set-display-layout clj/s macro

(set-display-layout layouts)

Set the layout for all displays. Any display not included will use the default layout. If a layout would overlap or be otherwise invalid it will be adjusted to a valid layout. After layout is resolved, an onDisplayChanged event will be triggered. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

|layouts| - The layout information, required for all displays except the primary display.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-setDisplayLayout.

set-display-layout* cljs

(set-display-layout* config layouts)

set-display-properties clj/s macro

(set-display-properties id info)

Updates the properties for the display specified by |id|, according to the information provided in |info|. On failure, 'runtime.lastError' will be set. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

|id| - The display's unique identifier. |info| - The information about display properties that should be changed. A property will be changed only if a new value for it is specified in |info|.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-setDisplayProperties.

set-display-properties* cljs

(set-display-properties* config id info)

set-mirror-mode clj/s macro

(set-mirror-mode info)

Sets the display mode to the specified mirror mode. Each call resets the state from previous calls. Calling setDisplayProperties() will fail for the mirroring destination displays. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.

|info| - The information of the mirror mode that should be applied to the display mode.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-setMirrorMode.

set-mirror-mode* cljs

(set-mirror-mode* config info)

show-native-touch-calibration clj/s macro

(show-native-touch-calibration id)

Displays the native touch calibration UX for the display with |id| as display id. This will show an overlay on the screen with required instructions on how to proceed. The callback will be invoked in case of successful calibration only. If the calibration fails, this will throw an error.

|id| - The display's unique identifier.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [success] where:

|success| - https://developer.chrome.com/apps/system.display#property-callback-success.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/system.display#method-showNativeTouchCalibration.

show-native-touch-calibration* cljs

(show-native-touch-calibration* config id)

start-custom-touch-calibration clj/s macro

(start-custom-touch-calibration id)

Starts custom touch calibration for a display. This should be called when using a custom UX for collecting calibration data. If another touch calibration is already in progress this will throw an error.

|id| - The display's unique identifier.

https://developer.chrome.com/apps/system.display#method-startCustomTouchCalibration.

start-custom-touch-calibration* cljs

(start-custom-touch-calibration* config id)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.system.display namespace.

tap-on-display-changed-events clj/s macro

(tap-on-display-changed-events channel & args)

Fired when anything changes to the display configuration.

Events will be put on the |channel| with signature [::on-display-changed []].

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/system.display#event-onDisplayChanged.