【开源项目】智能电视及电视盒子的控制应用TVRemoteIME的接口说明

一、APP项目介绍：

APP名称：TVRemoteIME

功能说明：安卓智能电视或者安卓盒子的控制应用，可跨屏远程输入、远程遥控（代替遥控器）盒子、盒子应用及文件管理、HTTP/RTMP/MMS网络视频直播、ED2K/种子文件的视频文件边下边播

项目地址：https://github.com/kingthy/TVRemoteIME

APK包下载：https://github.com/kingthy/TVRemoteIME/raw/master/released/IMEService-release.apk

 

二、APP控制端界面截图

控制端不需要安装任何APK应用，直接在同局域网的手机、电脑或者PAD的浏览器访问操作

输入遥控：

应用管理：

 

 

文件管理：

 

 

视频直播：

 

 

三、APP核心功能介绍

1、IMEService：APP的主核心入口，继承于InputMethodService，用于实现输入服务，提供简易的QWERT键盘UI，核心的遥控功能也是通过此服务来实现的。

2、RemoteServer: APP的Web API服务，通过NanoHTTPD实现Web服务，控制端的所有操作都是直接调用此服务下的WebAPI接口实现。

3、ijkplayer项目： 视频播放器项目，通过封装ijkplayer播放器实现，封闭实现了视频源的解析及下载，支持HTTP/RTMP/MMS网络视频直播、ED2K/种子文件的视频文件边下边播

4、thunder项目： 第三方的下载服务，实现视频源的下载服务

 5、index.html与ime_core.js： 实现控制端的功能页面及脚本代码，所有控制端的操作都是通过此页面和脚本实现。

 

四、WebAPI接口介绍

1、“/text”      ：文本输入接口，用于实现跨屏输入

代码文件：InputRequestProcesser.java

参数：

text  = 要输入的文本，可以为任意数量的字符

调用示例：

POST /text

text=要输入的文字

代码实现：

Web服务接收到接口请求后通过DataReceiver的onTextReceived事件方法通知输入法服务IMEService，输入法服务通过commitText方法将远程输入的文本提交输入到相应的输入框。

    private boolean commitText(String text){
        InputConnection ic = getCurrentInputConnection();
        boolean flag = false;
        if (ic != null){
            Log.d(TAG, "commitText:" + text);
            if(text.length() > 1 && ic.beginBatchEdit()){
                flag = ic.commitText(text, 1);
                ic.endBatchEdit();
            }else{
                flag = ic.commitText(text, 1);
            }
        }
        return flag;
    }

 

2、“/key"，“/keydown“，”/keyup“： 三个接口分别实现按键不同的输入状态：”按击“，”按下“，”弹起“。 可用于实现按键操作，如远程遥控功能。

代码文件：InputRequestProcesser.java

参数：

code = 按键码，对应于安卓KeyEvent里定义的按键码，特殊定义的按键码”cls“表示“清空文本“

调用示例：

POST /key

code=cls

 

POST /keydown

code=67

代码实现：

Web服务接收到接口请求后通过DataReceiver的onKeyEventReceived事件方法通知输入法服务IMEService，输入法服务再根据按键码及按键动作进行处理。

                @Override
                public void onKeyEventReceived(String keyCode, int keyAction) {
                    if(keyCode != null) {
                        if("cls".equalsIgnoreCase(keyCode)){
                            InputConnection ic = getCurrentInputConnection();
                            if(ic != null) {
                                ic.performContextMenuAction(android.R.id.selectAll);
                                ic.commitText("", 1);
                            }
                        }else {
                            final int kc = KeyEvent.keyCodeFromString(keyCode);
                            if(kc != KeyEvent.KEYCODE_UNKNOWN){
                                if(mInputView != null && KeyEventUtils.isKeyboardFocusEvent(kc) && mInputView.isShown()){
                                    if(keyAction == KEY_ACTION_PRESSED || keyAction == KEY_ACTION_DOWN) {
                                        handler.post(new Runnable() {
                                            @Override
                                            public void run() {
                                                if (!handleKeyboardFocusEvent(kc)) {
                                                    sendKeyCode(kc);
                                                }
                                            }
                                        });
                                    }
                                }
                                else{
                                    long eventTime = SystemClock.uptimeMillis();
                                    InputConnection ic = getCurrentInputConnection();
                                    switch (keyAction) {
                                        case KEY_ACTION_PRESSED:
                                            sendKeyCode(kc);
                                            break;
                                        case KEY_ACTION_DOWN:
                                            if(ic != null) {
                                                ic.sendKeyEvent(new KeyEvent(eventTime, eventTime,
                                                        KeyEvent.ACTION_DOWN, kc, 0, 0, KeyCharacterMap.VIRTUAL_KEYBOARD, 0,
                                                        KeyEvent.FLAG_SOFT_KEYBOARD | KeyEvent.FLAG_KEEP_TOUCH_MODE));
                                            }
                                            break;
                                        case KEY_ACTION_UP:
                                            if(ic != null) {
                                                ic.sendKeyEvent(new KeyEvent(eventTime, eventTime,
                                                    KeyEvent.ACTION_UP, kc, 0, 0, KeyCharacterMap.VIRTUAL_KEYBOARD, 0,
                                                    KeyEvent.FLAG_SOFT_KEYBOARD | KeyEvent.FLAG_KEEP_TOUCH_MODE));
                                            }
                                            break;
                                    }
                                }
                            }
                        }
                    }
                }

 

