Basic recording

Initialization

// Create a recording interface.
AliyunIRecorder recorder = AliyunRecorderCreator.getRecorderInstance(context);// The context parameter is the context of the current page.

// Destroy the recording interface.
// Call this method to destroy the interface when you no longer need it, such as before the app exits. Do not call it while the recorder is in use.
recorder.destroy();

Configure recording parameters

// Set the quality of the recorded video.
recorder.setVideoQuality(quality);

// Set the bitrate of the recorded video.
recorder.setVideoBitrate(int bitrate);// Unit: Kbps.

// Set the output parameters for the recorded video.
recorder.setMediaInfo(mediaInfo);// For parameter details, see the MediaInfo API reference.

// Set the output path for the recorded video.
recorder.setOutputPath(string path);

// Set the GOP (Group of Pictures) size for the recorded video.
recorder.setGop(int gop);// Unit: frames.

Start recording

// Start recording.
recorder.startRecording();

Record a video clip

// Start recording.
recorder.startRecording();

// Stop recording to generate a video clip.
recorder.stopRecording();

recorder.startRecording();
// Cancel the recording. The current video clip will not be saved.
recorder.cancelRecording();

// Continue recording the next video clip.
recorder.startRecording();
recorder.stopRecording();

Recording camera control

// Get the number of cameras.
AliyunIRrecorder.getCameraCount();

// Set the camera type.
AliyunIRecorder.setCamera(cameraType);

// Mute the recording.
AliyunIRecorder.setMute(boolean isMute);

// Set the sensor rotation angle.
// Important: Read the API reference carefully.
AliyunIRecorder.setRotation(int rotation);

// Set the recording rotation angle.
// Important: Read the API reference carefully. 
AliyunIRecorder.setRecordRotation(int rotation);

// Set camera preview parameters (flash, focus mode, zoom, exposure level). You can also set these parameters individually using the methods below.
AliyunIRecorder.setCameraParam(CameraParam cameraParam);

// Switch between cameras.
AliyunIRecorder.switchCamera();

// Set the flash mode.
AliyunIRecorder.setLight(flashType);

// Set the zoom level. 
AliyunIRecorder.setZoom(float rate);

// Set the exposure level. 
AliyunIRecorder.setExposureCompensationRatio(float value);

// Set the focus mode. 
AliyunIRecorder.setFocusMode(int mode);

// Manually set the focus. 
AliyunIRecorder.setFocus(float xRatio, float yRatio);

Video clip management

// Get the clip manager.
AliyunIClipManager manager = AliyunIRecorder.getClipManager();

// Set the maximum recording duration (total duration of all clips, not a single clip).
manager.setMaxDuration(int maxDurationMs);

// Set the minimum recording duration (total duration of all clips, not a single clip).
manager.setMinDuration(int minDurationMs);

// Delete the last clip.
manager.deletePart();

// Delete the specified clip.
manager.deletePart(int index);

// Delete all clips.
manager.deleteAllPart();

// Get the total duration of all clips.
manager.getDuration();

// Get the total number of clips.
manager.getPartCount();

// Get the list of clip paths.
manager.getVideoPathList();

You can use custom filters. To learn how to create them, see Filters and transitions.

// Apply a filter.
AliyunIRecorder.applyFilter(EffectFilter effectFilter);// To remove the filter, set the path parameter to null.

// Remove the filter.
AliyunIRecorder.applyFilter(new EffectFilter(null));

Animated filters

// Apply an animated filter.
AliyunIRecorder.applyAnimationFilter(EffectFilter effectFilter);

// Remove the animated filter.
AliyunIRecorder.removeAnimationFilter(EffectFilter effctFilter);

Background music

// Set the background music.
AliyunIRecorder.setMusic(String path,long startTime,long duration);

// Remove the background music.
AliyunIRecorder.setMusic(null, 0, 0);

Speed ramping

// Set the recording speed.
AliyunIRecorder.setRate(float rate);

Static stickers and watermarks

// Add a static sticker or watermark.
AliyunIRecorder.addImage(EffectImage effctImage);

// Remove the static sticker or watermark.
AliyunIRecorder.removeImage(EffectImage effctImage);

// Update the position of the static sticker or watermark.
AliyunIRecorder.setEffectView(float xRatio,float yRatio,float widthRatio,float heightRatio,EffectBase effectBase);

You can use custom animated stickers. To learn how to create them, see Animations.

// Add an animated sticker.
AliyunIRecorder.addPaster(EffectPaster effectPaster,float sx,float sy,float sw,float sh,float rotation,boolean flip);

