tencent cloud

扩展组件SDK
最后更新时间:2025-11-13 15:34:13
扩展组件SDK
最后更新时间: 2025-11-13 15:34:13
在开发、使用中,很多需要系统授权的 API 需要在项目的 info.plist 文件中进行预置授权,但您的 App 可能并不需要此功能,所以 SDK 拆分出了扩展 SDK,这样免去了不必要的授权,也缩小了核心模块的体积。
SDK 引擎提供核心模块及扩展模块,方便使用者根据自己的情况进行接入。

扩展 SDK 接入及使用

扩展 SDK 是对核心 SDK 的补充,所以要使用扩展 SDK,也必须依赖核心 SDK。为了保证 SDK 的安全稳定性,将需要权限的 API 尽可能放到扩展 SDK,引擎将 SDK 拆分为核心 SDK 与扩展 SDK,后者是前者的补充,因此使用扩展 SDK 也必须依赖核心 SDK。

TCMPPExtMedia

TCMPPExtMedia 提供 chooseMedia,chooseVideo,chooseImage 三个接口的默认实现,如果 SuperApp 已经有对应能力,建议在开放接口中实现,如果需要使用 SAS 提供的多媒体选择插件,需要使用该插件。
使用方式:
pod 'TCMPPExtMedia'
在 info.plist 文件中添加:Privacy - Photo Library Usage Description
添加 Media 扩展 SDK 后,增加支持的小程序 API 列表如下:
API 名称
说明
wx.chooseMedia
选择照片或视频
wx.chooseVideo
选择视频
wx.chooseImage
选择照片
涉及权限:
权限
描述
图库访问权限
需要申请访问图库的权限

TCMPPExtScanCode

TCMPPExtScanCode 提供 wx.scanCode 的处理逻辑,如果 SuperApp 本身已经有扫码识别能力,建议通过。
TMFMiniAppSDKDelegate.scanCode:(NSDictionary *)scanParams navigationController:(UINavigationController *)navigationController completionHandler:(MACommonCallback)completionHandler;
对接已经正常使用的扫码模块,如果需要使用 SDK 提供的扫码功能,可以使用该插件。
使用方式:
pod 'TCMPPExtScanCode'
在 info.plist 文件中添加:Privacy - Camera Usage Description
添加扫码扩展 SDK 后,增加支持的小程序 API 列表如下:
API 名称
说明
wx.scanCode
调起客户端扫码界面进行扫码
涉及权限:
权限
描述
相机权限
需要申请相机权限用于扫码
图库访问权限
需要申请访问图库的权限

TCMPPExtLive

如果您需要使用直播组件(live-player 和 live-pusher)进行直播推、拉流相关场景的开发,需要参考直播SDK文档选择集成直播播放器,TXLiteAVSDK_Live或TXLiteAVSDK_Professional。并且需要添加如下 SDK 以支持直播组件相关的功能的实现。
若仅集成TXLiteAVSDK_Live则只能使用直播功能和普通的video播放功能,Podfile示例如下:
platform :ios, '9.0'
source 'https://github.com/CocoaPods/Specs.git'

target 'App' do
pod 'TXLiteAVSDK_Live'
end
若既需要使用直播推拉流和云点播播放功能,则需要集成TXLiteAVSDK_Professional,示例如下:
pod "TCMPPExtLive"
pod "TXLiteAVSDK_Professional"
除了完成以上依赖的添加,您还需要实现 TMFMiniAppSDKDelegate 中的如下方法,提供直播组件需要的 LicenseUrl 和 LicenseKey,以完成直播组件的初始化信息配置;如果您未配置正确的 LicenseUrl 和 LicenseKey,会导致直播组件功能不可用。
说明:
LicenseUrl 和 LicenseKey 的获取方式可以参考《新增与续期 License 》
- (NSString *)setLiveLicenceURL {
return @"https://xxx.license";
}

- (NSString *)setLiveLicenceKey {
return @"xxx";
}
在 info.plist 文件中添加:
Privacy - Camera Usage Description
Privacy - Microphone Usage Description
添加直播扩展 SDK 后,增加支持的小程序 API 列表如下:
API 名称
说明
wx.createLivePusherContext
创建直播推流端 context
LivePusherContext
支持 LivePusherContext 相关接口
wx.createLivePlayerContext
创建直播拉流端 context
LivePlayerContext
支持 LivePlayerContext 相关接口
组件
-
live-pusher
推流标签
live-player
播放标签
涉及权限如下:
权限名称
描述
相机权限
-
录音权限
-

