SDK Introduction
Product introduction
This product consists of three parts: a console, a client SDK, and a mini program development tool (IDE).
Console: The product console, which includes mini program management, client superapp management, and mini program operations management.
Client: A mobile client superapp integrated with the mini program SDK; the SDK provides the runtime environment for mini programs within the client superapp.
Developer tool (IDE): Mini program developers use the IDE for development, debugging, and version submission; they use the mini program preview assistant to preview and validate mini programs on the mobile client.
Mini program SDK working principle
The mini program SDK provides the runtime environment for mini programs within the client superapp. It communicates with the product backend to retrieve mini program information and loads and runs the mini program within the SDK’s runtime environment.
To reduce package size and minimize system permissions and feature controls, the SDK is divided into a core library (TCMPPSDK) and extension libraries (TCMPPExtXXX). Most functionalities can be achieved by integrating only the core library, which does not require additional system permission requests. Integrating just the core library adds about 4 MB to the final app installation package.
Explanation of the mini program SDK
To reduce the original package size of the mini program SDK and facilitate modular functionality, the mini program SDK is divided into two categories: the core SDK (TCMPPSDK) and the mini program extension SDKs.
Mini program core SDK: Provides the minimal environment needed to load and run mini programs. Users must integrate the core SDK to access the basic capabilities of mini programs.
Mini program extension component SDKs: Provide richer SDK features that users can integrate based on their specific needs.
Size impact of various mini program SDK modules on superapp, using SDK version v2.3.1 as an example:
Module | Description | Increased download size (MB) | Increased installed size(MB) |
TCSAS | Core library | 2.54 | 7.53 |
TCSASBaseLib | preset base library | 1.38 | 5.82 |
TCMPPExtMiniGame | game extension library | 0.59 | 1.93 |
TCMPPExtScanCode | scan code extension library | 0.19 | 0.26 |
TCMPPExtMedia | media extension library | 0.26 | 1.02 |
TCMPPExtLBS | location extension library | 0.06 | 0.19 |
TCMPPExtBLE | Bluetooth extension library | 0.03 | 0.09 |
TCMPPExtContact | contacts extension library | 0 | 0.02 |
TCMPPExtClipBoard | clipboard extension library | 0 | 0 |
TCMPPExtCalendar | calendar extension library | 0 | 0 |
TCMPPExtAuthentication | authentication extension library | 0 | 0 |
TCMPPExtNetwork | network extension library | 0.01 | 0.04 |
TCMPPExtMDNS | MDNS extension library | 0 | 0.02 |
TCMPPExtMp3Encoder | MP3 extension library | 0.14 | 0.34 |
TCSASExtGoogleAds | Google Ads extension library | 1.38 | 3.72 |
TCMPPExtLive+TCSASExtVodPlayer+TCSASExtPlaylet+TXLiteAVSDK_Professional | live streaming extension library + premium mobile player extension library + short video extension library | 10.91 | 26.72 |
TCMPPExtLive+TXLiteAVSDK_Live | live streaming extension library | 5.74 | 13.62 |
TCSASExtVodPlayer+TXLiteAVSDK_Player_Premium | premium mobile player extension library | 6.5 | 16.02 |
TCSASExtPlaylet+TXLiteAVSDK_Player_Premium | short drama extension library | 6.94 | 17.52 |
TCSASExtVodPlayer+TCSASExtPlaylet+TXLiteAVSDK_Player_Premium | premium mobile player extension library + short drama extension library | 6.94 | 17.52 |
Help and Support
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback