usb_protocol.types.descriptors.uac3 module

Descriptors for USB Audio Class Devices (UAC), Release 3

[Audio30] refers to “Universal Serial Bus Device Class Definition for Audio Devices”, Release 3.0, September 22, 2016 [Frmts30] refers to “Universal Serial Bus Device Class Definition for Audio Data Formats”, Release 3.0, September 22, 2016 [TermT30] refers to “Universal Serial Bus Device Class Definition for Terminal Types”, Release 3.0, May 31, 2006

NOTE: This is not complete yet and will be extended as needed

class usb_protocol.types.descriptors.uac3.AmbisonicComponentOrderingConventionTypes(value)[source]

Bases: IntEnum

An enumeration.

AMBISONIC_CHANNEL_NUMBER_ACN = 1

FURSE_MALHAM = 2

ORD_TYPE_UNDEFINED = 0

SINGLE_INDEX_DESIGNATION_SID = 3

class usb_protocol.types.descriptors.uac3.AmbisonicNormalizationTypes(value)[source]

Bases: IntEnum

An enumeration.

MAX_N = 1

N2D = 5

N3D = 3

NORM_TYPE_UNDEFINED = 0

SN2D = 4

SN3D = 2

class usb_protocol.types.descriptors.uac3.AudioClassSpecificACInterfaceDescriptorSubtypes(value)[source]

Bases: IntEnum

An enumeration.

AC_DESCRIPTOR_UNDEFINED = 0

CLOCK_MULTIPLIER = 13

CLOCK_SELECTOR = 12

CLOCK_SOURCE = 11

CONNECTORS = 15

EFFECT_UNIT = 8

EXTENDED_TERMINAL = 4

EXTENSION_UNIT = 10

FEATURE_UNIT = 7

HEADER = 1

INPUT_TERMINAL = 2

MIXER_UNIT = 5

OUTPUT_TERMINAL = 3

POWER_DOMAIN = 16

PROCESSING_UNIT = 9

SAMPLE_RATE_CONVERTER = 14

SELECTOR_UNIT = 6

class usb_protocol.types.descriptors.uac3.AudioClassSpecificASInterfaceDescriptorSubtypes(value)[source]

Bases: IntEnum

An enumeration.

AS_DESCRIPTOR_UNDEFINED = 0

AS_GENERAL = 1

AS_VALID_FREQ_RANGE = 2

class usb_protocol.types.descriptors.uac3.AudioClassSpecificEndpointDescriptorSubtypes(value)[source]

Bases: IntEnum

An enumeration.

DESCRIPTOR_UNDEFINED = 0

EP_GENERAL = 1

class usb_protocol.types.descriptors.uac3.AudioClassSpecificRequestCodes(value)[source]

Bases: IntEnum

An enumeration.

CUR = 1

HIGH_CAPABILITY_DESCRIPTOR = 6

INTEN = 4

MEM = 3

RANGE = 2

REQUEST_CODE_UNDEFINED = 0

STRING = 5

class usb_protocol.types.descriptors.uac3.AudioClassSpecificStandardDescriptorTypes(value)[source]

Bases: IntEnum

An enumeration.

CS_CLUSTER = 38

CS_CONFIGURATION = 34

CS_DEVICE = 33

CS_ENDPOINT = 37

CS_INTERFACE = 36

CS_STRING = 35

CS_UNDEFINED = 32

class usb_protocol.types.descriptors.uac3.AudioClassSpecificStringDescriptorSubtypes(value)[source]

Bases: IntEnum

An enumeration.

SUBTYPE_UNDEFINED = 0

class usb_protocol.types.descriptors.uac3.AudioControlInterfaceControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

AC_ACTIVE_INTERFACE_CONTROL = 1

AC_CONTROL_UNDEFINED = 0

AC_POWER_DOMAIN_CONTROL = 2

class usb_protocol.types.descriptors.uac3.AudioDataFormats(value)[source]

Bases: IntEnum

An enumeration.

AC4 = 2147483648

AC_3 = 256

ALAW = 8

ATRAC = 262144

ATRAC2_3 = 524288

DRA = 134217728

DSD = 32

DTS_I = 32768

DTS_II = 65536

