This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

usb-audio-hs

Vendor: Generic or vendor-independent

Description

USB Audio headset specific fields.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

mic-resolution

int

Default value: 16

Legal values: 8, 16, 24, 32

mic-sync-type

string

Type of endpoint synchronization for IN devices.
Default value is Synchronous.
Adaptive is not supported.

Default value: Synchronous

Legal values: 'No Synchronization', 'Asynchronous', 'Adaptive', 'Synchronous'

mic-sample-rate-hz

int

Default value: 48000

mic-polling-interval

int

Default value: 1

hp-resolution

int

Default value: 16

Legal values: 8, 16, 24, 32

hp-sample-rate-hz

int

Default value: 48000

hp-polling-interval

int

Default value: 1

mic-channel-l

boolean

Enable (l) channel.

mic-channel-r

boolean

Enable (r) channel.

mic-channel-c

boolean

Enable (c) channel.

mic-channel-lfe

boolean

Enable (lfe) channel.

mic-channel-ls

boolean

Enable (ls) channel.

mic-channel-rs

boolean

Enable (rs) channel.

mic-channel-lc

boolean

Enable (lc) channel.

mic-channel-rc

boolean

Enable (rc) channel.

mic-channel-s

boolean

Enable (s) channel.

mic-channel-sl

boolean

Enable (sl) channel.

mic-channel-sr

boolean

Enable (sr) channel.

mic-channel-t

boolean

Enable (t) channel.

mic-channel-cfg

boolean

Enable (cfg) channel.

mic-feature-mute

boolean

Enable Mute feature.

This property is required.

mic-feature-volume

boolean

Enable Volume feature.
Currently not supported.

mic-feature-tone-control

boolean

Enable Tone Control (Bass, Mid, Treble) feature.
Currently not supported.

mic-feature-graphic-equalizer

boolean

Enable  Graphic Equalizer feature.
Currently not supported.

mic-feature-automatic-gain-control

boolean

Enable Autoamtic Gain Control feature.
Currently not supported.

mic-feature-delay

boolean

Enable Delay feature.
Currently not supported.

mic-feature-bass-boost

boolean

Enable Bass Boost feature.
Currently not supported.

mic-feature-loudness

boolean

Enable Loudness feature.
Currently not supported.

hp-channel-l

boolean

Enable (l) channel.

hp-channel-r

boolean

Enable (r) channel.

hp-channel-c

boolean

Enable (c) channel.

hp-channel-lfe

boolean

Enable (lfe) channel.

hp-channel-ls

boolean

Enable (ls) channel.

hp-channel-rs

boolean

Enable (rs) channel.

hp-channel-lc

boolean

Enable (lc) channel.

hp-channel-rc

boolean

Enable (rc) channel.

hp-channel-s

boolean

Enable (s) channel.

hp-channel-sl

boolean

Enable (sl) channel.

hp-channel-sr

boolean

Enable (sr) channel.

hp-channel-t

boolean

Enable (t) channel.

hp-channel-cfg

boolean

Enable (cfg) channel.

hp-feature-mute

boolean

Enable Mute feature.

This property is required.

hp-feature-volume

boolean

Enable Volume feature.

hp-feature-tone-control

boolean

Enable Tone Control (Bass, Mid, Treble) feature.
Currently not supported.

hp-feature-graphic-equalizer

boolean

Enable  Graphic Equalizer feature.
Currently not supported.

hp-feature-automatic-gain-control

boolean

Enable Autoamtic Gain Control feature.
Currently not supported.

hp-feature-delay

boolean

Enable Delay feature.
Currently not supported.

hp-feature-bass-boost

boolean

Enable Bass Boost feature.
Currently not supported.

hp-feature-loudness

boolean

Enable Loudness feature.
Currently not supported.

volume-max

int

attention: this attribute is a signed value.
This attribute represents the maximum volume level.
The range from +127.9961 dB (0x7FFF) down to -127.9961 dB (0x8001).
Valid range: 0 - 0xFFFF

Default value: 2560

volume-min

int

attention: this attribute is a signed value.
This attribute represents the minimum volume level.
The range from +127.9961 dB (0x7FFF) down to -127.9961 dB (0x8001).
Valid range: 0 - 0xFFFF

Default value: 47616

volume-res

int

attention: this attribute can only take positive values.
This attribute represents the volume resolution(step).
1 = 1/256 dB or 0.00390625 dB.
0x100(256) = 1dB.
Valid range: 1 - 0x7FFF

Default value: 256