Close Menu

rxscreeen

Welcome to the documentation page for RxScreeen!

Overview

RxScreeen is a powerful screen capture library for iOS applications, designed to simplify the process of capturing screenshots programmatically. With RxScreeen, you can easily capture the current screen, specific views, or even custom regions of your app’s user interface. This documentation provides an in-depth guide on how to integrate and utilize RxScreeen in your iOS projects.

Getting Started

In order to use RxScreeen, follow these steps:

  1. Install RxScreeen by adding it to your project’s dependency manager (CocoaPods or Carthage).
  2. Import the RxScreeen module into your code.
  3. Start capturing screenshots programmatically using RxScreeen’s provided methods.

Installation

To install RxScreeen, you can use either of the following methods:

CocoaPods

To install using CocoaPods, simply add the following line to your Podfile:

// Podfile
pod 'RxScreeen'

And then run pod install in your project’s directory.

Carthage

Alternatively, if you are using Carthage, add the following line to your Cartfile:

// Cartfile
github "RxScreeen/RxScreeen"

Afterward, run carthage update to build the framework and drag the built RxScreeen.framework into your Xcode project.

Integration

Once RxScreeen is installed, integrate it into your project by following these steps:

  1. Import the RxScreeen module into the class where you want to perform screen captures:

import RxScreeen
  1. Use the provided RxScreeen methods to capture screenshots according to your requirements:

RxScreeen.captureScreen() { image in
    // Use the captured image
}

Features

RxScreeen offers the following features:

  • 1. Capture Full Screen: Capture the entire screen of your iOS device.
  • 2. Capture View: Capture an individual view or any visible region of your app.
  • 3. Custom Overlay: Apply custom overlays to captured images.
  • 4. Callbacks: Receive callbacks with the captured image for further processing.

Examples

Here are a few examples to help you get started with RxScreeen:

// Capture full screen
RxScreeen.captureScreen() { image in
    // Handle the captured image
}

// Capture a specific view
RxScreeen.captureView(myCustomView) { image in
    // Handle the captured image
}

Conclusion

Congratulations! You now possess the knowledge to integrate and utilize RxScreeen in your iOS application. With RxScreeen’s powerful screen capture capabilities, capturing screenshots programmatically has never been easier.