DTS_III = 131072

DTS_IV = 8388608

E_AC_3 = 2097152

IEEE_FLOAT = 4

MAT = 4194304

MPEG_1_Layer1 = 512

MPEG_1_Layer2_3 = 1024

MPEG_2_AAC_ADTS = 4096

MPEG_2_EXT = 2048

MPEG_2_Layer1_LS = 8192

MPEG_2_Layer2_3_LS = 16384

MPEG_2_NOEXT = 1024

MPEG_4_AAC_ELD = 4294967296

MPEG_4_AAC_LC = 67108864

MPEG_4_AAC_LC_SURROUND = 536870912

MPEG_4_HE_AAC = 16777216

MPEG_4_HE_AAC_SURROUND = 268435456

MPEG_4_HE_AAC_V2 = 33554432

MPEG_H_3D_AUDIO = 1073741824

MULAW = 16

PCM = 1

PCM8 = 2

PCM_IEC60958 = 128

RAW_DATA = 64

WMA = 1048576

class usb_protocol.types.descriptors.uac3.AudioFunctionCategoryCodes(value)[source]

Bases: IntEnum

An enumeration.

AUDIO_VIDEO = 11

CONTROL_PANEL = 12

CONVERTER = 6

DESKTOP_SPEAKER = 1

FUNCTION_SUBCLASS_UNDEFINED = 0

GENERIC_SPEAKER = 14

HEADPHONE = 13

HEADSET = 4

HEADSET_ADAPTER = 15

HOME_THEATER = 2

IO_BOX = 8

MICROPHONE = 3

MUSICAL_INSTRUMENT = 9

OTHER = 255

PRO_AUDIO = 10

SPEAKERPHONE = 16

TELEPHONE = 5

VOICE_SOUND_RECORDER = 7

class usb_protocol.types.descriptors.uac3.AudioFunctionClassCode(value)[source]

Bases: IntEnum

An enumeration.

AUDIO_FUNCTION = 1

class usb_protocol.types.descriptors.uac3.AudioFunctionProtocolCodes(value)[source]

Bases: IntEnum

An enumeration.

AF_VERSION_01_00 = 0

AF_VERSION_02_00 = 32

AF_VERSION_03_00 = 48

FUNCTION_PROTOCOL_UNDEFINED = 0

class usb_protocol.types.descriptors.uac3.AudioFunctionSubclassCodes(value)[source]

Bases: IntEnum

An enumeration.

FULL_ADC_3_0 = 1

FUNCTION_SUBCLASS_UNDEFINED = 0

GENERIC_IO = 32

HEADPHONE = 33

HEADSET = 36

HEADSET_ADAPTER = 37

MICROPHONE = 35

SPEAKER = 34

SPEAKERPHONE = 38

class usb_protocol.types.descriptors.uac3.AudioInterfaceClassCode(value)[source]

Bases: IntEnum

An enumeration.

AUDIO = 1

class usb_protocol.types.descriptors.uac3.AudioInterfaceProtocolCodes(value)[source]

Bases: IntEnum

An enumeration.

IP_VERSION_01_00 = 0

IP_VERSION_02_00 = 32

IP_VERSION_03_00 = 48

class usb_protocol.types.descriptors.uac3.AudioInterfaceSubclassCodes(value)[source]

Bases: IntEnum

An enumeration.

AUDIO_CONTROL = 1

AUDIO_STREAMING = 2

INTERFACE_SUBCLASS_UNDEFINED = 0

MIDI_STREAMING = 3

class usb_protocol.types.descriptors.uac3.AudioStreamingInterfaceControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

AS_ACT_ALT_SETTING_CONTROL = 1

AS_AUDIO_DATA_FORMAT_CONTROL = 3

AS_CONTROL_UNDEFINED = 0

AS_VAL_ALT_SETTINGS_CONTROL = 2

class usb_protocol.types.descriptors.uac3.BidirectionalTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

BIDIRECTIONAL_UNDEFINED = 1024

ECHO_CANCELING_SPEAKERPHONE = 1029

ECHO_SUPPRESSING_SPEAKERPHONE = 1028

HANDSET = 1025

HEADSET = 1026

