uint16_t LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */\r
} USB_AudioStreamEndpoint_Spc_t; \r
\r
- /** Type define for an Audio Class interface configuration and state structure. This structure should be used for each Audio\r
- * Class unit within the device, and passed (per-interface) to the Audio Class driver functions so that each Audio interface\r
- * has seperate state and configuration data and can be controlled seperately.\r
+ /** Class state structure. An instance of this structure should be made for each Audio interface\r
+ * within the user application, and passed to each of the Audio class driver functions as the\r
+ * AudioInterfaceInfo parameter. The contents of this structure should be set to their correct\r
+ * values when used, or ommitted to force the library to use default values.\r
*/\r
typedef struct\r
{\r
*\r
* \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
*/\r
- bool USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ bool USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
* linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
*\r
* \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*/\r
- void USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ void USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
*\r
* \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*/\r
- void USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ void USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/** Reads the next 8-bit audio sample from the current audio interface.\r
*\r
*\r
* \return Signed 8-bit audio sample from the audio interface\r
*/\r
- int8_t USB_Audio_ReadSample8(void);\r
+ int8_t USB_Audio_ReadSample8(void);\r
\r
/** Reads the next 16-bit audio sample from the current audio interface.\r
*\r
*\r
* \return Signed 16-bit audio sample from the audio interface\r
*/\r
- int16_t USB_Audio_ReadSample16(void);\r
+ int16_t USB_Audio_ReadSample16(void);\r
\r
/** Reads the next 24-bit audio sample from the current audio interface.\r
*\r
*\r
* \return Signed 24-bit audio sample from the audio interface\r
*/\r
- int32_t USB_Audio_ReadSample24(void);\r
+ int32_t USB_Audio_ReadSample24(void);\r
\r
/** Writes the next 8-bit audio sample to the current audio interface.\r
*\r
*\r
* \param Sample Signed 8-bit audio sample\r
*/\r
- void USB_Audio_WriteSample8(int8_t Sample);\r
+ void USB_Audio_WriteSample8(int8_t Sample);\r
\r
/** Writes the next 16-bit audio sample to the current audio interface.\r
*\r
*\r
* \param Sample Signed 16-bit audio sample\r
*/\r
- void USB_Audio_WriteSample16(int16_t Sample);\r
+ void USB_Audio_WriteSample16(int16_t Sample);\r
\r
/** Writes the next 24-bit audio sample to the current audio interface.\r
*\r
*\r
* \param Sample Signed 24-bit audio sample\r
*/\r
- void USB_Audio_WriteSample24(int32_t Sample);\r
+ void USB_Audio_WriteSample24(int32_t Sample);\r
\r
/** Determines if the given audio interface is ready for a sample to be read from it.\r
*\r
*\r
* \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
*/\r
- bool USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ bool USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
*\r
*\r
* \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
*/\r
- bool USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+ bool USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r