3、“/apps” ： 获取盒子上安装的APP数据列表，实现盒子APP的管理

 代码文件：AppRequestProcesser.java

参数：

system= 是否包含系统应用，true或false

调用示例：

POST /apps

system=false

代码实现：

通过PackageManager查询盒子上安装的APP列表，在处理列表数据的同时过滤掉系统底层的APP（非第三方）。

    public static List<AppInfo> queryAppInfo(Context context, boolean containSysApp){
        PackageManager pm = context.getPackageManager();
        List<ApplicationInfo> listAppcations = pm
                .getInstalledApplications(PackageManager.MATCH_UNINSTALLED_PACKAGES);
        List<AppInfo> appInfos = new ArrayList<AppInfo>();
        for (ApplicationInfo app : listAppcations) {
            if(containSysApp || (app.flags & ApplicationInfo.FLAG_SYSTEM) == 0) {
                boolean isSysApp = (app.flags & ApplicationInfo.FLAG_SYSTEM) != 0;
                //过滤掉系统底层的app
                if(isSysApp &&
                        (app.packageName.startsWith("com.android.") || app.packageName.equals("android")))continue;
                AppInfo appInfo = new AppInfo();
                appInfo.setLable((String) app.loadLabel(pm));
                appInfo.setPackageName(app.packageName);
                appInfo.setApkPath(app.sourceDir);
                appInfo.setSysApp(isSysApp);
                appInfos.add(appInfo);
            }
        }
        Collections.sort(appInfos, new Comparator<AppInfo>() {
            @Override
            public int compare(AppInfo o1, AppInfo o2) {
                int i1 = (o1.isSysApp ? 2 : 1);
                int i2 = (o2.isSysApp ? 2 : 1);
                if(i1 == i2){
                    return o1.getLable().compareTo(o2.getLable());
                }else{
                    return Integer.compare(i1, i2);
                }
            }
        });
        return  appInfos;
    }

 

4、“/uninstall” ： 卸载应用接口

 代码文件：AppRequestProcesser.java

参数：

packageName=卸载的应用包名

调用示例：

POST /uninstall

packageName=com.test.app

代码实现：

直接调用系统的卸载服务。

    public static void uninstallPackage(final String packageName, final Context context){
        if(getApplicationInfo(packageName, context) == null)return;;
        try {
            Intent intent = new Intent();
            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
            intent.setAction(Intent.ACTION_DELETE);
            intent.setData(Uri.parse("package:" + packageName));
            context.startActivity(intent);
            Log.i(IMEService.TAG, String.format("已删除应用包[%s]", packageName));
        }catch (Exception ex){
            Log.e(IMEService.TAG, String.format("删除应用包[%s]出错", packageName), ex);
        }
    }

 

5、“/run” ，“/runSystem”： 运行应用及或调用系统应用服务，如弹出系统设置界面。

 代码文件：AppRequestProcesser.java

参数：

packageName=要运行的应用包名

调用示例：

POST /run

packageName=com.test.app

 

POST /runSystem