class usb_protocol.types.descriptors.uac3.ChannelPurposeDefinitions(value)[source]

Bases: IntEnum

An enumeration.

AMBIENT = 4

GENERIC_AUDIO = 1

NON_AUDIO = 255

PURPOSE_UNDEFINED = 0

REFERENCE = 5

SPEECH = 3

ULTRASONIC = 6

VIBROKINETIC = 7

VOICE = 2

class usb_protocol.types.descriptors.uac3.ClockMultiplierControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

CM_CONTROL_UNDEFINED = 0

CM_DENOMINATOR_CONTROL = 2

CM_NUMERATOR_CONTROL = 1

class usb_protocol.types.descriptors.uac3.ClockSelectorControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

CX_CLOCK_SELECTOR_CONTROL = 1

CX_CONTROL_UNDEFINED = 0

class usb_protocol.types.descriptors.uac3.ClockSourceControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

CS_CLOCK_VALID_CONTROL = 2

CS_CONTROL_UNDEFINED = 0

CS_SAM_FREQ_CONTROL = 1

class usb_protocol.types.descriptors.uac3.ClusterDescriptorSegmentTypes(value)[source]

Bases: IntEnum

An enumeration.

CHANNEL_AMBISONIC = 33

CHANNEL_DESCRIPTION = 34

CHANNEL_INFORMATION = 32

CHANNEL_VENDOR_DEFINED = 254

CLUSTER_DESCRIPTION = 1

CLUSTER_VENDOR_DEFINED = 31

END_SEGMENT = 255

SEGMENT_UNDEFINED = 0

class usb_protocol.types.descriptors.uac3.ClusterDescriptorSubtypes(value)[source]

Bases: IntEnum

An enumeration.

SUBTYPE_UNDEFINED = 0

class usb_protocol.types.descriptors.uac3.ConnectorTypes(value)[source]

Bases: IntEnum

An enumeration.

BANANA = 9

BINDING_POST = 10

BNC = 8

DIN = 14

DP = 24

D_SUB = 26

EUROBLOCK = 16

HDMI = 21

LIGHTNING = 28

MINI_DIN = 15

MINI_DP = 25

Micro_HDMI = 23

Mini_HDMI = 22

OPTICAL_3_5MM_COMBO_CONNECTOR = 6

PHONE_CONNECTOR_2_5_MM = 1

PHONE_CONNECTOR_3_5_MM = 2

PHONE_CONNECTOR_6_35_MM = 3

RCA = 7

RJ_11 = 18

RJ_45 = 19

SCREW_TYPE = 13

SPEAKON = 11

SPRING_CLIP = 12

THUNDERBOLT = 27

TOSLINK = 20

UNDEFINED = 0

USB_3_0_MICRO_B = 35

USB_MICRO_AB = 34

USB_MICRO_B = 33

USB_MINI_B = 32

USB_STANDARD_A = 30

USB_STANDARD_B = 31

USB_TYPE_C = 17

WIRELESS = 29

XLR = 5

XLR_6_35MM_COMBO_CONNECTOR = 4

class usb_protocol.types.descriptors.uac3.DynamicRangeCompressorEffectUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

DR_ATTACK_TIME_CONTROL = 5

DR_COMPRESSION_RATE_CONTROL = 2

DR_CONTROL_UNDEFINED = 0

DR_ENABLE_CONTROL = 1

DR_LATENCY_CONTROL = 9

DR_MAXAMPL_CONTROL = 3

DR_OVERFLOW_CONTROL = 8

DR_RELEASE_TIME_CONTROL = 6

DR_THRESHOLD_CONTROL = 4

DR_UNDERFLOW_CONTROL = 7

class usb_protocol.types.descriptors.uac3.EffectUnitEffectTypes(value)[source]

Bases: IntEnum

An enumeration.

DYN_RANGE_COMP_EFFECT = 4

EFFECT_UNDEFINED = 0

MOD_DELAY_EFFECT = 3

PARAM_EQ_SECTION_EFFECT = 1

REVERBERATION_EFFECT = 2

class usb_protocol.types.descriptors.uac3.EmbeddedFunctionTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

ANALOG_TAPE = 1799

CABLE_TUNER_AUDIO = 1806

