Liking cljdoc? Tell your friends :D

chromex.ext.display-source

clj

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

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

  * available since Chrome 87
  * https://developer.chrome.com/extensions/displaySource
raw docstring

api-tableclj

source

gen-callclj

source

gen-wrapclj/smacro

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

get-available-sinksclj/smacro

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

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

get-available-sinks*cljs

(get-available-sinks* config)
source

on-session-error-occured*cljs

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

on-session-terminated*cljs

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

on-sinks-updated*cljs

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

request-authenticationclj/smacro

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

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

request-authentication*cljs

(request-authentication* config sink-id)
source

start-sessionclj/smacro

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

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

start-session*cljs

(start-session* config session-info)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

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

Taps all valid non-deprecated events in chromex.ext.display-source namespace.
sourceraw docstring

tap-on-session-error-occured-eventsclj/smacro

(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/extensions/displaySource#property-onSessionErrorOccured-sinkId. |error-info| - https://developer.chrome.com/extensions/displaySource#property-onSessionErrorOccured-errorInfo.

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

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

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/extensions/displaySource#property-onSessionErrorOccured-sinkId.
  |error-info| - https://developer.chrome.com/extensions/displaySource#property-onSessionErrorOccured-errorInfo.

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

https://developer.chrome.com/extensions/displaySource#event-onSessionErrorOccured.
sourceraw docstring

tap-on-session-terminated-eventsclj/smacro

(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/extensions/displaySource#property-onSessionTerminated-sinkId.

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

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

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/extensions/displaySource#property-onSessionTerminated-sinkId.

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

https://developer.chrome.com/extensions/displaySource#event-onSessionTerminated.
sourceraw docstring

tap-on-sinks-updated-eventsclj/smacro

(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/extensions/displaySource#property-onSinksUpdated-sinks.

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

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

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/extensions/displaySource#property-onSinksUpdated-sinks.

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

https://developer.chrome.com/extensions/displaySource#event-onSinksUpdated.
sourceraw docstring

terminate-sessionclj/smacro

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

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

terminate-session*cljs

(terminate-session* config sink-id)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close