packageName=android.settings.SETTINGS

代码实现：

运行第三方应用则是通过PackageManager获取包里的启动页后再运行，调用系统应用服务则是通过Intent直接启动。

    public static void runPackage(final String packageName, final Context context){
        if(getApplicationInfo(packageName, context) == null)return;;
        try {
            PackageManager pm = context.getPackageManager();
            Intent intent = pm.getLaunchIntentForPackage(packageName);
            if(intent != null){
                context.startActivity(intent);
            }
            Log.i(IMEService.TAG, String.format("已运行应用包[%s]", packageName));
        }catch (Exception ex){
            Log.e(IMEService.TAG, String.format("运行应用包[%s]出错", packageName), ex);
        }
    }
    public static void runSystemPackage(final String packageName, final Context context){
        try {
            Intent intent = new Intent(packageName);
            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
            context.startActivity(intent);
            Log.i(IMEService.TAG, String.format("已运行系统应用包[%s]", packageName));
        }catch (Exception ex){
            Log.e(IMEService.TAG, String.format("运行系统应用包[%s]出错", packageName), ex);
        }
    }

 

6、“/upload” ： 文件传送接口。“输入遥控”界面下的文件传送接口，如果传送的为APK包则可自动安装，如果为视频文件或者种子文件则可自动播放。

 代码文件：UploadRequestProcesser.java

参数：

file=上传的文件

autoPlay = 是否自动安装APK包或者自动播放视频及种子文件，true或者false

调用示例：

POST /upload

-------

代码实现：

直接通过NanoHTTPD的文件上传功能实现，为避免跨"分区“移动文件，重写了NanoHTTPD的TempFileManager实现，以便文件上传时直接上传到IMEService数据目录下的files目录。

代码请参考RemoteServerFileManager.java文件

 

7、“/play” ： 视频播放服务接口

 代码文件：PlayRequestProcesser.java

参数：

playUrl=要播放的视频源地址

调用示例：

POST /play

playUrl=http://www.test.com/test.avi

代码实现：

直接将视频源地址传入ijkplayer项目的播放器进行播放

XLVideoPlayActivity.intentTo(context, url, url);

 

8、“/file/dir/” ： 文件管理接口服务，实现盒子的文件及目录查看功能。

 代码文件：FileRequestProcesser.java

参数：

无

调用示例：

GET /file/dir/{查看的文件或者目录路径}

代码实现：

获取目录下的子目录及文件列表，返回JSON数据

   private NanoHTTPD.Response responseDirData(String dirName) {
        File path = new File(Environment.getExternalStorageDirectory(), dirName);
        String root = Environment.getExternalStorageDirectory().getPath();
        JSONArray dirs = new JSONArray();
        JSONArray files = new JSONArray();
        try {
            File[] subfiles = path.listFiles();
            Arrays.sort(subfiles, new Comparator<File>() {
                @Override
                public int compare(File f1, File f2) {
                    return f1.getName().toLowerCase().compareTo(f2.getName().toLowerCase());
                }
            });

            for (File file : subfiles) {
                if(file.isHidden()) continue;
                JSONObject item = new JSONObject();
                item.put("name", file.getName());
                item.put("path", file.getPath().substring(root.length()));
                if (file.isDirectory()) {
                    //item.put("total", 0);
                    dirs.put(item);
                }else {
                    item.put("size", file.length());
                    files.put(item);
                }
            }

            JSONObject data = new JSONObject();
            if(!TextUtils.isEmpty(dirName) && dirName != "/") data.put("parent", path.getParent().substring(root.length()));
            data.put("dirs", dirs);
            data.put("files", files);
            return RemoteServer.createJSONResponse(NanoHTTPD.Response.Status.OK, data.toString());
        }catch (JSONException ex){
            return RemoteServer.createPlainTextResponse(NanoHTTPD.Response.Status.INTERNAL_ERROR,  "SERVER INTERNAL ERROR: JSONException: " + ex.getMessage());
        }
    }

 

9、“/file/download/” ： 文件下载服务，实现盒子的文件下载功能。

 代码文件：FileRequestProcesser.java

参数：

无

调用示例：

GET /file/download/{下载的文件路径}

