tencent cloud

文档反馈

扩展组件 SDK

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

    扩展 SDK 接入及使用

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

    TCMPPExtMedia

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

    TCMPPExtScanCode

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

    TCMPPExtQMap

    TCMPPSDKExtQMap 为中国大陆地区的用户提供腾讯地图 SDK 的相关能力。
    使用方式
    pod "TCMPPSDKExtQMap"
    在腾讯地图开放平台申请 appkey 并在代码中进行设置:
    [TMFAppletQMapComponent setQMapApiKey:@"XXXXXXXXXXX"];

    TCMPPExtBaiduMap

    TCMPPSDKExtBaiduMap 为中国大陆地区的用户提供百度地图 SDK 的相关能力。
    使用方式
    pod "TCMPPExtBaiduMap"
    在百度地图开放平台申请 appkey 并在代码中进行设置:
    [TMFAppletBaiduMapComponent setBaiduMapApiKey:@"XXXXXXXXXXX"];

    TCMPPExtAMap

    TCMPPSDKExtBaiduMap 为中国大陆地区的用户提供高德地图 SDK 的相关能力。
    使用方式
    pod "TCMPPExtAMap"
    在高德地图开放平台申请 appkey 并在代码中进行设置:
    [TMFAppletAMapComponent setAMapApiKey:@"XXXXXXXXXXX"];
    添加腾讯、百度、高德地图扩展 SDK 后,增加支持的小程序 API 列表如下:
    API 名称
    说明
    地图
    支持地图相关接口,包括地图展示,使用地图选择位置以及查询 POI 等
    涉及权限:
    权限
    描述
    定位权限
    需要使用定位权限用于显示地图定位

    TCMPPExtLive

    如果您需要使用直播组件(live-player 和 live-pusher)进行直播推、拉流相关场景的开发,需要添加如下 SDK 以支持直播组件相关的功能的实现。
    pod "TCMPPSDKExtLive"
    pod 'TXLiteAVSDK_Professional', :podspec => 'https://liteav.sdk.qcloud.com/pod/liteavsdkspec/TXLiteAVSDK_Professional.podspec'
    除了完成以上依赖的添加,您还需要实现 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
    罗盘、加速计、设备方向、陀螺仪
    一系列的api

    TCMPPExtMDNS

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

    TCMPPExtNetwork

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

    TCMPPExtMp3Encoder

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

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持