CD_PLAYER = 1795

DAT = 1796

DCC = 1797

DRUMS_RHYTHM = 1814

DSS_AUDIO = 1807

DVD_AUDIO = 1803

EMBEDDED_UNDEFINED = 1792

EQUALIZATION_NOISE = 1794

GUITAR = 1813

MULTI_TRACK_RECORDER = 1810

OTHER_MUSICAL_INSTRUMENT = 1815

PHONOGRAPH = 1800

PIANO = 1812

RADIO_RECEIVER = 1808

RADIO_TRANSMITTER = 1809

SATELLITE_RECEIVER_AUDIO = 1805

SYNTHESIZER = 1811

TV_TUNER_AUDIO = 1804

VCR_AUDIO = 1801

VIDEO_DISC_AUDIO = 1802

class usb_protocol.types.descriptors.uac3.EndpointControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

EP_CONTROL_UNDEFINED = 0

EP_DATA_OVERRUN_CONTROL = 2

EP_DATA_UNDERRUN_CONTROL = 3

EP_PITCH_CONTROL = 1

class usb_protocol.types.descriptors.uac3.ExtendedTerminalSegmentTypes(value)[source]

Bases: IntEnum

An enumeration.

CHANNEL_BANDWIDTH = 32

CHANNEL_MAGNITUDE_PHASE_RESPONSE = 34

CHANNEL_MAGNITUDE_RESPONSE = 33

CHANNEL_POSITION_R_THETA_PHI = 36

CHANNEL_POSITION_XYZ = 35

CHANNEL_VENDOR_DEFINED = 254

END_SEGMENT = 255

SEGMENT_UNDEFINED = 0

TERMINAL_VENDOR_DEFINED = 31

class usb_protocol.types.descriptors.uac3.ExtensionUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

XU_CONTROL_UNDEFINED = 0

XU_LATENCY_CONTROL = 3

XU_OVERFLOW_CONTROL = 2

XU_UNDERFLOW_CONTROL = 1

class usb_protocol.types.descriptors.uac3.ExternalTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

ADAT_LIGHTPIPE = 1544

ANALOG_CONNECTOR = 1537

DIGITAL_AUDIO_INTERFACE = 1538

EXTERNAL_UNDEFINED = 1536

IEEE_1394_DA_STREAM = 1542

IEEE_1394_DV_STREAM_SOUNDTRACK = 1543

LINE_CONNECTOR = 1539

MADI = 1546

SPDIF_INTERFACE = 1541

TDIF = 1545

class usb_protocol.types.descriptors.uac3.FeatureUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

FU_AUTOMATIC_GAIN_CONTROL = 7

FU_BASS_BOOST_CONTROL = 9

FU_BASS_CONTROL = 3

FU_CONTROL_UNDEFINED = 0

FU_DELAY_CONTROL = 8

FU_GRAPHIC_EQUALIZER_CONTROL = 6

FU_INPUT_GAIN_CONTROL = 11

FU_INPUT_GAIN_PAD_CONTROL = 12

FU_LATENCY_CONTROL = 16

FU_LOUDNESS_CONTROL = 10

FU_MID_CONTROL = 4

FU_MUTE_CONTROL = 1

FU_OVERFLOW_CONTROL = 15

FU_PHASE_INVERTER_CONTROL = 13

FU_TREBLE_CONTROL = 5

FU_UNDERFLOW_CONTROL = 14

FU_VOLUME_CONTROL = 2

class usb_protocol.types.descriptors.uac3.InputTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

DESKTOP_MICROPHONE = 514

INPUT_UNDEFINED = 512

MICROPHONE = 513

MICROPHONE_ARRAY = 517

OMNI_DIRECTIONAL_MICROPHONE = 516

PERSONAL_MICROPHONE = 515

PROCESSING_MICROPHONE_ARRAY = 518

class usb_protocol.types.descriptors.uac3.MixerControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

MU_CONTROL_UNDEFINED = 0

MU_LATENCY_CONTROL = 4

MU_MIXER_CONTROL = 1

MU_OVERFLOW_CONTROL = 3

MU_UNDERFLOW_CONTROL = 2

class usb_protocol.types.descriptors.uac3.ModulationDelayEffectUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

