tencent cloud

Tencent Effect SDK

DocumentationTencent Effect SDK SDK Integration Guide（Including UI）Integrating Tencent Effect into UGSV SDKiOS

iOS

Download
Focus Mode
Font Size
Last updated: 2026-10-10 11:33:56
This documentation explains integrating and using the TEBeautyKit library in the XiaoShiPin project.
Refer to demo package.

Integration Steps

1. Integration TEBeautyKit，Edit the Podfile and append the following code snippet and execution pod install.
# Replace S1-07 with the package you purchased
pod 'TEBeautyKit/S1-07', :podspec => 'https://mediacloud-76607.gzc.vod.tencent-cloud.com/TencentEffect/iOS/TEBeautyKit/latest/TEBeautyKit.podspec'
2. Integration Panel Resources，download the resource package and incorporate it into your main project. The contents can be found in the appendix.
3. Integration Effect Resources.

Usage Guide

Step 1. Authenticate

After the application is launched, a beauty filter authentication must be performed to enable the normal use of beauty features. See the authentication error code
[TEBeautyKit setTELicense:@"your license" key:@"your key" completion:^(NSInteger authresult, NSString * _Nullable errorMsg) {
  NSLog(@"----------result: %zd  %@",authresult,errorMsg);
}];

Step 2. Configuration Panel Resource Path

The beauty data and icon assets on the beauty panel are available in beauty_panel.zip. As per the API documentation, you may pass the corresponding JSON file path and customize the settings according to your specific requirements. 
- (void)configPanel {
    NSBundle *bundle = [NSBundle mainBundle];
    NSString *beautyJsonPath = [bundle pathForResource:@"beauty" ofType:@"json"]; //Beauty
    NSString *lutJsonPath = [bundle pathForResource:@"lut" ofType:@"json"]; //filter
    NSString *motion2dJsonPath = [bundle pathForResource:@"motion_2d" ofType:@"json"]; //2D stickers
    NSMutableArray *resArray = [[NSMutableArray alloc] init];
    [resArray addObject:@{TEUI_BEAUTY : beautyJsonPath}];
    [resArray addObject:@{TEUI_LUT : lutJsonPath}];
    [resArray addObject:@{TEUI_MOTION_2D : motion2dJsonPath}];
    /// Set up resources
    [[TEUIConfig shareInstance] setTEPanelViewResources:resArray];
}

Step 3. Initialize and incorporate TEPanelView

TEPanelView is a custom panel view used to display the data configured in Step 2.
- (void)addPanelView {
    TEPanelView *tePanelView = [[TEPanelView alloc] init];
    tePanelView.delegate = self;
    [self.view addSubview:tePanelView];
    [tePanelView mas_makeConstraints:^(MASConstraintMaker *make) {
        make.width.bottom.mas_equalTo(self.view);
        make.left.right.mas_equalTo(self.view);
        make.height.mas_equalTo(230 + self.view.safeAreaInsets.bottom);
    }];
}

Step 4: Use beauty filters.

1. Initialization
- (void)initXMagic {
    __weak __typeof(self)weakSelf = self;
    [TEBeautyKit createXMagic:EFFECT_MODE_PRO onInitListener:^(TEBeautyKit * _Nullable beautyKit) {
        __strong typeof(self)strongSelf = weakSelf;
        strongSelf.teBeautyKit = beautyKit;
        strongSelf.tePanelView.teBeautyKit = strongSelf.teBeautyKit;
        [strongSelf.tePanelView setDefaultBeauty];
        [strongSelf.teBeautyKit setLogLevel:YT_SDK_ERROR_LEVEL];
        [strongSelf.teBeautyKit registerSDKEventListener:strongSelf];
    }];
}
2. Processing video data
- (GLuint)onPreProcessTexture:(GLuint)texture width:(CGFloat)width height:(CGFloat)height {
    YTProcessOutput *output = [self.teBeautyKit processTexture:texture
                                                  textureWidth:width
                                                 textureHeight:height
                                                    withOrigin:YtLightImageOriginTopLeft
                                               withOrientation:YtLightCameraRotation0];
    return output.textureData.texture;
}
3. Destroy Beauty Filter
- (void)destroyXMagic {
   [self.teBeautyKit onDestroy];
   self.teBeautyKit = nil;
}
Previous Topic: FlutterNext Topic: Android

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Search
    Enter keywords to search documentation