TCMPPExtAuthentication

TCMPPExtAuthentication 提供生物认证相关的能力。
集成方式:
pod "TCMPPExtAuthentication"
使用说明:
在 info.plist 文件中添加:Privacy - Face ID Usage Description
添加生物认证扩展 SDK 后,增加支持的小程序 API 列表如下:
API 名称
说明
wx.startSoterAuthentication
-
wx.checkIsSupportSoterAuthentication
-
wx.checkIsSoterEnrolledInDevice
-
涉及权限:
权限
描述
生物认证访问
需要生物认证权限

TCMPPExtBLE

TCMPPExtBLE 提供低功耗蓝牙及信标相关的能力。
集成方式:
pod "TCMPPExtBLE"
使用说明:
在 info.plist 文件中添加:
Privacy - Bluetooth Always Usage Description
Privacy - Bluetooth Peripheral Usage Description
添加 LBS 扩展 SDK 后,增加支持的小程序 API 列表如下:
API
说明
蓝牙-通用
蓝牙通用接口
蓝牙-低功耗外围设备
外围设备相关接口
蓝牙-低功耗中心设备
中心设备相关接口
蓝牙-信标
蓝牙信标相关接口
蓝牙扩展 SDK 涉及权限如下:
权限
说明
蓝牙
操作蓝牙需要申请蓝牙权限
定位
蓝牙设备搜索依赖定位权限

TCMPPExtCalendar

TCMPPExtCalendar 提供日历相关的能力。
集成方式:
pod "TCMPPExtCalendar"
使用说明:
在 info.plist 文件中添加:
Privacy - Calendars Usage Description
Privacy - Reminders Usage Description
API 列表:
API 名称
API 描述信息
addPhoneRepeatCalendar
向系统日历添加重复事件
addPhoneCalendar
向系统日历添加事件

TCMPPExtClipBoard

TCMPPExtClipBoard 提供剪贴板相关的能力。
集成方式:
pod "TCMPPExtClipBoard"
API 列表:
API 名称
API 描述信息
setClipboardData
设置系统剪贴板的内容
getClipboardData
获取系统剪贴板的内容

TCMPPExtContact

TCMPPExtContact 提供联系人相关的能力。
集成方式:
pod "TCMPPExtContact"
使用说明:
在 info.plist 文件中添加:Privacy - Contacts Usage Description
API 列表:
API 名称
API 描述信息
chooseContact
选择联系人
addPhoneContact
添加手机通讯录联系人

TCMPPExtLBS

TCMPPExtLBS 提供系统定位、系统地图、罗盘、加速计、设备方向、陀螺仪相关的能力。
集成方式:
pod "TCMPPExtLBS"
使用说明:
在 info.plist 文件中添加:
Privacy - Location Always and When In Use Usage Description
Privacy - Location Always Usage Description
Privacy - Location Usage Description
Privacy - Location When In Use Usage Description
Privacy - Motion Usage Description
API 列表:
API 名称
API 描述信息
定位
一系列的 api 位置
系统地图
一系列的 api 地图组件
罗盘、加速计、设备方向、陀螺仪

TCMPPExtMDNS

TCMPPExtMDNS 提供局域网通信的能力。
集成方式:
pod "TCMPPExtMDNS"
使用说明:
在info.plist 文件中添加:
Privacy - Local Network Usage Description
Privacy - Bonjour services
API 列表:
API 名称
API 描述信息
MDNS
一系列的 api mDNS

TCMPPExtNetwork

TCMPPExtNetwork 提供 TCP/UDP 通信的能力。
集成方式:
pod "TCMPPExtNetwork"
使用说明:
在 info.plist 文件中添加:
App Transport Security Settings
Allow Arbitrary Loads - YES
Privacy - Bonjour services
API 列表:
API名称
API 描述信息
TCP
一系列的 api TCP 通信
UDP
一系列的 api UDP 通信

TCMPPExtMp3Encoder

TCMPPExtMp3Encoder 提供使用 RecorderManager 时保存为 mp3 格式的能力。
集成方式:
pod "TCMPPExtMp3Encoder"
使用说明:
TCSAS 提供的录音保存成 mp3格式依赖 Lame 库,Lame 库开源协议基于 GNU Library or Lesser General Public License version 2.0 (LGPLv2), GNU General Public License version 2.0 (GPLv2) 参考:LAME,使用者可以根据需要集成。