MD_BALANCE_CONTROL = 2

MD_CONTROL_UNDEFINED = 0

MD_DEPTH_CONTROL = 4

MD_ENABLE_CONTROL = 1

MD_FEEDBACK_CONTROL = 6

MD_LATENCY_CONTROL = 9

MD_OVERFLOW_CONTROL = 8

MD_RATE_CONTROL = 3

MD_TIME_CONTROL = 5

MD_UNDERFLOW_CONTROL = 7

class usb_protocol.types.descriptors.uac3.OutputTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

COMMUNICATION_SPEAKER = 774

DESKTOP_SPEAKER = 772

HEADPHONES = 770

LOW_FREQUENCY_EFFECTS_SPEAKER = 775

OUTPUT_UNDEFINED = 768

ROOM_SPEAKER = 773

SPEAKER = 769

class usb_protocol.types.descriptors.uac3.ParametricEqualizerSectionEffectUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

PE_CENTERFREQ_CONTROL = 2

PE_CONTROL_UNDEFINED = 0

PE_ENABLE_CONTROL = 1

PE_GAIN_CONTROL = 4

PE_LATENCY_CONTROL = 7

PE_OVERFLOW_CONTROL = 6

PE_QFACTOR_CONTROL = 3

PE_UNDERFLOW_CONTROL = 5

class usb_protocol.types.descriptors.uac3.ProcessingUnitProcessTypes(value)[source]

Bases: IntEnum

An enumeration.

MULTI_FUNCTION_PROCESS = 3

PROCESS_UNDEFINED = 0

STEREO_EXTENDER_PROCESS = 2

UP_DOWNMIX_PROCESS = 1

class usb_protocol.types.descriptors.uac3.ReverberationEffectUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

RV_CONTROL_UNDEFINED = 0

RV_DENSITY_CONTROL = 7

RV_ENABLE_CONTROL = 1

RV_FEEDBACK_CONTROL = 5

RV_HIFREQ_ROLLOFF_CONTROL = 8

RV_LATENCY_CONTROL = 11

RV_LEVEL_CONTROL = 3

RV_OVERFLOW_CONTROL = 10

RV_PREDELAY_CONTROL = 6

RV_TIME_CONTROL = 4

RV_TYPE_CONTROL = 2

RV_UNDERFLOW_CONTROL = 9

class usb_protocol.types.descriptors.uac3.SelectorControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

SU_CONTROL_UNDEFINED = 0

SU_LATENCY_CONTROL = 2

SU_SELECTOR_CONTROL = 1

class usb_protocol.types.descriptors.uac3.StereoExtenderProcessingUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

ST_EXT_CONTROL_UNDEFINED = 0

ST_EXT_LATENCY_CONTROL = 4

ST_EXT_OVERFLOW_CONTROL = 3

ST_EXT_UNDERFLOW_CONTROL = 2

ST_EXT_WIDTH_CONTROL = 1

class usb_protocol.types.descriptors.uac3.TelephonyTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

DOWN_LINE_PHONE = 1283

PHONE_LINE = 1281

TELEPHONE = 1282

TELEPHONY_UNDEFINED = 1280

class usb_protocol.types.descriptors.uac3.TerminalControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

TE_CONTROL_UNDEFINED = 0

TE_INSERTION_CONTROL = 1

TE_LATENCY_CONTROL = 5

TE_OVERFLOW_CONTROL = 4

TE_OVERLOAD_CONTROL = 2

TE_UNDERFLOW_CONTROL = 3

class usb_protocol.types.descriptors.uac3.USBTerminalTypes(value)[source]

Bases: IntEnum

An enumeration.

USB_STREAMING = 257

USB_UNDEFINED = 256

USB_VENDOR_SPECIFIC = 511

class usb_protocol.types.descriptors.uac3.UpDownMixProcessingUnitControlSelectors(value)[source]

Bases: IntEnum

An enumeration.

UD_CONTROL_UNDEFINED = 0

UD_LATENCY_CONTROL = 4

UD_MODE_SELECT_CONTROL = 1

UD_OVERFLOW_CONTROL = 3

UD_UNDERFLOW_CONTROL = 2