tencent cloud

All product documents
User Generated Short Video SDK
DocumentationUser Generated Short Video SDKIntegration (No UI)Tencent Effect SDKSDK Integration GuideAndroid
Android
Download PDF
Last updated: 2022-11-14 18:18:58
Android
Last updated: 2022-11-14 18:18:58
Download PDF

Step 1. Replace resources

1. Download the UGSV demo which has been integrated with the Tencent Effect SDK. This demo is built based on the Tencent Effect SDK S1-04 edition.
2. Replace resources: As the SDK edition used by the demo project may be different from the SDK edition you actually use, you need to replace the different SDK files in the demo with the files in the SDK edition you actually use as follows:
In the build.gradle file of the xmagickit module, find the following:
api 'com.tencent.mediacloud:TencentEffect_S1-04:latest.release'
Replace it with the SDK edition you purchased as described in Integrating the Tencent Effect SDK (Android).
If your edition contains animated effects and filters, you need to download the corresponding resources on the Tencent Effect SDK download page and put them in the following directories of the xmagickit module respectively:
Animated effects: ../assets/MotionRes.
Filters: ../assets/lut.
3. Import the xmagickit module from the demo into your actual project.

Step 2. Open build.gradle in app and do the following:

Replace the applicationId with the package name under the obtained trial license.

Step 3. Integrate the SDK APIs

You can refer to the UGCKitVideoRecord class of the demo.
1. Authorize:
 // For details about authentication and error codes, see https://www.tencentcloud.com/document/product/1143/45385#.E6.AD.A5.E9.AA.A4.E4.B8.80.EF.BC.9A.E9.89.B4.E6.9D.83
 XMagicImpl.checkAuth(new TELicenseCheck.TELicenseCheckListener() {
         @Override
         public void onLicenseCheckFinish(int errorCode, String msg) {
             if (errorCode == TELicenseCheck.ERROR_OK) {
                 loadXmagicRes();
             } else {
                 Log.e("TAG", "auth fail, please check auth url and key" + errorCode + " " + msg);
             }
         }
     });
2. Initialize the material:
 private void loadXmagicRes() {
     if (XMagicImpl.isLoadedRes) {
         XmagicResParser.parseRes(mActivity.getApplicationContext());
         initXMagic();
         return;
     }
     new Thread(new Runnable() {
         @Override
         public void run() {
             XmagicResParser.copyRes(mActivity.getApplicationContext());
             XmagicResParser.parseRes(mActivity.getApplicationContext());
             XMagicImpl.isLoadedRes = true;
             new Handler(Looper.getMainLooper()).post(new Runnable() {
                 @Override
                 public void run() {
                     initXMagic();
                 }
             });
         }
     }).start();
 }
3. Bind beauty filters to UGSV:
 private void initBeauty() {
     TXUGCRecord instance = TXUGCRecord.getInstance(UGCKit.getAppContext());
     instance.setVideoProcessListener(new TXUGCRecord.VideoCustomProcessListener() {
         @Override
         public int onTextureCustomProcess(int textureId, int width, int height) {
             if (xmagicState == XMagicImpl.XmagicState.STARTED && mXMagic != null) {
                 return mXMagic.process(textureId, width, height);
             }
             return textureId;
         }

         @Override
         public void onDetectFacePoints(float[] floats) {
         }

         @Override
         public void onTextureDestroyed() {
             if (Looper.getMainLooper() != Looper.myLooper()) {  // Not the main thread
                 boolean stopped = xmagicState == XMagicImpl.XmagicState.STOPPED;
                 if (stopped || xmagicState == XMagicImpl.XmagicState.DESTROYED) {
                     if (mXMagic != null) {
                         mXMagic.onDestroy();
                     }
                 }
                 if (xmagicState == XMagicImpl.XmagicState.DESTROYED) {
                     TXUGCRecord.getInstance(UGCKit.getAppContext()).setVideoProcessListener(null);
                 }
             }
         }
     });
 }
4. Pause/Terminate the SDK:
onPause() is used to pause the beauty filter effect, which can be executed in the Activity/Fragment lifecycle method. The onDestroy method needs to be called in the GL thread (the onDestroy() of the XMagicImpl object can be called in the onTextureDestroyed method). For more information, see the onTextureDestroyed method in the sample code.
         @Override
         public void onTextureDestroyed() {
             if (Looper.getMainLooper() != Looper.myLooper()) {  // Not the main thread
                 boolean stopped = xmagicState == XMagicImpl.XmagicState.STOPPED;
                 if (stopped || xmagicState == XMagicImpl.XmagicState.DESTROYED) {
                     if (mXMagic != null) {
                         mXMagic.onDestroy();
                     }
                 }
                 if (xmagicState == XMagicImpl.XmagicState.DESTROYED) {
                     TXUGCRecord.getInstance(UGCKit.getAppContext()).setVideoProcessListener(null);
                 }
             }
         }
5. Add the beauty filter panel to the layout:
 <RelativeLayout
     android:id="@+id/panel_layout"
     android:layout_width="match_parent"
     android:layout_height="wrap_content"
     android:layout_alignParentBottom="true"
     android:visibility="gone"/>
6. Create a beauty filter object and add the beauty filter panel.
private void initXMagic() {
    if (mXMagic == null) {
        mXMagic = new XMagicImpl(mActivity, getBeautyPanel());
    } else {
        mXMagic.onResume();
    }
}
For detailed directions, see the UGCKitVideoRecord class of the demo.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon