HiddenCam 开源项目使用手册

HiddenCam 开源项目使用手册

1. 项目目录结构及介绍

HiddenCam 是一个允许在不显示UI的情况下后台捕获图片的库，特别适用于需要悄无声息进行图像捕捉的场景。以下是该项目的基本目录结构及其简介：

├── build.gradle            # 主构建脚本
├── gitignore               # Git忽略文件列表
├── gradle.properties       # Gradle属性配置
├── gradlew                 # Gradle wrapper 脚本（Unix）
├── gradlew.bat             # Gradle wrapper 脚本（Windows）
├── library                 # 核心库源代码所在目录
├── sample                  # 示例应用代码所在目录
├── settings.gradle         # 设置脚本
├── README.md               # 项目说明文档
└── LICENSE                 # 许可证文件

• library 文件夹包含了实现后台拍照功能的主要代码。
• sample 目录下是示例应用程序，用于展示如何集成和使用 HiddenCam 库。
• build.gradle, gradle.properties 用于配置项目构建。
• gitignore 定义了哪些文件或文件夹不应被Git版本控制系统跟踪。
• gradlew 和 gradlew.bat 分别为不同操作系统的Gradle Wrapper脚本。
• README.md 包含了快速入门指南和项目特性介绍。
• LICENSE 明确了项目的授权方式为Apache-2.0。

2. 项目的启动文件介绍

对于开发者来说，主要关注的是如何将HiddenCam集成到自己的应用中。虽然没有特定的“启动文件”，但集成的关键在于引入依赖并初始化库。在应用的 build.gradle 文件中的 dependencies 块添加以下依赖来启动项目：

implementation 'com.cottacush:HiddenCam:x.y.z'

这里的 x.y.z 需要替换为实际的版本号，具体版本信息应参考项目releases页面。

初始化 HiddenCam

之后，在应用程序中，通过创建 HiddenCam 实例并调用相关方法来初始化和使用该库。这通常发生在你需要开始图像捕捉的逻辑处。

val hiddenCam = HiddenCam(
    context,
    baseStorageFolder, // 图片存储的基础路径
    captureListener     // 捕捉结果监听器
)
hiddenCam.start()

3. 项目的配置文件介绍

HiddenCam的配置主要是通过构造函数参数来进行定制的，而非独立的配置文件。这意味着配置是在实例化 HiddenCam 类时完成的，你可以提供不同的参数来调整其行为，例如：

• CaptureMode：通过 CaptureTimeFrequency 决定是一次性捕获还是持续周期捕获。
• 分辨率和宽高比：可以通过指定 targetResolution 或 targetAspectRatio 来设定。
• 旋转角度：根据需要调整摄像头捕获时的旋转角度。
• 相机类型：选择前置或后置摄像头，通过 CameraType 枚举设置。
• 事件监听器：如 OnImageCapturedListener 用来处理捕获后的图片。

因此，尽管没有传统的配置文件，这些初始化参数构成了HiddenCam的核心配置机制，可以根据具体需求灵活配置其行为。确保在使用前详细阅读 README.md 中的使用指南以正确配置和使用 HiddenCam 库。