chromex.app.display-source — binaryage/chromex 0.8.1

clj

The chrome.displaySource API creates a Display session using WebMediaStreamTrack as sources.

• available since Chrome 77
• https://developer.chrome.com/apps/displaySource

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-available-sinks clj/s macro

(get-available-sinks)

Queries the list of the currently available Display sinks.

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

|result| - https://developer.chrome.com/apps/displaySource#property-callback-result.

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/displaySource#method-getAvailableSinks.

get-available-sinks* cljs

(get-available-sinks* config)

on-session-error-occured* cljs

(on-session-error-occured* config channel & args)

on-session-terminated* cljs

(on-session-terminated* config channel & args)

on-sinks-updated* cljs

(on-sinks-updated* config channel & args)

request-authentication clj/s macro

(request-authentication sink-id)

Queries authentication data from the sink device.

|sink-id| - Id of the sink

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

|result| - https://developer.chrome.com/apps/displaySource#property-callback-result.

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/displaySource#method-requestAuthentication.

request-authentication* cljs

(request-authentication* config sink-id)

start-session clj/s macro

(start-session session-info)

Creates a Display session using the provided StartSessionInfo instance. The input argument fields must be initialized as described below: The |sinkId| must be a valid id of a sink (obtained via ‘getAvailableSinks’).The |audioTrack| or |videoTrack| must be of type MediaStreamTrack. Either |audioTrack| or |videoTrack| can be null but not both. This means creating a session with only audio or video.The |authenticationInfo| can be null if no additional authentication data are required by the sink; otherwise its |data| field must contain the required authentication data (e.g. PIN value) and its |method| field must be the same as one obtained from ‘requestAuthentication’.

|session-info| - https://developer.chrome.com/apps/displaySource#property-startSession-sessionInfo.

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/displaySource#method-startSession.

start-session* cljs

(start-session* config session-info)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-session-error-occured-events clj/s macro

(tap-on-session-error-occured-events channel & args)

Event fired when an error occurs. |sinkId| Id of the peer sink |errorInfo| error description

Events will be put on the |channel| with signature [::on-session-error-occured [sink-id error-info]] where:

|sink-id| - https://developer.chrome.com/apps/displaySource#property-onSessionErrorOccured-sinkId. |error-info| - https://developer.chrome.com/apps/displaySource#property-onSessionErrorOccured-errorInfo.

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

https://developer.chrome.com/apps/displaySource#event-onSessionErrorOccured.

tap-on-session-terminated-events clj/s macro

(tap-on-session-terminated-events channel & args)

Event fired when the Display session is terminated. |sinkId| Id of the peer sink

Events will be put on the |channel| with signature [::on-session-terminated [sink-id]] where:

|sink-id| - https://developer.chrome.com/apps/displaySource#property-onSessionTerminated-sinkId.

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

https://developer.chrome.com/apps/displaySource#event-onSessionTerminated.

tap-on-sinks-updated-events clj/s macro

(tap-on-sinks-updated-events channel & args)

Event fired when the available sinks are modified (either their amount or properties) |sinks| the list of all currently available sinks

Events will be put on the |channel| with signature [::on-sinks-updated [sinks]] where:

|sinks| - https://developer.chrome.com/apps/displaySource#property-onSinksUpdated-sinks.

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

https://developer.chrome.com/apps/displaySource#event-onSinksUpdated.

terminate-session clj/s macro

(terminate-session sink-id)

Terminates the active Display session.

|sink-id| - Id of the connected sink.

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/displaySource#method-terminateSession.

terminate-session* cljs

(terminate-session* config sink-id)