chromex.app.audio — binaryage/chromex 0.9.3

clj

The chrome.audio API is provided to allow users to get information about and control the audio devices attached to the system. This API is currently only available in kiosk mode for ChromeOS.

• available since Chrome 59
• https://developer.chrome.com/apps/audio

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-devices clj/s macro

(get-devices)

(get-devices filter)

Gets a list of audio devices filtered based on |filter|.

|filter| - Device properties by which to filter the list of returned audio devices. If the filter is not set or set to {}, returned device list will contain all available audio devices.

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

|devices| - https://developer.chrome.com/apps/audio#property-callback-devices.

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/audio#method-getDevices.

get-devices* cljs

(get-devices* config filter)

get-mute clj/s macro

(get-mute stream-type)

Gets the system-wide mute state for the specified stream type.

|stream-type| - Stream type for which mute state should be fetched.

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

|value| - https://developer.chrome.com/apps/audio#property-callback-value.

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/audio#method-getMute.

get-mute* cljs

(get-mute* config stream-type)

on-device-list-changed* cljs

(on-device-list-changed* config channel & args)

on-level-changed* cljs

(on-level-changed* config channel & args)

on-mute-changed* cljs

(on-mute-changed* config channel & args)

set-active-devices clj/s macro

(set-active-devices ids)

Sets lists of active input and/or output devices.

|ids| - Specifies IDs of devices that should be active. If either the input or output list is not set, devices in that category are unaffected. It is an error to pass in a non-existent device ID. NOTE: While the method signature allows device IDs to be passed as a list of strings, this method of setting active devices is deprecated and should not be relied upon to work. Please use 'DeviceIdLists' instead.

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/audio#method-setActiveDevices.

set-active-devices* cljs

(set-active-devices* config ids)

set-mute clj/s macro

(set-mute stream-type is-muted)

Sets mute state for a stream type. The mute state will apply to all audio devices with the specified audio stream type.

|stream-type| - Stream type for which mute state should be set. |is-muted| - New mute value.

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/audio#method-setMute.

set-mute* cljs

(set-mute* config stream-type is-muted)

set-properties clj/s macro

(set-properties id properties)

Sets the properties for the input or output device.

|id| - https://developer.chrome.com/apps/audio#property-setProperties-id. |properties| - https://developer.chrome.com/apps/audio#property-setProperties-properties.

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/audio#method-setProperties.

set-properties* cljs

(set-properties* config id properties)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-device-list-changed-events clj/s macro

(tap-on-device-list-changed-events channel & args)

Fired when audio devices change, either new devices being added, or existing devices being removed.

Events will be put on the |channel| with signature [::on-device-list-changed [devices]] where:

|devices| - List of all present audio devices after the change.

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

https://developer.chrome.com/apps/audio#event-onDeviceListChanged.

tap-on-level-changed-events clj/s macro

(tap-on-level-changed-events channel & args)

Fired when sound level changes for an active audio device.

Events will be put on the |channel| with signature [::on-level-changed [event]] where:

|event| - https://developer.chrome.com/apps/audio#property-onLevelChanged-event.

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

https://developer.chrome.com/apps/audio#event-onLevelChanged.

tap-on-mute-changed-events clj/s macro

(tap-on-mute-changed-events channel & args)

Fired when the mute state of the audio input or output changes. Note that mute state is system-wide and the new value applies to every audio device with specified stream type.

Events will be put on the |channel| with signature [::on-mute-changed [event]] where:

|event| - https://developer.chrome.com/apps/audio#property-onMuteChanged-event.

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

https://developer.chrome.com/apps/audio#event-onMuteChanged.