Liking cljdoc? Tell your friends :D

chromex.app.webrtc-logging-private

clj

Use the chrome.webrtcLoggingPrivate API to control diagnostic WebRTC logging.

  • available since Chrome 36
Use the chrome.webrtcLoggingPrivate API to control diagnostic
WebRTC logging.

  * available since Chrome 36
raw docstring

api-tableclj

source

discardclj/smacro

(discard request security-origin)

Discards the log. Logging must be stopped before this function is called.

|request| - ? |security-origin| - ?

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.

Discards the log. Logging must be stopped before this function is called.

  |request| - ?
  |security-origin| - ?

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.
sourceraw docstring

discard*cljs

(discard* config request security-origin)
source

gen-callclj

source

gen-wrapclj/smacro

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

get-logs-directoryclj/smacro

(get-logs-directory)

Returns the directory entry for the 'WebRTC Logs' directory. If the directory doesn't exist yet, this will create it. If the directory cannot be created, this call will fail with a runtime error.

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

|entry| - ?

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.

Returns the directory entry for the 'WebRTC Logs' directory. If the directory doesn't exist yet, this will create it. If
the directory cannot be created, this call will fail with a runtime error.

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

  |entry| - ?

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.
sourceraw docstring

get-logs-directory*cljs

(get-logs-directory* config)
source

set-meta-dataclj/smacro

(set-meta-data request security-origin meta-data)

Sets additional custom meta data that will be uploaded along with the log. |metaData| is a dictionary of the metadata (key, value).

|request| - ? |security-origin| - ? |meta-data| - ?

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.

Sets additional custom meta data that will be uploaded along with the log. |metaData| is a dictionary of the metadata (key,
value).

  |request| - ?
  |security-origin| - ?
  |meta-data| - ?

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.
sourceraw docstring

set-meta-data*cljs

(set-meta-data* config request security-origin meta-data)
source

set-upload-on-render-closeclj/smacro

(set-upload-on-render-close request security-origin should-upload)

Sets whether the log should be uploaded automatically for the case when the render process goes away (tab is closed or crashes) and stop has not been called before that. If |shouldUpload| is true it will be uploaded, otherwise it will be discarded. The default setting is to discard it.

|request| - ? |security-origin| - ? |should-upload| - ?

Sets whether the log should be uploaded automatically for the case when the render process goes away (tab is closed or
crashes) and stop has not been called before that. If |shouldUpload| is true it will be uploaded, otherwise it will be
discarded. The default setting is to discard it.

  |request| - ?
  |security-origin| - ?
  |should-upload| - ?
sourceraw docstring

set-upload-on-render-close*cljs

(set-upload-on-render-close* config request security-origin should-upload)
source

startclj/smacro

(start request security-origin)

Starts logging. If logging has already been started for this render process, the call will be ignored. |appSessionId| is the unique session ID which will be added to the log.

|request| - ? |security-origin| - ?

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.

Starts logging. If logging has already been started for this render process, the call will be ignored. |appSessionId| is
the unique session ID which will be added to the log.

  |request| - ?
  |security-origin| - ?

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.
sourceraw docstring

start*cljs

(start* config request security-origin)
source

start-audio-debug-recordingsclj/smacro

(start-audio-debug-recordings request security-origin seconds)

Starts audio debug recordings. |seconds| indicates how many seconds of audio to record. |callback| is invoked once recording stops. If |seconds| is zero, recording will continue until stopAudioDebugRecordings() is explicitly called. In this case, |callback| is invoked once recording starts and will report that recording has not stopped. If |seconds| is negative, startAudioDebugRecordings() fails.

|request| - ? |security-origin| - ? |seconds| - ?

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

|info| - ?

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.

Starts audio debug recordings. |seconds| indicates how many seconds of audio to record. |callback| is invoked once
recording stops. If |seconds| is zero, recording will continue until stopAudioDebugRecordings() is explicitly called. In
this case, |callback| is invoked once recording starts and will report that recording has not stopped. If |seconds| is
negative, startAudioDebugRecordings() fails.

  |request| - ?
  |security-origin| - ?
  |seconds| - ?

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

  |info| - ?

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.
sourceraw docstring

start-audio-debug-recordings*cljs

(start-audio-debug-recordings* config request security-origin seconds)
source

start-event-loggingclj/smacro

(start-event-logging request
                     security-origin
                     session-id
                     max-log-size-bytes
                     output-period-ms
                     web-app-id)

Start remote-bound event logging for a specific peer connection, indicated by its session description's ID. If successful, the callback will carry the ID of the log. * |webAppId| must be a number between 1 and 99 (inclusive), which will be incorporated into the uploaded log, so as to help distinugish logs captured by different web-apps. * |outputPeriodMs

refers to the time between emissions of logs. Only non-negative values are allowed. If set to zero, logs will be produced as soon as an event occurs. If positive, events will be batched together and emitted approximately every |outputPeriodMs| ms.

|request| - ? |security-origin| - ? |session-id| - ? |max-log-size-bytes| - ? |output-period-ms| - ? |web-app-id| - ?

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| - ?

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.

