chromex.ext.cast.streaming.rtp-stream — binaryage/chromex 0.6.4

clj

The chrome.cast.streaming.rtpStream API allows configuration of encoding parameters and RTP parameters used in a Cast streaming session.

Valid stream IDs are positive and non-zero.

• available since Chrome 71
• https://developer.chrome.com/extensions/cast.streaming.rtpStream

api-table clj

destroy clj/s macro

(destroy stream-id)

Destroys a Cast RTP stream.

|stream-id| - The RTP stream ID.

https://developer.chrome.com/extensions/cast.streaming.rtpStream#method-destroy.

destroy* cljs

(destroy* config stream-id)

gen-call clj

gen-wrap clj/s macro

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

get-raw-events clj/s macro

(get-raw-events stream-id)

(get-raw-events stream-id extra-data)

Get raw events for a stream in the current session.

|stream-id| - Stream to get events for. |extra-data| - Extra data to attach to the log, e.g. system info or experiment tags, in key-value JSON string format.

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

|raw-events| - compressed serialized raw bytes containing raw events recorded for a stream. The compression is in gzip format. The serialization format can be found at media/cast/logging/log_serializer.cc.

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/cast.streaming.rtpStream#method-getRawEvents.

get-raw-events* cljs

(get-raw-events* config stream-id extra-data)

get-stats clj/s macro

(get-stats stream-id)

Get stats for a stream in the current session.

|stream-id| - Stream to get stats for.

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

|stats| - https://developer.chrome.com/extensions/cast.streaming.rtpStream#property-callback-stats.

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/cast.streaming.rtpStream#method-getStats.

get-stats* cljs

(get-stats* config stream-id)

get-supported-params clj/s macro

(get-supported-params stream-id)

Returns an array of supported parameters with default values. This includes a list of supported codecs on this platform and corresponding encoding and RTP parameters.

|stream-id| - The RTP stream ID.

https://developer.chrome.com/extensions/cast.streaming.rtpStream#method-getSupportedParams.

get-supported-params* cljs

(get-supported-params* config stream-id)

on-error* cljs

(on-error* config channel & args)

on-started* cljs

(on-started* config channel & args)

on-stopped* cljs

(on-stopped* config channel & args)

start clj/s macro

(start stream-id params)

Activates the RTP stream by providing the parameters.

|stream-id| - The RTP stream ID. |params| - Parameters set for this stream.

https://developer.chrome.com/extensions/cast.streaming.rtpStream#method-start.

start* cljs

(start* config stream-id params)

stop clj/s macro

(stop stream-id)

Stops activity on the specified stream.

|stream-id| - The RTP stream ID.

https://developer.chrome.com/extensions/cast.streaming.rtpStream#method-stop.

stop* cljs

(stop* config stream-id)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.cast.streaming.rtp-stream namespace.

tap-on-error-events clj/s macro

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

Event fired when a Cast RTP stream has error.

Events will be put on the |channel| with signature [::on-error [stream-id error-string]] where:

|stream-id| - The ID of the RTP stream. |error-string| - The error info.

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

https://developer.chrome.com/extensions/cast.streaming.rtpStream#event-onError.

tap-on-started-events clj/s macro

(tap-on-started-events channel & args)

Event fired when a Cast RTP stream has started.

Events will be put on the |channel| with signature [::on-started [stream-id]] where:

|stream-id| - The ID of the RTP stream.

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

https://developer.chrome.com/extensions/cast.streaming.rtpStream#event-onStarted.

tap-on-stopped-events clj/s macro

(tap-on-stopped-events channel & args)

Event fired when a Cast RTP stream has stopped.

Events will be put on the |channel| with signature [::on-stopped [stream-id]] where:

|stream-id| - The ID of the RTP stream.

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

https://developer.chrome.com/extensions/cast.streaming.rtpStream#event-onStopped.

toggle-logging clj/s macro

(toggle-logging stream-id enable)

Enables / disables logging for a stream.

|stream-id| - https://developer.chrome.com/extensions/cast.streaming.rtpStream#property-toggleLogging-streamId. |enable| - If true, enables logging. Otherwise disables logging.

https://developer.chrome.com/extensions/cast.streaming.rtpStream#method-toggleLogging.

toggle-logging* cljs

(toggle-logging* config stream-id enable)