2 Star 3 Fork 5

OS-Android / ScreenLib

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ScreenLib

License API

版本记录

V1.0.0版本(2022.5.17)

  1. 由1.0.0.beta2发布,功能参考本文档

一、介绍

  1. 基于MediaProjection进行屏幕录制、截屏,每次开始时都会唤起用户授权对话框;
  2. 保存view、activity为图片。

二、工程引入工具包准备

com.android.tools.build:gradle:4.2.2及以下版本,在工程的 build.gradle 文件添加

allprojects {
    repositories {
        google()
        mavenCentral()

        //jitpack 仓库
        maven { url 'https://jitpack.io' }
    }
}

com.android.tools.build:gradle:7.0.0及以上版本,在工程的 settings.gradle 文件添加

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()

        //jitpack 仓库
        maven {
            url 'https://jitpack.io'
        }
    }
}

APP的build.gradle文件添加

dependencies {
    ...
    
    implementation 'com.gitee.osard:screen-lib:+'
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'org.greenrobot:eventbus:3.2.0'
}

三、使用

  1. ScreenCaptureUtils保存View、Activity为图片
/**
 * 保存时未设置路径,则默认放置“手机存储-Android-data-包名-Cache-Pictures”下
 * 文件名默认为时间戳
 */
public class ScreenCaptureUtils {
    
    public static ScreenCaptureUtils createInstance();

    /**
     * @param path 保存的路径,空路径无效,相对路径将无法得知存储位置
     */
    public ScreenCaptureUtils setImagePath(String path);

    /**
     * @param path      保存的路径
     * @param videoName 保存文件的名字
     */
    public ScreenCaptureUtils setImagePath(String path, String videoName);

    /**
     * @param imageName 保存文件的名字
     */
    public ScreenCaptureUtils setImageName(String imageName);

    /**
     * 截图当前Activity
     * <p>
     * 当前 Activity 不可见时获取不到 View
     */
    public ScreenCaptureUtils setView(@NonNull Activity activity);

    /**
     * 截图当前View
     */
    public ScreenCaptureUtils setView(@NonNull View view);

    /**
     * 获取视图的截图
     *
     * @return 返回bitmap,null:出现异常或 view=null
     */
    public Bitmap screenCapture();

    /**
     * 将视图的截图保存到指定的文件,保存为JPG
     *
     * @param quality 压缩质量 0-100,参考{Bitmap.CompressFormat#JPEG}
     * @return 返回保存的全路径,null:出现异常或 view=null
     */
    public String saveBitmapToJpg(int quality);

    /**
     * 将视图的截图保存到指定的文件,保存为PNG
     *
     * @return 返回保存的全路径,null:出现异常或 view=null
     */
    public String saveBitmapToPng();

    /**
     * 将视图的截图保存到指定的文件
     *
     * @param format  格式,参考{Bitmap.CompressFormat}
     * @param quality 压缩质量,参考{Bitmap.CompressFormat}
     * @return 返回保存的全路径,null:出现异常或 view=null
     */
    public String saveBitmap(Bitmap.CompressFormat format, int quality);
}
  1. ScreenRecordUtils视频录制
  • 开始录制和结束录制,使用前必须初始化
/**
 * 开始录制时未设置路径,则默认放置“手机存储-Android-data-包名-Cache-Movies”下
 * 文件名默认为时间戳
 * <p>
 * 作者:MJSoftKing
 */
public class ScreenRecordUtils {

    /**
     * 使用自身service初始化视频录制
     *
     * @param application app
     */
    public static void init(Application application);

    /**
     * 使用继承ScreenRecordService重写前台通知栏的服务初始化
     * 多次初始化时,以第一次为准
     *
     * @param application APP
     * @param serviceName 继承ScreenRecordService的服务
     */
    public static void init(Application application, Class<? extends ScreenRecordService> serviceName);

    /**
     * 使用竖屏或横屏开始录制。
     *
     * @param videoPath 视频存放全路径,例如:“/storage/emulated/0/Android/data/包名/cache/Movies/”
     * @param videoName 视频名称,后缀为”.mp4“。
     * @param direction 录制屏幕方向
     */
    public static boolean start(@Nullable String videoPath,
                                @Nullable String videoName,
                                @Nullable ScreenRecordDirectionEnum direction);

