RDK Documentation (Open Sourced RDK Components)
AampcliGet.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's license file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2022 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 /**
21  * @file AampcliGet.h
22  * @brief AampcliGet header file
23  */
24 
25 #ifndef AAMPCLIGET_H
26 #define AAMPCLIGET_H
27 
28 #include <cstring>
29 #include <priv_aamp.h>
30 #include "AampcliCommandHandler.h"
31 
32 typedef struct GetCommandInfo{
33  GetCommandInfo() : value(0), description("") {}
34  int value;
35  std::string description;
37 
38 class Get : public Command {
39 
40  public:
41  static std::vector<std::string> commands;
42  static std::map<string,getCommandInfo> getCommands;
43  static std::map<string,string> getNumCommands;
44  void addCommand(int value,string command,string description);
45  void registerGetCommands();
46  static char *getCommandRecommender(const char *text, int state);
47  void ShowHelpGet();
48  bool execute(char *cmd, PlayerInstanceAAMP *playerInstanceAamp);
49 };
50 
51 #endif // AAMPCLIGET_H
Get::registerGetCommands
void registerGetCommands()
Show help menu with aamp command line interface.
Definition: AampcliGet.cpp:251
GetCommandInfo
Definition: AampcliGet.h:32
PlayerInstanceAAMP
Player interface class for the JS pluggin.
Definition: main_aamp.h:692
priv_aamp.h
Private functions and types used internally by AAMP.
Get::ShowHelpGet
void ShowHelpGet()
Display Help menu for get.
Definition: AampcliGet.cpp:304
AampcliCommandHandler.h
AampcliCommandHandler header file.
Get
Definition: AampcliGet.h:38
Command
Definition: AampcliCommandHandler.h:35