Pipe_BoundEndpointNumber() has been renamed to Pipe_GetBoundEndpointAddress(), and...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / Audio.h
index 0ceaf88..7e9a48d 100644 (file)
 */\r
 \r
 /** \file\r
- *  \brief Host mode driver for the library USB Audio Class driver.\r
+ *  \brief Host mode driver for the library USB Audio 1.0 Class driver.\r
  *\r
- *  Host mode driver for the library USB Audio Class driver.\r
+ *  Host mode driver for the library USB Audio 1.0 Class driver.\r
  *\r
  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver\r
  *        dispatch header located in LUFA/Drivers/USB.h.\r
  */\r
 \r
 /** \ingroup Group_USBClassAudio\r
- *  \defgroup Group_USBClassAudioHost Audio Class Host Mode Driver\r
+ *  \defgroup Group_USBClassAudioHost Audio 1.0 Class Host Mode Driver\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Host/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>\r
  *\r
  *  \section Sec_ModDescription Module Description\r
- *  Host Mode USB Class driver framework interface, for the Audio USB Class driver.\r
+ *  Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.\r
  *\r
  *  @{\r
  */\r
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.\r
                         */\r
-                       uint8_t AUDIO_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+                       uint8_t Audio_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
                                                              bool EnableStreaming);\r
 \r
+                       /** Gets or sets the specified property of a streaming audio class endpoint that is bound to a pipe in the given\r
+                        *  class instance.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.\r
+                        *  \param[in]     DataPipeIndex       Index of the data pipe whose bound endpoint is to be altered.\r
+                        *  \param[in]     EndpointProperty    Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.\r
+                        *  \param[in]     EndpointControl     Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.\r
+                        *  \param[in,out] DataLength          For SET operations, the length of the parameter data to set. For GET operations, the maximum\r
+                        *                                     length of the retrieved data.\r
+                        *  \param[in,out] Data                Pointer to a location where the parameter data is stored for SET operations, or where\r
+                        *                                     the retrieved data is to be stored for GET operations.\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.\r
+                        */                     \r
+                       uint8_t Audio_GetSetEndpointProperty(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+                                                            const uint8_t DataPipeIndex,\r
+                                                            const uint8_t EndpointProperty,\r
+                                                            const uint8_t EndpointControl,\r
+                                                            uint16_t* const DataLength,\r
+                                                            uint8_t* Data);\r
+\r
                /* Inline Functions: */\r
                        /** General management task for a given Audio host class interface, required for the correct operation of\r
                         *  the interface. This should be called frequently in the main program loop, before the master USB management task\r