AwesomeStudioPedal
A programmable, multi-profile foot controller for DAWs, score readers, and studio automation
Loading...
Searching...
No Matches
SendMediaKeyAction Class Reference

Sends a media key report via BLE keyboard. More...

#include <send_action.h>

Inheritance diagram for SendMediaKeyAction:
SendAction Action

Public Member Functions

Action::Type getType () const override
 Gets the type of this action.
 
const MediaKeyReportgetKey () const
 Gets the media key report to be sent.
 
void send () override
 Executes the media key send action.
 
 SendMediaKeyAction (IBleKeyboard *bleKeyboard, const MediaKeyReport k)
 Constructs a SendMediaKeyAction.
 
- Public Member Functions inherited from SendAction
void execute () override
 Executes the send action.
 
bool isSendAction () const override
 Checks if this action is a send action.
 
 ~SendAction () override=default
 
- Public Member Functions inherited from Action
void setName (const std::string &n)
 
const std::string & getName () const
 
bool hasName () const
 
virtual uint32_t getDelay () const
 
virtual bool isInProgress () const
 Returns true if the action is currently in progress (e.g.
 
virtual void getJsonProperties (JsonObject &json) const
 
virtual ~Action ()=default
 

Additional Inherited Members

- Public Types inherited from Action
enum class  Type : uint8_t {
  Unknown , SendString , SendChar , SendKey ,
  SendMediaKey , SerialOutput , Delayed
}
 
- Protected Member Functions inherited from SendAction
 SendAction (IBleKeyboard *bleKeyboard)
 Constructs a SendAction.
 
- Protected Attributes inherited from SendAction
IBleKeyboardbleKeyboard
 Pointer to BLE keyboard interface.
 

Detailed Description

Sends a media key report via BLE keyboard.

Definition at line 188 of file send_action.h.

Constructor & Destructor Documentation

◆ SendMediaKeyAction()

SendMediaKeyAction::SendMediaKeyAction ( IBleKeyboard bleKeyboard,
const MediaKeyReport  k 
)

Constructs a SendMediaKeyAction.

Parameters
bleKeyboardPointer to BLE keyboard interface
kMedia key report to send

Definition at line 33 of file send_action.cpp.

Member Function Documentation

◆ getKey()

const MediaKeyReport & SendMediaKeyAction::getKey ( ) const
inline

Gets the media key report to be sent.

Returns
The media key report

Definition at line 213 of file send_action.h.

◆ getType()

Action::Type SendMediaKeyAction::getType ( ) const
inlineoverridevirtual

Gets the type of this action.

Returns
Action type

Reimplemented from Action.

Definition at line 199 of file send_action.h.

◆ send()

void SendMediaKeyAction::send ( )
overridevirtual

Executes the media key send action.

Sends the configured media key report to the BLE keyboard.

Implements SendAction.

Definition at line 45 of file send_action.cpp.


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