mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
126 lines
4.7 KiB
C++
126 lines
4.7 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
#if JUCE_MAC || DOXYGEN
|
|
/**
|
|
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.
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API AppleRemoteDevice
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
AppleRemoteDevice();
|
|
virtual ~AppleRemoteDevice();
|
|
|
|
//==============================================================================
|
|
/** The set of buttons that may be pressed.
|
|
@see buttonPressed
|
|
*/
|
|
enum ButtonType
|
|
{
|
|
menuButton = 0, /**< 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
|
|
};
|
|
|
|
//==============================================================================
|
|
/** 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.
|
|
*/
|
|
virtual void buttonPressed (ButtonType buttonId, bool isDown) = 0;
|
|
|
|
//==============================================================================
|
|
/** Starts the device running and responding to events.
|
|
|
|
Returns true if it managed to open the device.
|
|
|
|
@param 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 stop
|
|
*/
|
|
bool start (bool inExclusiveMode);
|
|
|
|
/** Stops the device running.
|
|
@see start
|
|
*/
|
|
void stop();
|
|
|
|
/** Returns true if the device has been started successfully.
|
|
*/
|
|
bool isActive() const;
|
|
|
|
/** Returns the ID number of the remote, if it has sent one.
|
|
*/
|
|
int getRemoteId() const { return remoteId; }
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void handleCallbackInternal();
|
|
|
|
private:
|
|
void* device;
|
|
void* queue;
|
|
int remoteId;
|
|
|
|
bool open (bool openInExclusiveMode);
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AppleRemoteDevice)
|
|
};
|
|
|
|
#endif
|
|
|
|
} // namespace juce
|