tencent cloud

Tencent Effect SDK

Release Notes and Announcements
Release Notes
Tencent Effect SDK V3.5 Version Released
Tencent Effects SDK V3.0 Version Related API and Material Changes
Product Introduction
Overview
Features
Basic Concepts
Strengths
Use Cases
Purchase Guide
Pricing Overview
Purchase Guide
Payment Overdue and Refund
Tutorial
Demos
Free Trial License
Licenses
Adding and Renewing a License (Mobile)
Adding and Renewing a License (Desktop)
Adding and Renewing a License (Web)
FAQs
SDK Download
Features
SDK Download
Version History
SDK Integration Guide(No UI)
General Integration of Tencent Effect
Integrating Capabilities
SDK Integration Guide(Including UI)
General Integration of Tencent Effect
Integrating Tencent Effect into MLVB SDK
Integrating Tencent Effect into TRTC SDK
Integrating Tencent Effect into UGSV SDK
Virtual Avatars
API Documentation
iOS
Android
Flutter
Web
Feature Guide
Reducing SDK Size
SDK Integration Issue Troubleshooting
Performance Fine-Tuning
Effect Fine-Tuning
Material Usage
Effect Parameters
Recommended Parameters in Beautification Scenarios
UGSV Enterprise Edition Migration Guide
Integrating Tencent Effect for Third-Party Publishers (Flutter)
Integrating Beauty AR Web into Mini Programs
Tencent Effect Studio Usage
Beauty AR Web
Overview
Quick Start
SDK Integration
Parameters and APIs
Console Guide
Demos
Preset Effect List
Practical Tutorial
FAQs
FAQs
General
Technical
License
Legacy Documentation
Recommended Parameters in Beautification Scenarios
Beauty Parameters Table
One-Minute Integration of TRTC
One-Minute Integration of Live Streaming
TE SDK Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us

iOS(3.3.0 and prior)

PDF
Focus Mode
Font Size
Last updated: 2024-07-05 12:35:44

Beautification

Brightening

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_WHITEN
propertyValue
30
extraInfo
nil

Smooth skin

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_SMOOTH
propertyValue
30
extraInfo
nil

Rosy skin

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_ROSY
propertyValue
30
extraInfo
nil

Contrast

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_CONTRAST
propertyValue
30
extraInfo
nil

Saturation

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_SATURATION
propertyValue
30
extraInfo
nil

Sharpness

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_CLEAR
propertyValue
30
extraInfo
nil

Big eyes

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_ENLARGE_EYE
propertyValue
30
extraInfo
nil

Slim face – natural

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_NATURE
propertyValue
30
extraInfo
@{@"reshape.basicFaceSubType":@"nature"}

Slim face – woman

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_GODNESS
propertyValue
30
extraInfo
@{@"reshape.basicFaceSubType":@"femaleGod"}

Slim face – man

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_MALE_GOD
propertyValue
30
extraInfo
@{@"reshape.basicFaceSubType":@"maleGod"}

V shape

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_V
propertyValue
30
extraInfo
nil