    /**
     * 使用竖屏或横屏开始录制。
     *
     * @param videoPath 视频存放全路径,例如:“/storage/emulated/0/Android/data/包名/cache/Movies/”
     * @param videoName 视频名称,后缀为”.mp4“。
     */
    public static boolean start(@Nullable String videoPath,
                                @Nullable String videoName);

    /**
     * 使用竖屏或横屏开始录制。
     *
     * @param direction 录制屏幕方向
     */
    public static boolean start(@Nullable ScreenRecordDirectionEnum direction);

    /**
     * 使用调用时的屏幕方向开始录制
     */
    public static boolean start();

    /**
     * 停止录制,成功录制时,触发{ScreenRecordSuccessEvent} 事件
     */
    public static boolean stop();
}
  • ScreenRecordService录制服务可覆盖资源

string 资源

    <string name="media_record_service_app_name">录屏服务</string>
    <string name="sevice_foreground_notice_sub_title" >录屏服务运行中</string>

mipmap 图标资源

    ic_screen_record_notice_logo
  • 继承ScreenRecordService,重写前台通知栏与MediaFormat
public class ScreenRecordService extends Service {

    /**
     * 通知ID,ID固定为“int最大值 - 1111”,与其他通知ID不可重复
     */
    protected final static int NOTICE_ID;
    /**
     * 录制屏幕宽度
     */
    protected int mWindowWidth;
    /**
     * 录制屏幕高度
     */
    protected int mWindowHeight;
    /**
     * 录制屏幕DPI
     */
    protected int mScreenDensity;
    
    /**
     * 继承service后重写此Notification方法,自定义自己的前台通知栏
     * 结束录制调用 {Service#stopSelf()}即可结束,不支持暂停和继续
     */
    protected Notification getForegroundNotice();

    /**
     * 获取录制MediaFormat
     */
    protected MediaFormat getMediaFormat();
}

继承服务,初始化时必须传递继承后的服务class

public class App extends Application {
    
    @Override
    public void onCreate() {
        super.onCreate();
        //继承服务后,必须传递服务,此处举例
        ScreenRecordUtils.init(this, ScreenRecordService.class);
    }
}
  • 录制事件

事件类

/**
 * 事件的实现接口
 */
public interface BaseScreenRecordEvent extends Serializable {
}

/**
 * 录制出现错误时触发
 */
public class ScreenRecordFailedEvent implements BaseScreenRecordEvent {

    /**
     * 录制发生错误时的异常message
     */
    public String getMessage();

    /**
     * 异常对象
     */
    public Throwable getE();
}

/**
 * 录制开始时触发
 */
public class ScreenRecordStartEvent implements BaseScreenRecordEvent {
}

/**
 * 录制结束时触发
 */
public class ScreenRecordStopEvent implements BaseScreenRecordEvent {
}

/**
 * 录制成功时触发,返回视频全路径
 */
public class ScreenRecordSuccessEvent implements BaseScreenRecordEvent {

    /**
     * 录制开始的时间
     */
    public Date getStartDate();

    /**
     * 录制文件存放路径,后缀为“.mp4”
     */
    public String getVideoPathName();
}

/**
 * 用户取消录制触发(弹出确认框时点击取消)
 */
public class ScreenRecordUserCancelEvent implements BaseScreenRecordEvent {
}

事件接收

public class MainActivity extends AppCompatActivity {
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        EventBus.getDefault().register(this);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void event(BaseScreenRecordEvent event) {
        Log.w(TAG, event.getClass().getName());
        if (event instanceof ScreenRecordSuccessEvent) {
            ScreenRecordSuccessEvent srse = (ScreenRecordSuccessEvent) event;
            Log.w(TAG, srse.getVideoPathName());
            new File(srse.getVideoPathName()).renameTo(new File(
                    getExternalFilesDir(Environment.DIRECTORY_MOVIES).getAbsolutePath() +
                            File.separator + System.currentTimeMillis() + ".mp4"));
        }
    }

}
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS

简介

安卓 基于MediaProjection进行屏幕录制、截屏,每次开始时都会唤起用户授权对话框 展开 收起
Android
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Android
1
https://gitee.com/osard/screen-lib.git
git@gitee.com:osard/screen-lib.git
osard
screen-lib
ScreenLib
master

搜索帮助