代码实现：

    private NanoHTTPD.Response downloadFileData(String fileName){
        File file = new File(Environment.getExternalStorageDirectory(), fileName);
        if(!file.exists()){
            return RemoteServer.createPlainTextResponse(NanoHTTPD.Response.Status.NOT_FOUND, "Error 404, file not found.");
        }
        try{
            InputStream inputStream = new FileInputStream(file);
            return RemoteServer.newFixedLengthResponse(NanoHTTPD.Response.Status.OK,
                    NanoHTTPD.getMimeTypeForFile(file.getName()) + "; charset=utf-8", inputStream, (long)inputStream.available());
        } catch (Exception e) {
            return RemoteServer.createPlainTextResponse(NanoHTTPD.Response.Status.NOT_FOUND, "Error 404, file not found.");
        }
    }

 

10、“/file/cut” ，“/file/copy”： 文件与目录的剪切、复制服务。

 代码文件：FileRequestProcesser.java

参数：

paths = 要操作的目录或者文件列表，多个之间用“|”分隔开

targetPath =  剪切或者移动的文件的新目标目录

调用示例：

POST /file/cut

paths=/Download/a.txt&targetPath=/Andorid/data/

POST /file/copy

paths=/Download/a.txt&targetPath=/Andorid/data/

代码实现：

   private void batchCopyFile(String targetPath, String paths){
        File targetPathFile = new File(Environment.getExternalStorageDirectory(), targetPath);
        if(!targetPathFile.exists()) return;

        String[] pathData = paths.split("\\|");
        for(String p : pathData){
            if(!TextUtils.isEmpty(p)) {
                File source = new File(Environment.getExternalStorageDirectory(), p);
                RemoteServerFileManager.copyFile(source, targetPathFile);
            }
        }
    }
    private void batchCutFile(String targetPath, String paths){
        File targetPathFile = new File(Environment.getExternalStorageDirectory(), targetPath);
        if(!targetPathFile.exists()) return;

        String[] pathData = paths.split("\\|");
        for(String p : pathData){
            if(!TextUtils.isEmpty(p)) {
                File source = new File(Environment.getExternalStorageDirectory(), p);
                RemoteServerFileManager.cutFile(source, targetPathFile);
            }
        }
    }

 

11、“/file/delete” ： 文件或者目录删除服务，如果是目录删除则会一并删除目录下的所有子目录和文件。

 代码文件：FileRequestProcesser.java

参数：

paths = 要删除的文件或者目录列表

调用示例：

POST /file/delete

paths=/Download/a.txt|/Download/test

代码实现：

    private void batchDeleteFile(String paths){
        String[] pathData = paths.split("\\|");
        for(String p : pathData){
            if(!TextUtils.isEmpty(p)) {
                File path = new File(Environment.getExternalStorageDirectory(), p);
                RemoteServerFileManager.deleteFile(path);
            }
        }
    }

 

12、“/file/upload” ： 文件上传服务。此接口和/upload接口类似，但是此接口是将文件上传到文件管理界面下的当前目录，并且不会安装APK包和播放视频文件。

 代码文件：FileRequestProcesser.java

参数：

file = 上传的文件数据

path = 存储上传文件的目录

调用示例：

POST /file/upload

--------

代码实现：

文件上传NanoHTTPD内部已实现好，因此只需要将上传的文件移动到对应的目录即可。

    private NanoHTTPD.Response uploadFile(Map<String, String> params, Map<String, String> files){
        String uploadFileName  = params.get("file");
        String uploadPathName  = params.get("path");
        String localFilename = files.get("file");
        boolean r = false;
        if(!TextUtils.isEmpty(uploadFileName)) {
            if (!TextUtils.isEmpty(localFilename)) {
                File saveFilename = new File(Environment.getExternalStorageDirectory(), uploadPathName);
                File localFile = new File(localFilename);
                saveFilename = new File(saveFilename,localFile.getName());
                r = localFile.renameTo(saveFilename);
            }
        }
        return RemoteServer.createJSONResponse(NanoHTTPD.Response.Status.OK,  "{\"success\":" + (r ? "true": "false") + "}");
    }

 

 五：附注

项目地址：https://github.com/kingthy/TVRemoteIME

交流QQ群：7149348， 加入QQ群可以分享直播源、反馈问题及建议。