Skip to content

Latest commit

 

History

History
231 lines (190 loc) · 9.13 KB

README.md

File metadata and controls

231 lines (190 loc) · 9.13 KB
Raw

HBRecorder

Android Arsenal

Lightweight screen and audio recording Android library

Requires API level 21>


I've spent a lot of time on this library. If you're making money using this library, the LEAST you can do is:

Buy Me A Coffee

Demo:

Download the demo app here



Take part in the poll

Let other developers know what version you have tested:




Adding the library to your project:

Add the following in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }	    
    }
}

Implement library in your app level build.gradle:

dependencies {
    implementation 'com.github.HBiSoft:HBRecorder:2.0.3'
}

Implementing the library:

  1. In your Activity, first implement HBRecorder, as shown below:
public class MainActivity extends AppCompatActivity implements HBRecorderListener {
  1. Alt+Enter to implement the following methods:
@Override
public void HBRecorderOnStart() {
    //When the recording starts
}

@Override
public void HBRecorderOnComplete() {
    //After file was created
}
@Override
public void HBRecorderOnError(int errorCode) {
    //When an error occurs
}
  1. Init HBRecorder as shown below:
public class MainActivity extends AppCompatActivity implements HBRecorderListener {
    HBRecorder hbRecorder;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);     

        //Init HBRecorder
        hbRecorder = new HBRecorder(this, this);        

}
  1. Add the following permissions in your manifest:
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_INTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />

That's it, HBRecorder is now ready to be used.

When you want to start capturing your screen, it is important you do it as shown below:

private void startRecordingScreen() {
    MediaProjectionManager mediaProjectionManager = (MediaProjectionManager) getSystemService(Context.MEDIA_PROJECTION_SERVICE);
    Intent permissionIntent = mediaProjectionManager != null ? mediaProjectionManager.createScreenCaptureIntent() : null;
    startActivityForResult(permissionIntent, SCREEN_RECORD_REQUEST_CODE);
}

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == SCREEN_RECORD_REQUEST_CODE) {
        if (resultCode == RESULT_OK) {
            //Start screen recording
            hbRecorder.startScreenRecording(data, resultCode, this);

        }
    }
}

All available methods:

// Set the output path as a String
// Only use this on devices running Android 9 and lower or you have to add android:requestLegacyExternalStorage="true" in your manifest
// Defaults to - Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_MOVIES)
hbrecorder.setOutputPath(String);
// Set output Uri
// Only use this on devices running Android 10>
// When setting a Uri ensure you pass the same name to HBRecorder as what you set in ContentValues (DISPLAY_NAME and TITLE)
hbRecorder.setOutputUri(Uri);
// Set file name as String
// Defaults to - quality + time stamp. For example HD-2019-08-14-10-09-58.mp4
hbrecorder.setFileName(String);
// Set audio bitrate as int
// Defaults to - 128000
hbrecorder.setAudioBitrate(int);
// Set audio sample rate as int 
// Defaults to - 44100
hbrecorder.setAudioSamplingRate(int);
// Enable/Disable audio
// Defaults to true
hbrecorder.isAudioEnabled(boolean);
// Enable/Disable HD Video
// Defaults to true
hbrecorder.recordHDVideo(boolean);
// Get file path as String
hbrecorder.getFilePath();
// Get file name as String
hbrecorder.getFileName();
// Start recording screen by passing it as Intent inside onActivityResult
hbrecorder.startScreenRecording(Intent);
// Pause screen recording (only available for devices running 24>)
hbrecorder.pauseScreenRecording();
// Resume screen recording
hbreccorder.resumeScreenRecording();
// Stop screen recording
hbrecorder.stopScreenRecording();
// Check if recording is in progress
hbrecorder.isBusyRecording();
// Set notification icon by passing, for example R.drawable.myicon
// Defaults to R.drawable.icon
hbrecorder.setNotificationSmallIcon(int);
// Set notification icon using byte array
hbrecorder.setNotificationSmallIcon(byte[]);
// Set notification icon using vector drawable
hbRecorder.setNotificationSmallIconVector(vector);
// Set notification title
// Defaults to "Recording your screen"
hbrecorder.setNotificationTitle(String);
// Set notification description
// Defaults to "Drag down to stop the recording"
hbrecorder.setNotificationDescription(String);
// Set notification stop button text
// Defaults to "STOP RECORDING"
hbrecorder.setNotificationButtonText(String);
// Set output orientation (in degrees)
hbrecorder.setOrientationHint(int);
// Set max output file size
hbrecorder.setMaxFileSize(long);
// Set max time (in seconds)
hbRecorder.setMaxDuration(int);

Custom setting:

When you want to enable custom settings you must first call:

hbRecorder.enableCustomSettings();

Then you can set the following:

//MUST BE ONE OF THE FOLLOWING - https://developer.android.com/reference/android/media/MediaRecorder.AudioSource.html
hbRecorder.setAudioSource(String);
//MUST BE ONE OF THE FOLLOWING - https://developer.android.com/reference/android/media/MediaRecorder.VideoEncoder.html
hbRecorder.setVideoEncoder(String);
//If nothing is provided, it will select the highest value supported by your device
hbRecorder.setScreenDimensions(HeightInPx, WidthInPx);
//Frame rate is device dependent
//You can use Camcoderprofile to determine the frame rate
hbRecorder.setVideoFrameRate(int);
//The bitrate is also dependent on the device and the frame rate that is set
hbRecorder.setVideoBitrate(int);
//MUST BE ONE OF THE FOLLOWING - https://developer.android.com/reference/android/media/MediaRecorder.OutputFormat.html
hbRecorder.setOutputFormat(String);

It is important to note that limitations are device dependent. It is best to set the video encoder to "DEFAULT" and let MediaRecorder pick the best encoder.

In the demo app you will have the option to test different video encoders, bitrate, frame rate and output formats. If your device does not support any of the parameters you have selected HBRecorderOnError will be called.