Start remote-bound event logging for a specific peer connection, indicated by its session description's ID. If successful,
the callback will carry the ID of the log. * |webAppId| must be a number between 1 and 99 (inclusive), which will be
incorporated into the uploaded log, so as to help distinugish logs   captured by different web-apps. * |outputPeriodMs

refers to the time between emissions of logs.   Only non-negative values are allowed. If set to zero, logs will be
produced as soon as an event occurs. If positive, events will be   batched together and emitted approximately every
|outputPeriodMs| ms.

  |request| - ?
  |security-origin| - ?
  |session-id| - ?
  |max-log-size-bytes| - ?
  |output-period-ms| - ?
  |web-app-id| - ?

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| - ?

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.
sourceraw docstring

start-event-logging*cljs

(start-event-logging* config
                      request
                      security-origin
                      session-id
                      max-log-size-bytes
                      output-period-ms
                      web-app-id)
source

start-rtp-dumpclj/smacro

(start-rtp-dump request security-origin incoming outgoing)

Starts RTP dumping. If it has already been started for this render process, the call will be ignored.

|request| - ? |security-origin| - ? |incoming| - ? |outgoing| - ?

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.

Starts RTP dumping. If it has already been started for this render process, the call will be ignored.

  |request| - ?
  |security-origin| - ?
  |incoming| - ?
  |outgoing| - ?

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.
sourceraw docstring

start-rtp-dump*cljs

(start-rtp-dump* config request security-origin incoming outgoing)
source

stopclj/smacro

(stop request security-origin)

Stops logging. After stop has finished, either upload() or discard() should be called, otherwise the log will be kept in memory until the render process is closed or logging restarted.

|request| - ? |security-origin| - ?

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.

Stops logging. After stop has finished, either upload() or discard() should be called, otherwise the log will be kept in
memory until the render process is closed or logging restarted.

  |request| - ?
  |security-origin| - ?

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.
sourceraw docstring

stop*cljs

(stop* config request security-origin)
source

stop-audio-debug-recordingsclj/smacro

(stop-audio-debug-recordings request security-origin)

Stops audio debug recordings. |callback| is invoked once recording stops. If there is no recording in progress, stopAudioDebugRecordings() fails.

|request| - ? |security-origin| - ?

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

|info| - ?

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.

Stops audio debug recordings.  |callback| is invoked once recording stops. If there is no recording in progress,
stopAudioDebugRecordings() fails.

  |request| - ?
  |security-origin| - ?

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

  |info| - ?

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.
sourceraw docstring

stop-audio-debug-recordings*cljs

(stop-audio-debug-recordings* config request security-origin)
source

stop-rtp-dumpclj/smacro

(stop-rtp-dump request security-origin incoming outgoing)

Stops RTP dumping. After stop has finished, the dumps will be uploaded with the log if upload is called. Otherwise, the dumps will be discarded.

|request| - ? |security-origin| - ? |incoming| - ? |outgoing| - ?

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.

Stops RTP dumping. After stop has finished, the dumps will be uploaded with the log if upload is called. Otherwise, the
dumps will be discarded.

  |request| - ?
  |security-origin| - ?
  |incoming| - ?
  |outgoing| - ?

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.
sourceraw docstring

stop-rtp-dump*cljs

(stop-rtp-dump* config request security-origin incoming outgoing)
source

storeclj/smacro

(store request security-origin log-id)

Stores the current log without uploading. The log may stay around for as much as 5 days. The application has the option of supplying an id for uniquely identifying the log for later upload via a call to uploadStored().

|request| - ? |security-origin| - ? |log-id| - ?

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.

Stores the current log without uploading. The log may stay around for as much as 5 days. The application has the option of
supplying an id for uniquely identifying the log for later upload via a call to uploadStored().

  |request| - ?
  |security-origin| - ?
  |log-id| - ?

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.
sourceraw docstring

store*cljs

(store* config request security-origin log-id)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.webrtc-logging-private namespace.

Taps all valid non-deprecated events in chromex.app.webrtc-logging-private namespace.
sourceraw docstring

uploadclj/smacro

(upload request security-origin)

Uploads the log and the RTP dumps, if they exist. Logging and RTP dumping must be stopped before this function is called.

|request| - ? |security-origin| - ?

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| - ?

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.

Uploads the log and the RTP dumps, if they exist. Logging and RTP dumping must be stopped before this function is called.

  |request| - ?
  |security-origin| - ?

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| - ?

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.
sourceraw docstring

upload*cljs

(upload* config request security-origin)
source

upload-storedclj/smacro

(upload-stored request security-origin log-id)

Uploads a previously kept log that was stored via a call to store(). The caller needs to know the logId as was originally provided in the call to store().

|request| - ? |security-origin| - ? |log-id| - ?

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| - ?

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.

Uploads a previously kept log that was stored via a call to store(). The caller needs to know the logId as was originally
provided in the call to store().

  |request| - ?
  |security-origin| - ?
  |log-id| - ?

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| - ?

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.
sourceraw docstring

upload-stored*cljs

(upload-stored* config request security-origin log-id)
source

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

× close