dispatchGetReportRequest(type:id:timeout:)

Send a get report request to the device over the transport.

Declaration

func dispatchGetReportRequest(type: HIDReportType, id: HIDReportID? = nil, timeout: Duration? = nil) async throws -> Data

Parameters

type:
The Hidreporttype of the requested report.
id:
The ID of the requested report, determined from the report descriptor. This is unnecessary if the descriptor has only one report.
timeout:
The maximum amount of time to wait for the device to receive the report before the call times out and fails. Not providing a duration causes the call to wait forever.

Mentioned in

Return Value

The data that the device returned. Reference the device’s descriptor to determine what data the device may respond with.

Discussion

Many HID devices respond to get report requests to retrieve information from the device. Exactly how a device responds to a get report request is dependent on the device specific implementation, but most devices conform to the reports that they declare in their report descriptor. This function throws if the device is seized by another client.

For more details, see Human Interface Devices (HID) Specifications and Tools.