using UnityEngine; using System; namespace WeChatWASM { /// /// 微信SDK对外暴露的API /// public class WXBase { #region env /// /// 微信提供了一个用户文件目录给开发者,开发者对这个目录有完全自由的读写权限。通过 WX.env.USER_DATA_PATH 可以获取到这个目录的路径。 /// public static WXEnv env { get { return WXSDKManagerHandler.Env; } } #endregion #region cloud /// /// 云函数 /// public static Cloud cloud { get { return WXSDKManagerHandler.cloud; } } #endregion #region 初始化SDK /// /// 初始化SDK /// /// 初始化完毕后回调,请回调后再执行游戏主逻辑 public static void InitSDK(Action callback) { WXSDKManagerHandler.Instance.InitSDK(callback); } #endregion #region 数据上报 /// /// 游戏开始运行时上报 /// public static void ReportGameStart() { WXSDKManagerHandler.Instance.ReportGameStart(); } /// /// 设置游戏当前阶段,通知插件侧游戏当前所处阶段,便于用户退出或异常发生时,独立域插件能上报游戏当前阶段 /// /// 自定义的阶段id,id>=200, id<=10000 public static void SetGameStage(int stageType) { WXSDKManagerHandler.Instance.SetGameStage(stageType); } /// /// 上报当前自定义阶段耗时 /// /// 自定义阶段耗时,没有就传0 /// 上报的额外信息,json序列化字符串 public static void ReportGameStageCostTime(int costTime, string extJsonStr) { WXSDKManagerHandler.Instance.ReportGameStageCostTime(costTime, extJsonStr); } /// /// 上报当前自定义阶段错误信息 /// /// 错误类型, 取值范围0-10000 /// 错误信息 /// 上报的额外信息,json序列化字符串 public static void ReportGameStageError(int errorType, string errStr, string extJsonStr) { WXSDKManagerHandler.Instance.ReportGameStageError(errorType, errStr, extJsonStr); } /// /// 向日志管理器中写log /// 日志管理器文档:https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.html /// /// log信息 public static void WriteLog(string str) { WXSDKManagerHandler.Instance.WriteLog(str); } /// /// 向日志管理器中写warn /// 日志管理器文档:https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.html /// /// warn信息 public static void WriteWarn(string str) { WXSDKManagerHandler.Instance.WriteWarn(str); } public static void HideLoadingPage() { WXSDKManagerHandler.Instance.HideLoadingPage(); } /// /// 控制预载并发数 /// /// 并发数,取值范围[1, 10] public static void PreloadConcurrent(int count) { WXSDKManagerHandler.Instance.PreloadConcurrent(count); } /// /// 用于分支相关的UI组件(一般是按钮)相关事件的上报,事件目前有曝光、点击两种 /// /// 分支ID,在「小程序管理后台」获取 /// 自定义维度 /// 事件类型,1:曝光; 2:点击 public static void ReportUserBehaviorBranchAnalytics(string branchId, string branchDim, int eventType) { WXSDKManagerHandler.Instance.ReportUserBehaviorBranchAnalytics(branchId, branchDim, eventType); } #endregion #region 本地存储 // 更多关于存储的隔离策略和清理策略说明可以查看这里 https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html /* * @description 同步设置int型数据存储, * @param key 键名 * @param value 数值 */ public static void StorageSetIntSync(string key, int value) { WXSDKManagerHandler.Instance.StorageSetIntSync(key, value); } /* * @description 同步获取之前设置过的int型数据, * @param key 键名 * @param defaultValue 默认值 * @returns 异常的和空时候会返回默认值 */ public static int StorageGetIntSync(string key, int defaultValue) { return WXSDKManagerHandler.Instance.StorageGetIntSync(key, defaultValue); } /* * @description 同步设置string型数据存储, * @param key 键名 * @param value 数值 */ public static void StorageSetStringSync(string key, string value = "") { WXSDKManagerHandler.Instance.StorageSetStringSync(key, value); } /* * @description 同步获取之前设置过的string型数据, * @param key 键名 * @param defaultValue 默认值 * @returns 异常的和空时候会返回默认值 */ public static string StorageGetStringSync(string key, string defaultValue) { return WXSDKManagerHandler.Instance.StorageGetStringSync(key, defaultValue); } /* * @description 同步设置float型数据存储, * @param key 键名 * @param value 数值 */ public static void StorageSetFloatSync(string key, float value) { WXSDKManagerHandler.Instance.StorageSetFloatSync(key, value); } /* * @description 同步获取之前设置过的float型数据, * @param key 键名 * @param defaultValue 默认值 * @returns 异常的和空时候会返回默认值 */ public static float StorageGetFloatSync(string key, float defaultValue) { return WXSDKManagerHandler.Instance.StorageGetFloatSync(key, defaultValue); } /* * @description 同步删除所有数据 */ public static void StorageDeleteAllSync() { WXSDKManagerHandler.Instance.StorageDeleteAllSync(); } /* * @description 同步删除对应一个key的数据 * @param key 键名 */ public static void StorageDeleteKeySync(string key) { WXSDKManagerHandler.Instance.StorageDeleteKeySync(key); } /* * @description 判断一个key是否有值 * @param key 键名 * @returns true:有,false:没有 */ public static bool StorageHasKeySync(string key) { return WXSDKManagerHandler.Instance.StorageHasKeySync(key); } #endregion #region 用户信息 /// /// 创建用户信息按钮,这里是在屏幕上额外创建一块透明区域,其为点击区域,用户点击后,就会请求用户授权获取用户信息。游戏中的该区域最好为按钮区域,这样就能看起来用户是在点击游戏中的按钮 /// /// x 左上角横坐标(以屏幕左上角为0) /// y 左上角纵坐标(以屏幕左上角为0) /// 区域宽度 /// 区域高度 /// 显示用户信息的语言 可取(en,zh_CN,zh_TW)的一个 /// 是否带上登录态信息。当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。 /// 返回对象用于后续控制该透明区域的点击,展示和隐藏等行为 public static WXUserInfoButton CreateUserInfoButton(int x, int y, int width, int height, string lang, bool withCredentials) { return WXSDKManagerHandler.Instance.CreateUserInfoButton(x, y, width, height, lang, withCredentials); } #endregion #region 分享转发 /// /// 监听用户点击右上角菜单的「转发」按钮时触发的事件 /// /// 默认的设置内容 /// 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数,请在回调后三秒内,触发 Action返回设置的内容,否则会使用 defaultParam public static void OnShareAppMessage(WXShareAppMessageParam defaultParam, Action> action = null) { WXSDKManagerHandler.Instance.OnShareAppMessage(defaultParam, action); } #endregion #region 广告 /// /// banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。 使用可参考 https://developers.weixin.qq.com/minigame/dev/guide/open-ability/ad/banner-ad.html /// /// param各字段说明详见这里,https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createBannerAd.html /// 对banner广告做操作的对象,详见 https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.html /// /// // 底部banner广告示例 /// var sysInfo = WX.GetSystemInfoSync(); /// var banner = WX.CreateBannerAd(new WXCreateBannerAdParam() /// { /// adUnitId = "adunit-2e20328227ca771b", /// adIntervals = 30, /// style = new Style() /// { /// left = 0, /// top = sysInfo.windowHeight - 100, /// width = sysInfo.windowWidth, /// height = 100 /// } /// }); /// banner.OnError((WXADErrorResponse res)=> /// { /// Debug.Log("bannerad error response"); /// }); /// banner.OnLoad(()=> { /// banner.Show(); /// }); /// banner.OnResize((WXADResizeResponse res) => /// { /// //拉取的广告可能跟设置的不一样,需要动态调整位置 /// banner.style.top = sysInfo.windowHeight - res.height; /// }); /// public static WXBannerAd CreateBannerAd(WXCreateBannerAdParam param) { return WXSDKManagerHandler.Instance.CreateBannerAd(param); } /// /// 这个方法提供一个固定在底部,且固定高度,且水平居中的bannerAd,此方法不需要再手动监听OnResize事件调整位置了 /// /// 广告单元 id /// 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(该参数不传入时 Banner 广告不会自动刷新) /// 要固定的高度 /// 对banner广告做操作的对象,详见 https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.html public static WXBannerAd CreateFixedBottomMiddleBannerAd(string adUnitId, int adIntervals, int height) { return WXSDKManagerHandler.Instance.CreateFixedBottomMiddleBannerAd(adUnitId, adIntervals, height); } /// /// 激励视频广告 详细参见 https://developers.weixin.qq.com/minigame/dev/guide/open-ability/ad/rewarded-video-ad.html /// /// /// 广告操作对象,https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.html public static WXRewardedVideoAd CreateRewardedVideoAd(WXCreateRewardedVideoAdParam param) { return WXSDKManagerHandler.Instance.CreateRewardedVideoAd(param); } /// /// 创建插屏广告组件 详细参见 https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createInterstitialAd.html /// /// /// 广告操作对象,https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.html public static WXInterstitialAd CreateInterstitialAd(WXCreateInterstitialAdParam param) { return WXSDKManagerHandler.Instance.CreateInterstitialAd(param); } /// /// Grid 广告 详细参见 https://developers.weixin.qq.com/minigame/dev/guide/open-ability/ad/grid-ad.html /// /// 详细参见 https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createGridAd.html /// 广告操作对象,https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.html public static WXGridAd CreateGridAd(WXCreateGridAdParam param) { return WXSDKManagerHandler.Instance.CreateGridAd(param); } /// /// 创建原生模板广告组件 详细参见 https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createCustomAd.html /// /// /// 广告操作对象,https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.html public static WXCustomAd CreateCustomAd(WXCreateCustomAdParam param) { return WXSDKManagerHandler.Instance.CreateCustomAd(param); } #endregion #region 相机 /// /// [[WXCamera](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.html) wx.createCamera(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/wx.createCamera.html) /// 需要基础库: `2.9.0` /// 创建相机 /// public static WXCamera CreateCamera(CreateCameraOption param) { return WXSDKManagerHandler.Instance.CreateCamera(param); } #endregion #region 录音 /// /// [[RecorderManager](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.html) wx.getRecorderManager()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/wx.getRecorderManager.html) /// 需要基础库: `1.6.0` /// 获取**全局唯一**的录音管理器 RecorderManager /// public static WXRecorderManager GetRecorderManager() { return WXSDKManagerHandler.Instance.GetRecorderManager(); } #endregion #region 上传文件 /// /// [[UploadTask](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.html) wx.uploadFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/wx.uploadFile.html) /// 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。 /// **示例代码** /// ```js /// wx.chooseImage({ /// success (res) { /// const tempFilePaths = res.tempFilePaths /// wx.uploadFile({ /// url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址 /// filePath: tempFilePaths[0], /// name: 'file', /// formData: { /// 'user': 'test' /// }, /// success (res){ /// const data = res.data /// //do something /// } /// }) /// } /// }) /// ``` /// public static WXUploadTask UploadFile(UploadFileOption option) { return WXSDKManagerHandler.Instance.UploadFile(option); } #endregion #region 文件 /// /// 获取全局唯一的文件管理器 详见 https://developers.weixin.qq.com/minigame/dev/guide/base-ability/file-system.html /// /// 返回数据详见,https://developers.weixin.qq.com/minigame/dev/api/file/wx.getFileSystemManager.html /// /// // 在本地用户文件目录下创建一个文件 share.jpg,文件名可以自己随便取,写入内容为图片二进制内容 bytes /// var fs = WX.GetFileSystemManager(); /// fs.WriteFileSync(WX.env.USER_DATA_PATH+"/share.jpg", bytes); /// public static WXFileSystemManager GetFileSystemManager() { return new WXFileSystemManager(); } #endregion #region 开放数据域,关系链,排行榜这一类 /// /// 获取开放数据域,关系链相关可以参看 https://developers.weixin.qq.com/minigame/dev/guide/open-ability/open-data.html /// /// 开放数据域对象 public static WXOpenDataContext GetOpenDataContext() { return new WXOpenDataContext(); } /// /// 展示开放数据域 /// /// 用来占位的纹理,前端绘制的开放域数据会自动替换这一纹理,因为客户顿纹理映射倒立问题,这一纹理请设置rotationX为180才能正常展示。 /// 占位对应屏幕左上角横坐标 /// 占位对应屏幕左上角纵坐标,注意左上角为(0,0) /// 占位对应的宽度 /// 占位对应的高度 public static void ShowOpenData(Texture texture, int x, int y, int width, int height) { WXSDKManagerHandler.Instance.ShowOpenData(texture, x, y, width, height); } /// /// 关闭开放数据域 /// public static void HideOpenData() { WXSDKManagerHandler.Instance.HideOpenData(); } #endregion #region 音频 /// /// InnerAudioContext 实例,可通过 WX.CreateInnerAudioContext 接口获取实例。注意,音频播放过程中,可能被系统中断,可通过 WX.OnAudioInterruptionBegin、WX.OnAudioInterruptionEnd事件来处理这种情况。详见:https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html /// 使用参考文档:https://github.com/wechat-miniprogram/minigame-unity-webgl-transform/blob/main/Design/AudioOptimization.md /// /// //var music = WX.CreateInnerAudioContext(new InnerAudioContextParam() { // src = "Assets/Audio/Chill_1.wav", // needDownload = true //表示等下载完之后再播放,便于后续复用,无延迟 //}); //music.OnCanplay(() => //{ // Debug.Log("OnCanplay"); // music.Play(); //}); /// public static WXInnerAudioContext CreateInnerAudioContext(InnerAudioContextParam param = null) { return WXSDKManagerHandler.Instance.CreateInnerAudioContext(param); } /// /// 音频为网络请求,可能会有延迟,所以可以先调用这个接口预先下载音频缓存到本地,避免延迟 /// /// 音频的地址数组,如 { "Assets/Audio/0.wav", "Assets/Audio/1.wav" } /// 全部音频下载完成后回调,返回码为0表示下载完成 /// /// string[] a = { "Assets/Audio/0.wav", "Assets/Audio/1.wav" }; // WX.PreDownloadAudios(a, (code) => // { // Debug.Log("Downloaded" + code); // if (code == 0) // { // var music0 = WX.CreateInnerAudioContext(new InnerAudioContextParam() // { // src = "Assets/Audio/0.wav" // }); // music0.Play(); // var music1 = WX.CreateInnerAudioContext(new InnerAudioContextParam() // { // src = "Assets/Audio/1.wav" // }); // music1.Play(); // } //}); /// public static void PreDownloadAudios(string[] pathList, Action action) { WXSDKManagerHandler.Instance.PreDownloadAudios(pathList, action); } #endregion #region 视频 /// /// 创建视频,详见 https://developers.weixin.qq.com/minigame/dev/api/media/video/wx.createVideo.html /// /// /// public static WXVideo CreateVideo(WXCreateVideoParam param) { return WXSDKManagerHandler.Instance.CreateVideo(param); } /// /// 适合几秒d短音频播放 /// public static WXShortAudioPlayer ShortAudioPlayer = WXShortAudioPlayer.Instance; #endregion #region 性能 /// /// 获取当前UnityHeap总内存(峰值) /// public static uint GetTotalMemorySize() { return WXSDKManagerHandler.Instance.GetTotalMemorySize(); } /// /// 获取当前UnityHeap Stack大小 /// public static uint GetTotalStackSize() { return WXSDKManagerHandler.Instance.GetTotalStackSize(); } /// /// 获取当前UnityHeap静态内存 /// public static uint GetStaticMemorySize() { return WXSDKManagerHandler.Instance.GetStaticMemorySize(); } /// /// 获取当前UnityHeap动态内存 /// public static uint GetDynamicMemorySize() { return WXSDKManagerHandler.Instance.GetDynamicMemorySize(); } /// /// 获取当前UnityHeap动态内存 /// public static uint GetUsedMemorySize() { return WXSDKManagerHandler.Instance.GetUsedMemorySize(); } /// /// 获取当前UnityHeap动态内存 /// public static uint GetUnAllocatedMemorySize() { return WXSDKManagerHandler.Instance.GetUnAllocatedMemorySize(); } /// /// 打印UnityHeap内存 /// public static void LogUnityHeapMem() { WXSDKManagerHandler.Instance.LogUnityHeapMem(); } /// /// 打开性能面板 /// public static void OpenProfileStats() { WXSDKManagerHandler.Instance.OpenProfileStats(); } #endregion #region 调试 /// /// 写 debug 日志,同 https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.debug.html /// /// public static void LogManagerDebug(string str) { WXSDKManagerHandler.Instance.LogManagerDebug(str); } /// /// 写 info 日志,同 https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.info.html /// /// public static void LogManagerInfo(string str) { WXSDKManagerHandler.Instance.LogManagerInfo(str); } /// /// 写 log 日志,同 https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.log.html /// /// public static void LogManagerLog(string str) { WXSDKManagerHandler.Instance.LogManagerLog(str); } /// /// 写 warn 日志,同 https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.warn.html /// /// public static void LogManagerWarn(string str) { WXSDKManagerHandler.Instance.LogManagerWarn(str); } #endregion #region 云测试 /// /// 是否小游戏云测试环境 /// public static bool IsCloudTest() { return WXSDKManagerHandler.Instance.IsCloudTest(); } #endregion #region 清理文件缓存 /// /// 游戏异常时,使用本接口清理资源缓存 /// public static void CleanAllFileCache(Action action = null) { WXSDKManagerHandler.Instance.CleanAllFileCache(action); } /// /// 当空间不足时,清理指定大小缓存,按文件最近访问时间排序 /// /// 需要清理的文件大小,单位bytes public static void CleanFileCache(int fileSize, Action action = null) { WXSDKManagerHandler.Instance.CleanFileCache(fileSize, action); } /// /// 删除指定文件 /// /// 需要清理的文件路径,支持完整路径,也支持StreamingAssets/filepath格式 public static void RemoveFile(string path, Action action = null) { WXSDKManagerHandler.Instance.RemoveFile(path, action); } #endregion /// /// 获取启动loader的启动数据 /// /// public static void OnLaunchProgress(Action action = null) { WXSDKManagerHandler.Instance.OnLaunchProgress(action); } public static void UncaughtException() { WXSDKManagerHandler.Instance.UncaughtException(); } #region 交互 /// /// 创建游戏圈按钮,详见 https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/wx.createGameClubButton.html /// /// public static WXGameClubButton CreateGameClubButton(WXCreateGameClubButtonParam param) { return WXSDKManagerHandler.Instance.CreateGameClubButton(param); } #endregion #region UDP public static int CreateUDPSocket(string ip, int remotePort, int bindPort = 0) { return WXSDKManagerHandler.Instance.CreateUDPSocket(ip, remotePort, bindPort); } public static void CloseUDPSocket(int socketId) { WXSDKManagerHandler.Instance.CloseUDPSocket(socketId); } public static void SendUDPSocket(int socketId, byte[] buffer, int offset, int length) { WXSDKManagerHandler.Instance.SendUDPSocket(socketId, buffer, offset, length); } #endregion #region 插件配置 public static void SetDataCDN(string path) { WXSDKManagerHandler.Instance.SetDataCDN(path); } public static void SetPreloadList(string[] paths) { WXSDKManagerHandler.Instance.SetPreloadList(paths); } #endregion } }