Slim jaw(V2.6.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_JAW
propertyValue
30
extraInfo
nil

Face width

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_THIN
propertyValue
30
extraInfo
nil

Face length

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_SHORT
propertyValue
30
extraInfo
nil

Face shape

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_BASIC
propertyValue
30
extraInfo
nil

Lipstick – retro red

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_LIPSTICK
propertyValue
30
extraInfo
@{@"beauty.lips.lipsMask":@"images/beauty/lips_fuguhong.png", @"beauty.lips.lipsType":@"2"}

Lipstick – peachy

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_LIPSTICK
propertyValue
30
extraInfo
@{@"beauty.lips.lipsMask":@"images/beauty/lips_mitaose.png", @"beauty.lips.lipsType":@"2"}

Lipstick – coral

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_LIPSTICK
propertyValue
30
extraInfo
@{@"beauty.lips.lipsMask":@"images/beauty/lips_shanhuju.png", @"beauty.lips.lipsType":@"2"}

Lipstick – pink

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_LIPSTICK
propertyValue
30
extraInfo
@{@"beauty.lips.lipsMask":@"images/beauty/lips_wenroufen.png", @"beauty.lips.lipsType":@"2"}

Lipstick – orange

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_LIPSTICK
propertyValue
30
extraInfo
@{@"beauty.lips.lipsMask":@"images/beauty/lips_huolicheng.png", @"beauty.lips.lipsType":@"2"}

Blush – light

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_RED_CHEEK
propertyValue
30
extraInfo
@{@"beauty.makeupMultiply.multiplyMask":@"images/beauty/saihong_jianyue.png"}

Blush – summer

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_RED_CHEEK
propertyValue
30
extraInfo
@{@"beauty.makeupMultiply.multiplyMask":@"images/beauty/saihong_shengxia.png"}

Blush – shy

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_RED_CHEEK
propertyValue
30
extraInfo
@{@"beauty.makeupMultiply.multiplyMask":@"images/beauty/saihong_haixiu.png"}

Blush – mature

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_RED_CHEEK
propertyValue
30
extraInfo
@{@"beauty.makeupMultiply.multiplyMask":@"images/beauty/saihong_chengshu.png"}

Blush – freckles

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_RED_CHEEK
propertyValue
30
extraInfo
@{@"beauty.makeupMultiply.multiplyMask":@"images/beauty/saihong_queban.png"}

Contour – natural

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_SOFTLIGHT
propertyValue
30
extraInfo
@{@"beauty.softLight.softLightMask":@"images/beauty/liti_ziran.png"}

Contour – smart

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_SOFTLIGHT
propertyValue
30
extraInfo
@{@"beauty.softLight.softLightMask":@"images/beauty/liti_junlang.png"}

Contour – bright

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_SOFTLIGHT
propertyValue
30
extraInfo
@{@"beauty.softLight.softLightMask":@"images/beauty/liti_guangmang.png"}

Contour – fresh

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_SOFTLIGHT
propertyValue
30
extraInfo
@{@"beauty.softLight.softLightMask":@"images/beauty/liti_qingxin.png"}

Cheekbones

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_THIN_CHEEKBONE
propertyValue
30
extraInfo
nil

Chin

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_THIN_CHIN
propertyValue
30
extraInfo
nil

Forehead

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_FOREHEAD
propertyValue
30
extraInfo
nil

Bright eyes

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYE_LIGHTEN
propertyValue
30
extraInfo
nil

Eye distance

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYE_DISTANCE
propertyValue
30
extraInfo
nil

Eye corners

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYE_ANGLE
propertyValue
30
extraInfo
nil

Eye width(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYE_WIDTH
propertyValue
30
extraInfo
nil

Eye height(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYE_HEIGHT
propertyValue
30
extraInfo
nil

Slim nose

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_NOSE_THIN
propertyValue
30
extraInfo
nil

Nose wings

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_NOSE_WING
propertyValue
30
extraInfo
nil

Nose position

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_NOSE_HEIGHT
propertyValue
30
extraInfo
nil

White teeth

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_TOOTH_WHITEN
propertyValue
30
extraInfo
nil

Wrinkle

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_REMOVE_WRINKLE
propertyValue
30
extraInfo
nil

Smile line

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_REMOVE_LAW_LINE
propertyValue
30
extraInfo
nil

Eye bags

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_REMOVE_EYE_BAGS
propertyValue
30
extraInfo
nil

Lip shape

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_SIZE
propertyValue
30
extraInfo
nil

Lip height

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_HEIGHT
propertyValue
30
extraInfo
nil

Lip width(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_WIDTH
propertyValue
30
extraInfo
nil

Lip position(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_MOUTH_POSITION
propertyValue
30
extraInfo
nil

Smile face(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_SMILE_FACE
propertyValue
30
extraInfo
nil

Eyebrow angle(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_ANGLE
propertyValue
30
extraInfo
nil

Eyebrow distance(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_DISTANCE
propertyValue
30
extraInfo
nil

Eyebrow height(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_HEIGHT
propertyValue
30
extraInfo
nil

Eyebrow length(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_LENGTH
propertyValue
30
extraInfo
nil

Eyebrow thickness(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_THICKNESS
propertyValue
30
extraInfo
nil

Eyebrow ridge(V3.0.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_EYEBROW_RIDGE
propertyValue
30
extraInfo
nil

Eye shadow(V3.1.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_EYE_SHADOW
propertyValue
30
extraInfo
@{
@"beauty.eyesMakeup.mask.eyeShadow" : @"/images/beauty/eyes_makeup_eye_shadow_0-albatross.png"
}
Description: Pass in a dictionary, where the key is @"beauty.eyesMakeup.mask.eyeShadow" and the value is the relative path of the effect image, such as @"/images/beauty/eyes_makeup_eye_shadow_0-albatross.png". Please refer to the demo for specific beauty effects.

Eye Liner(V3.1.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_EYE_LINER
propertyValue
30
extraInfo
@{
@"beauty.eyesMakeup.mask.eyeLiner" : @"/images/beauty/eyes_makeup_eye_liner_0.png"
}
Description: Pass in a dictionary, where the key is @"beauty.eyesMakeup.mask.eyeLiner" and the value is the relative path of the effect image, such as @"/images/beauty/eyes_makeup_eye_liner_0.png". Please refer to the demo for specific beauty effects.

Eyelash(V3.1.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_EYELASH
propertyValue
30
extraInfo
@{
@"beauty.eyesMakeup.mask.eyelash" : @"/images/beauty/eyes_makeup_eyelash_0.png"
}
Description: Pass in a dictionary, where the key is @"beauty.eyesMakeup.mask.eyelash" and the value is the relative path of the effect image, such as @"/images/beauty/eyes_makeup_eyelash_0.png". Please refer to the demo for specific beauty effects.

EyeBrow(V3.1.0)

Field
Value
propertyType
Category_BEAUTY
propertyName
BEAUTY_FACE_EYELASH
propertyValue
30
extraInfo
@{
@"beauty.eyesMakeup.mask.eyebrow" : @"/images/beauty/eyes_makeup_eyebrow_0.png"
}
Description: Pass in a dictionary, where the key is @"beauty.eyesMakeup.mask.eyebrow" and the value is the relative path of the effect image, such as @"/images/beauty/eyes_makeup_eyebrow_0.png". Please refer to the demo for specific beauty effects.

Body retouch

Slim

Field
Value
propertyType
body
propertyName
BODY_AUTOTHIN_BODY_STRENGTH
propertyValue
30
extraInfo
nil

Long legs

Field
Value
propertyType
body
propertyName
BODY_LEG_STRETCH
propertyValue
30
extraInfo
nil

Thin legs

Field
Value
propertyType
body
propertyName
BODY_SLIM_LEG_STRENGTH
propertyValue
30
extraInfo
nil

Slim waist

Field
Value
propertyType
body
propertyName
BODY_WAIST_STRENGTH
propertyValue
30
extraInfo
nil

Slim shoulder

Field
Value
propertyType
body
propertyName
BODY_THIN_SHOULDER_STRENGTH
propertyValue
30
extraInfo
nil

Head size

Field
Value
propertyType
body
propertyName
BODY_SLIM_HEAD_STRENGTH
propertyValue
30
extraInfo
nil

Enlarge Chest(V3.0.0)

Field
Value
propertyType
body
propertyName
BODY_ENLARGE_CHEST_STRENGTH
propertyValue
30
extraInfo
nil

Filters

None

Field
Value
propertyType
Category_LUT
propertyName
XmagicProperty_ID_NONE
propertyValue
30
extraInfo
nil

White (example)

Field
Value
propertyType
Category_LUT
propertyName
lut.bundle/n_baixi.png
propertyValue
30
extraInfo
nil

Others

Field
Value
propertyType
Category_LUT
propertyName
The path of the filter image. You can refer to the demo. If the image is one of the bundle resources, you can use a relative path; otherwise, use an absolute path.
propertyValue
30
extraInfo
nil

Animated effects

None

Field
Value
propertyType
Category_MOTION
propertyName
XmagicProperty_ID_NONE
propertyValue
xxxxxx/2dMotionRes.bundle
extraInfo
nil

Cute graffiti

Field
Value
propertyType
Category_MOTION
propertyName
video_keaituya
propertyValue
xxxxxx/2dMotionRes.bundle
extraInfo
nil

Names of animated effect materials

Field
Value
propertyType
Category_MOTION
propertyName
The name of the material folder (refer to the demo).
propertyValue
The absolute path of the material folder (refer to the demo).
extraInfo
nil

Makeup

To use a makeup effect, you need to first configure it as an animated effect and then configure the makeup effect. For details, see the demo.

None

Field
Value
propertyType
Category_MOTION
Category_MAKEUP
propertyName
XmagicProperty_ID_NONE
BeautyConstant_MAKEUP
propertyValue
xxxxxx/makeupMotionRes.bundle
0
extraInfo
nil
nil

Girl group

Field
Value
propertyType
Category_MOTION
Category_MAKEUP
propertyName
video_nvtuanzhuang
BeautyConstant_MAKEUP
propertyValue
xxxxxx/makeupMotionRes.bundle
30
extraInfo
nil
nil

Names of makeup materials

Field
Value
propertyType
Category_MOTION
Category_MAKEUP
propertyName
The name of the material folder (refer to the demo).
BeautyConstant_MAKEUP
propertyValue
The absolute path of the material folder (refer to the demo).
30
extraInfo
nil
nil

Keying

None

Field
Value
propertyType
Category_MOTION
propertyName
XmagicProperty_ID_NONE
propertyValue
xxxxxx/segmentMotionRes.bundle
extraInfo
nil

Background blurring-weak

Field
Value
propertyType
Category_MOTION
propertyName
video_segmentation_blur_45
propertyValue
xxxxxx/segmentMotionRes.bundle
extraInfo
@{@"bgName":@"BgSegmentation.bg.png", @"bgType":@0, @"timeOffset": @0}

Names of keying materials

Field
Value
propertyType
Category_MOTION
propertyName
The name of the material folder (refer to the demo).
propertyValue
The absolute path of the material folder (refer to the demo).
extraInfo
@{@"bgName":@"BgSegmentation.bg.png", @"bgType":@0, @"timeOffset": @0}

Custom keying

Field
Value
propertyType
Category_MOTION
propertyName
video_empty_segmentation
propertyValue
The absolute path of the custom keying material.
extraInfo
bgName: The absolute path of the image or video.
bgType: For an image, pass in 0; for a video, pass in 1.
timeOffset: For an image, pass in 0; for a video, pass in the video duration (@{@"bgName":bgName, @"bgType":bgType, @"timeOffset": timeOffset}). For details, refer to the demo.


Help and Support

Was this page helpful?

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

Feedback