ifRemoteInfo

Implemented by

NameDescription
roRemoteInfoThe roRemoteInfo component provides an interface to obtain attributes about the Roku remote control that is currently connected to the Roku device. Note that a Roku remote control device that is paired with a device, may not be the one that is currently connected (a single remote is typically connected to a device at a time).

Supported methods

GetModel(remoteIndex as Integer) as Integer

Returns the model number of the specified Roku remote control. For example, this function returns 135 for an RC135 remote that is connected to the Roku device.

Parameters

NameTypeDescription
remoteIndexIntegerThe index for a Roku remote control that is currently connected to the Roku device. In addition to specific remote index, the following values may be specified:
  • -1: The most recently used remote.
  • 0: The first connected remote (this is typically the only remote that is connected to the device).

Return Values

The model number of the specified Roku remote control, or 0 if the specified remote does not exist.

IsAwake(remoteIndex as Integer) as Boolean

Checks whether the specified Roku remote control is awake.

Parameters

NameTypeDescription
remoteIndexIntegerThe index for a Roku remote control that is currently connected to the Roku device. In addition to specific remote index, the following values may be specified:
  • -1: The most recently used remote.
  • 0: The first connected remote (this is typically the only remote that is connected to the device).

Return Values

A flag indicating whether the specified Roku remote control is awake.

HasFeature(feature as String, remoteIndex as Integer) as Boolean

Description

Checks if the specified Roku remote control supports the passed in feature string.

Parameters

NameTypeDescription
featureStringThe feature to be checked, which may be one of the following values:
  • "bluetooth"
  • "wifi"
  • "motion"
  • "audio"
  • "voicecapture"
  • "findremote"
  • "hasMuteSwitch" (Available since Roku OS 13.0; enables developers to check whether a Roku remote control includes a hands-free voice switch).
remoteIndexIntegerThe index for a Roku remote control that is currently connected to the Roku device. In addition to specific remote index, the following values may be specified:
  • -1: The most recently used remote.
  • 0: The first connected remote (this is typically the only remote that is connected to the device).

Return Values

A flag indicating whether the Roku remote control supports the passed in feature string.