---
title: setIdle
framework: hiddriverkit
role: symbol
role_heading: Instance Method
path: hiddriverkit/iouserusbhosthiddevice/setidle
---

# setIdle

Sets the device’s idle time.

## Declaration

```occ
virtual kern_return_t setIdle(uint16_t idleTimeMs);
```

## Parameters

- `idleTimeMs`: The idle time in milliseconds.

## Return Value

Return Value kIOReturnSuccess on success, or another value if an error occurs. See Error Codes.

## Discussion

Discussion The idle rate determines how often a device resends data that hasn’t changed since the last report. Use this method to limit the reporting frequency of an interrupt IN endpoint.

## See Also

### Configuring the Device

- [setProtocol](hiddriverkit/iouserusbhosthiddevice/setprotocol.md)
- [setIdlePolicy](hiddriverkit/iouserusbhosthiddevice/setidlepolicy.md)
- [setProperty](hiddriverkit/iouserusbhosthiddevice/setproperty.md)
- [reset](hiddriverkit/iouserusbhosthiddevice/reset.md)
- [USBIdlePolicyType](hiddriverkit/usbidlepolicytype.md)