TCMPPExtMiniGame

TCMPPExtMiniGame 提供小游戏运行能力。
集成方式:
pod "TCMPPExtMiniGame"
使用说明:
请注意:TCMPPExtMiniGame 目前只支持真机运行调试,不支持模拟器运行

TCSASExtGoogleAds

TCSASExtGoogleAds 提供GoogleAdmob广告加载支持。
集成方式:
pod "TCSASExtGoogleAds"
使用说明:
请注意:该功能依赖AdMob,请先按照官方文档接入 Admob

TCSASBaseLib

TCSASBaseLib 提供基础库的预置,减少小程序首次打开时等待时间。
集成方式:
pod "TCSASBaseLib"


TCSASExtVodPlayer

TCSASExtVodPlayer 提供底层实现为云点播播放器的video组件,集成后即可使用DRM视频播放高级功能。
说明:
默认预加载大小2 MB。
视频自动播放场景下默认缓冲大小为30s*视频码率。
视频非自动播放场景下优先加载默认预加载值(2 MB),后续默认缓冲值5 MB。
集成方式:
pod "TCSASExtVodPlayer"
需要参考云点播文档选择集成播放器 TXLiteAVSDK_Player_Premium 或 TXLiteAVSDK_Professional。
使用 CocoaPods 官方源,支持选择版本号。Podfile 文件示例如下:
platform :ios, '9.0'
source 'https://github.com/CocoaPods/Specs.git'

target 'App' do
pod 'TXLiteAVSDK_Player_Premium'
end
如果还用到TCMPPExtLive扩展库,则需要集成TXLiteAVSDK_Professional,实现直播的推流功能:
platform :ios, '9.0'
source 'https://github.com/CocoaPods/Specs.git'

target 'App' do
pod 'TXLiteAVSDK_Professional'
end
除了完成以上依赖的添加,您还需要实现 TMFMiniAppSDKDelegate 中的如下方法,提供直播组件需要的 LicenseUrl 和 LicenseKey,以完成video组件的初始化信息配置;如果您未配置正确的 LicenseUrl 和 LicenseKey,会导致直播组件功能不可用。
说明:
LicenseUrl 和 LicenseKey 的获取方式可以参考《新增与续期 License 》
- (NSString *)setLiveLicenceURL {
return @"https://xxx.license";
}

- (NSString *)setLiveLicenceKey {
return @"xxx";
}
集成TCSASExtVodPlayer后则默认使用高级播放器,若在TMFMiniAppSDKDelegate已实现如下代理,则你可根据app或params选择创建对应的播放器。
- (id<TMAVideoPlayerDelegate>)app:(TMFMiniAppInfo *_Nonnull)app createVideoViewWithFrame:(CGRect)frame andVideoParams:(NSDictionary *)params;
在 info.plist 文件中添加:
Privacy - Camera Usage Description
Privacy - Microphone Usage Description
添加扩展 SDK 后,增加支持的小程序 API 列表如下:
API 名称
说明
video组件
媒体组件视频一系列的 api
涉及权限如下:
权限名称
描述
相机权限
使用相机拍摄视频
录音权限
播放音视频

TCMPPExtQMap

TCMPPExtQMap 提供腾讯地图功能。
集成方式:
pod "TCMPPExtQMap"
在腾讯地图开放平台申请 appkey 并在代码中进行设置:
[TMFAppletQMapComponent setQMapApiKey:@"XXXXXXXXXXX"];
在 info.plist 文件中添加:
Privacy - Location Always and When In Use Usage Description
Privacy - Location Always Usage Description
Privacy - Location Usage Description
Privacy - Location When In Use Usage Description
API 列表:
API 名称
API 描述信息
定位
一系列的 api 位置
地图
一系列的 api 地图组件
若使用离线地图功能,需要通过实现 TMFMiniAppSDKDelegate 协议中的 stringWithConfigKey,根据TMA_SK_MINIAPP_QMapOffline_Enabled此key返回0或者1,默认0表示未开启。
示例代码:
- (NSString *)stringWithConfigKey:(NSString *)key {
if([key isEqualToString:TMA_SK_MINIAPP_QMapOffline_Enabled]) {
return @"1";
}
return nil;
}

本页内容是否解决了您的问题?
您也可以 联系销售 提交工单 以寻求帮助。

文档反馈