Component: USB Speaker (Misc): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd.
Version	1.3
Category	Misc

USB Speaker component

Component to create a USB System Speaker. Compatible with USB enabled microcontroller devices. Currently only compatible with the 16-bit PIC range of devices.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_USBSpeaker.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_USBSpeaker.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Initialise

	Initialise
Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout.
- BYTE	Return

IsPlaybackEnabled

	IsPlaybackEnabled

- BYTE	Return

ReadData

	ReadData
Reads a single 16-bit data value from the audio buffer
- UINT	Return

UsbRx

	UsbRx
Receives the data from the USB connection
- BYTE	Return

Property reference

	Properties
	USB Properties
	Vendor ID
USB VID
	Product ID
USB PID
	Device Name
USB Device Name
	Manufacturer
USB Manufacturer
	Major Version
USB Major Version Number
	Minor Version
USB Minor Version Number
	Sample Rate

	Enumeration Timeout
Specifies if the enumeration (Initialise function) can timeout if taking too long.
	Simulation
	Label
Text displayed on the I/O flasher comms component.

@@ Line 66: / Line 66: @@
 ===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Starts up the USB communications and attempts to enumerate. Returns 0 for a successful startup or 255 for a enumeration timeout.&nbsp;
@@ Line 80: / Line 80: @@
 ===IsPlaybackEnabled===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsPlaybackEnabled'''
+| width="90%" class="mtx-class-macrohead" | '''IsPlaybackEnabled'''
 |-
 | colspan="2" | &nbsp;
@@ Line 94: / Line 94: @@
 ===ReadData===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadData'''
+| width="90%" class="mtx-class-macrohead" | '''ReadData'''
 |-
 | colspan="2" | Reads a single 16-bit data value from the audio buffer&nbsp;
@@ Line 108: / Line 108: @@
 ===UsbRx===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UsbRx'''
+| width="90%" class="mtx-class-macrohead" | '''UsbRx'''
 |-
 | colspan="2" | Receives the data from the USB connection&nbsp;
@@ Line 123: / Line 123: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | USB Properties
+| width="90%" class="mtx-class-propfolder" | USB Properties
 |-
 |-
@@ Line 173: / Line 173: @@
 | colspan="2" | Specifies if the enumeration (Initialise function) can timeout if taking too long.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)