// Remove an animated sticker.
AliyunIRecorder.removePaster(EffectPaster effectPaster);

// Update the position of the animated sticker.
AliyunIRecorder.setEffectView(float xRatio,float yRatio,float widthRatio,float heightRatio,EffectBase effectBase);

The video recording module provides a built-in basic retouching feature. It also supports third-party retouching SDKs, such as the Alibaba Cloud Queen SDK and FaceUnity. The built-in feature is simple, allowing you to set only the retouching level. Third-party SDKs typically offer more advanced features, including retouching, face shaping, makeup, filters, and stickers.

• Built-in retouching

  // Enable or disable retouching.
  AliyunIRecorder.setBeautyStatus(boolean on);
  
  // Set the retouching level.
  AliyunIRecorder.setBeautyLevel(int level);

• Third-party retouching SDKs

  To use effects from a third-party retouching SDK, you must first obtain the necessary permissions and integrate that SDK with the short video SDK.

  • For information about how to integrate the Alibaba Cloud Queen SDK, see Alibaba Cloud Queen SDK. For sample code that shows how to configure effects, see Usage examples.

  • For information about how to purchase, integrate, and use FaceUnity, see FaceUnity.

  Third-party retouching SDKs require two types of data to function: the camera texture ID and the camera raw frame data. The following code shows how to obtain this data.

  • Obtain the camera texture ID

    AliyunIRecorder.setOnTextureIdCallback(new OnTextureIdCallBack() {
                @Override
                public int onTextureIdBack(int textureId, int textureWidth, int textureHeight, float[] matrix) {
                    if (mBeautyInterface != null) {
                        return mBeautyInterface.onTextureIdBack(textureId, textureWidth, textureHeight, matrix, mControlView.getCameraType().getType());
                    }
                    return textureId;
                }
    
                @Override
                public int onScaledIdBack(int scaledId, int textureWidth, int textureHeight, float[] matrix) {
    
                    return scaledId;
                }
    
                @Override
                public void onTextureDestroyed() {
                    // To destroy GL resources for custom rendering (third-party rendering) in SDK versions earlier than 3.7.8, you can use GLSurfaceView.queueEvent. For SDK V3.7.8 and later, we recommend destroying GL resources in this callback.
                    if (mBeautyInterface != null) {
                        mBeautyInterface.release();
                        mBeautyInterface = null;
                    }
                }
            });

  • Obtain the camera raw frame data

    AliyunIRecorder.setOnFrameCallback(new OnFrameCallBack() {
                @Override
                public void onFrameBack(byte[] bytes, int width, int height, Camera.CameraInfo info) {
                    // The raw data callback provides data in NV21 format. This data is primarily used for advanced retouching with FaceUnity.
                    if (mBeautyInterface != null) {
                        mBeautyInterface.onFrameBack(bytes, width, height, info);
                    }
                }
    
                @Override
                public Camera.Size onChoosePreviewSize(List<Camera.Size> supportedPreviewSizes,
                                                       Camera.Size preferredPreviewSizeForVideo) {
                    return null;
                }
    
                @Override
                public void openFailed() {
                    
                }
            });

You can capture photos with effects or use the system camera to capture photos without effects. The photo data is returned through theRecordCallback.onPictureBack(Bitmap) orRecordCallback.onPictureDataBack(byte[]) callback.

// Capture a photo with effects.
AliyunIRecorder.takePhoto(boolean needBitmap);

// Capture a photo by using the system camera (no effects).
AliyunIRecorder.takePicture(boolean needBitmap);

// Set the photo size for system photo capture. This is not supported for photo capture with effects.
AliyunIRecorder.setPictureSize(Camera.Size size);

To use facial recognition, you must integrate a facial recognition model file into your app. For reference, you can download the facial recognition model file demo.

// Enable facial recognition.
AliyunIRecorder.needFaceTrackInternal(boolean need);

// Set the path of the facial recognition model file.
AliyunIRecorder.setFaceTrackInternalModelPath(String path);

// Set the face detection rotation angle.
// Important: Read the API reference carefully. 
AliyunIRecorder.setFaceDetectRotation(int rotation);

// Set the maximum number of faces to detect.
// Set the maximum number of faces that the built-in facial recognition can detect. The maximum is 3.
AliyunIRecorder.setFaceTrackInternalMaxFaceCount(int maxFaceCount);

// Add an animated face sticker.
AliyunIRecorder.addPaster(EffectPaster effectPaster);