chromex.app.media-perception-private — binaryage/chromex 0.9.3

clj

Private API for receiving real-time media perception information.

• available since Chrome 60

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-diagnostics clj/s macro

(get-diagnostics)

Get a diagnostics buffer out of the video analytics process.

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 [diagnostics] where:

|diagnostics| - ?

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.

get-diagnostics* cljs

(get-diagnostics* config)

get-state clj/s macro

(get-state)

Gets the status of the media perception process.

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 [state] where:

|state| - ?

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.

get-state* cljs

(get-state* config)

on-media-perception* cljs

(on-media-perception* config channel & args)

set-analytics-component clj/s macro

(set-analytics-component component)

Attempts to download and load the media analytics component. This function should be called every time a client starts using this API. If the component is already loaded, the callback will simply return that information. The process must be STOPPED for this function to succeed. Note: If a different component type is desired, this function can be called with the new desired type and the new component will be downloaded and installed.

|component| - The desired component to install and load.

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 [component-state] where:

|component-state| - ?

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.

set-analytics-component* cljs

(set-analytics-component* config component)

set-component-process-state clj/s macro

(set-component-process-state process-state)

Manages the lifetime of the component process. This function should only be used if the component is installed. It will fail if the component is not installed.

|process-state| - The desired state for the component process.

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 [process-state] where:

|process-state| - ?

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.

set-component-process-state* cljs

(set-component-process-state* config process-state)

set-state clj/s macro

(set-state state)

Sets the desired state of the system.

|state| - A dictionary with the desired new state. The only settable states are RUNNING, SUSPENDED, and RESTARTING.

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 [state] where:

|state| - ?

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.

set-state* cljs

(set-state* config state)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.media-perception-private namespace.

tap-on-media-perception-events clj/s macro

(tap-on-media-perception-events channel & args)

Fired when media perception information is received from the media analytics process.

Events will be put on the |channel| with signature [::on-media-perception [media-perception]] where:

|media-perception| - The dictionary which contains a dump of everything the analytics process has detected or determined from the incoming media streams.

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