JUCE: AppleRemoteDevice Class Reference

JUCE

Public Types | Public Member Functions | List of all members
AppleRemoteDevice Class Referenceabstract
juce_gui_extra » misc

Receives events from an Apple IR remote control device (Only available in OSX!). More...

`#include <juce_AppleRemote.h>`

## Public Types
enum | ButtonType { menuButton = 0 , playButton , plusButton , minusButton , rightButton , leftButton , rightButton_Long , leftButton_Long , menuButton_Long , playButtonSleepMode , switched }
| The set of buttons that may be pressed. More...

## Public Member Functions
| AppleRemoteDevice ()
virtual | ~AppleRemoteDevice ()
virtual void | buttonPressed (ButtonType buttonId, bool isDown)=0
| Override this method to receive the callback about a button press. More...
bool | start (bool inExclusiveMode)
| Starts the device running and responding to events. More...
void | stop ()
| Stops the device running. More...
bool | isActive () const
| Returns true if the device has been started successfully. More...
int | getRemoteId () const
| Returns the ID number of the remote, if it has sent one. More...
void | handleCallbackInternal ()

## Detailed Description

Receives events from an Apple IR remote control device (Only available in OSX!).

To use it, just create a subclass of this class, implementing the buttonPressed() callback, then call start() and stop() to start or stop receiving events.

## Member Enumeration Documentation

## ◆ ButtonType

enum AppleRemoteDevice::ButtonType

The set of buttons that may be pressed.

See also
  buttonPressed

Enumerator
menuButton | The menu button (if it's held for a short time).
playButton | The play button.
plusButton | The plus or volume-up button.
minusButton | The minus or volume-down button.
rightButton | The right button (if it's held for a short time).
leftButton | The left button (if it's held for a short time).
rightButton_Long | The right button (if it's held for a long time).
leftButton_Long | The menu button (if it's held for a long time).
menuButton_Long | The menu button (if it's held for a long time).
playButtonSleepMode |
switched |

## Constructor & Destructor Documentation

## ◆ AppleRemoteDevice()

AppleRemoteDevice::AppleRemoteDevice | ( |  | ) |

## ◆ ~AppleRemoteDevice()

virtual AppleRemoteDevice::~AppleRemoteDevice | ( |  | ) |
| virtual

## Member Function Documentation

## ◆ buttonPressed()

virtual void AppleRemoteDevice::buttonPressed | ( | ButtonType | buttonId,
|  | bool | isDown
| ) |  |
| pure virtual

Override this method to receive the callback about a button press.

The callback will happen on the application's message thread.

Some buttons trigger matching up and down events, in which the isDown parameter will be true and then false. Others only send a single event when the button is pressed.

## ◆ start()

bool AppleRemoteDevice::start | ( | bool | inExclusiveMode | ) |

Starts the device running and responding to events.

Returns true if it managed to open the device.

Parameters

  inExclusiveMode | if true, the remote will be grabbed exclusively for this app, and will not be available to any other part of the system. If false, it will be shared with other apps.

See also
  stop

## ◆ stop()

void AppleRemoteDevice::stop | ( |  | ) |

Stops the device running.

See also
  start

## ◆ isActive()

bool AppleRemoteDevice::isActive | ( |  | ) | const

Returns true if the device has been started successfully.

## ◆ getRemoteId()

int AppleRemoteDevice::getRemoteId | ( |  | ) | const

Returns the ID number of the remote, if it has sent one.

## ◆ handleCallbackInternal()

void AppleRemoteDevice::handleCallbackInternal | ( |  | ) |

The documentation for this class was generated from the following file:

- juce_AppleRemote.h