is_mini_game: bool仅在版本化 Bridge 完成身份和 ABI 握手后为 true。
MiniGameSDK · v0.3.0 · Bridge ABI 1
每一个方法、
每一个信号
从 GDScript 源码自动生成的完整 Bridge 接口索引。搜索方法与信号，核对参数默认值、同步返回、能力门控和源码位置；接口存在不等于三个宿主全部兼容。
225公开方法
84公开信号
37能力分类
3运行时状态
GDScript · connect before call
func _ready() -> void:
MiniGameSDK.login_completed.connect(_on_login_completed)
MiniGameSDK.login()
func _on_login_completed(code: String, error: String) -> void:
if error.is_empty():
print(code)● error.is_empty() = success AUTOLOAD
bridge_info / bridge_initialization_error读取已协商的 brand、globalName、ABI 与平台信息；失败原因也会通过 bridge_initialization_failed 发出。
error == ""空字符串表示成功；异步调用应先连接 signal。
JSON.parse_string(data_json)原始平台对象以 JSON 字符串跨越 JS/GDScript 边界。
NOT_IN_RUNTIME编辑器与非小游戏环境使用安全默认值或错误信号。
平台标签怎么读
跨宿主同名统一桥接微信文档微信专属按平台映射TikTok统一桥接不等于三个平台均已验证。涉及宿主版本的能力请先调用 can_i_use()，再完成目标平台真机验证。
常用字符串取值
privacy: exposureAuthorization | agree | disagreebutton: userInfo | openSetting | gameClubinterval: game | ui | normaltoast: success | error | loading | none// API REFERENCE
完整接口索引
找到 309 项
Bridge runtime
Bridge 运行时
版本化 JS/GDScript 桥接身份、ABI 握手与初始化状态。
跨宿主同名SIGNALS1
SIGNAL跨宿主同名事件bridge_initialization_failed
bridge_initialization_failed(error: String)对应能力发生错误或失败时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
errorString事件参数空字符串表示成功，否则为错误信息。
Storage
本地存储
同步读写小游戏本地键值存储。
统一桥接METHODS5
METHOD统一桥接无返回storage_set
storage_set(key: String, value: String) -> void写入一个本地键值；该调用同步完成。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
keyString必填传给该接口的 key 参数。
valueString必填传给该接口的 value 参数。
METHOD统一桥接同步返回storage_get
storage_get(key: String, default_value: String = "") -> String同步读取本地键值，不存在时返回 default_value。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值String
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
keyString必填传给该接口的 key 参数。
default_valueString""键不存在或离开小游戏运行时时使用的默认值。
METHOD统一桥接无返回storage_remove
storage_remove(key: String) -> void调用 storage_remove；同步读写小游戏本地键值存储。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
keyString必填传给该接口的 key 参数。
METHOD统一桥接无返回storage_clear
storage_clear() -> void调用 storage_clear；同步读写小游戏本地键值存储。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD统一桥接同步返回storage_info
storage_info() -> Dictionary同步返回 keys、当前占用空间 size 与存储上限 limit。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
Authentication
登录与会话
登录、会话校验与用户资料。
统一桥接METHODS3
METHOD统一桥接信号回调login
login() -> void请求平台登录凭证；结果由 login_completed 返回。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调check_session
check_session() -> void校验当前登录会话是否仍然有效。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调get_user_info
get_user_info() -> void读取已授权的用户资料，结果以 JSON 字符串返回。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS3
SIGNAL统一桥接事件login_completed
login_completed(code: String, error: String)对应异步流程结束时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
codeString事件参数传给该接口的 code 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件session_checked
session_checked(valid: bool, error: String)登录、会话校验与用户资料。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
validbool事件参数传给该接口的 valid 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件user_info_received
user_info_received(info_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
info_jsonString事件参数传给该接口的 info_json 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
Privacy
隐私授权
隐私协议查询、授权和隐私弹窗回调。
微信专属METHODS8
METHOD微信专属信号回调get_privacy_setting
get_privacy_setting() -> void读取微信隐私授权状态和隐私协议名称。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信专属信号回调require_privacy_authorize
require_privacy_authorize() -> void调用 require_privacy_authorize；隐私协议查询、授权和隐私弹窗回调。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信专属信号回调open_privacy_contract
open_privacy_contract() -> void打开 privacy_contract；隐私协议查询、授权和隐私弹窗回调。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信专属信号回调start_privacy_authorization_listener
start_privacy_authorization_listener() -> void监听平台提出的隐私授权请求；收到事件后必须显式 resolve。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信专属同步返回resolve_privacy_authorization
resolve_privacy_authorization(event: String = "agree", button_id: String = "agree-btn") -> bool用 agree、disagree 或 exposureAuthorization 解决挂起的隐私授权请求。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
eventString"agree"传给该接口的 event 参数。
button_idString"agree-btn"传给该接口的 button_id 参数。
METHOD微信专属同步返回expose_privacy_authorization
expose_privacy_authorization() -> bool调用 expose_privacy_authorization；隐私协议查询、授权和隐私弹窗回调。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信专属同步返回agree_privacy_authorization
agree_privacy_authorization(button_id: String = "agree-btn") -> bool调用 agree_privacy_authorization；隐私协议查询、授权和隐私弹窗回调。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
button_idString"agree-btn"传给该接口的 button_id 参数。
METHOD微信专属同步返回disagree_privacy_authorization
disagree_privacy_authorization() -> bool调用 disagree_privacy_authorization；隐私协议查询、授权和隐私弹窗回调。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS4
SIGNAL微信专属事件privacy_setting_received
privacy_setting_received(need_authorization: bool, privacy_contract_name: String, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
need_authorizationbool事件参数传给该接口的 need_authorization 参数。
privacy_contract_nameString事件参数传给该接口的 privacy_contract_name 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信专属事件privacy_authorize_result
privacy_authorize_result(success: bool, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信专属事件privacy_contract_opened
privacy_contract_opened(success: bool, error: String)隐私协议查询、授权和隐私弹窗回调。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信专属事件privacy_authorization_needed
privacy_authorization_needed(event_info_json: String, error: String)隐私协议查询、授权和隐私弹窗回调。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_info_jsonString事件参数传给该接口的 event_info_json 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
Authorization
授权与账号
系统授权范围、设置页与账号信息。
微信文档METHODS3
METHOD微信文档信号回调get_setting
get_setting(with_subscriptions: bool = false) -> void读取 setting；系统授权范围、设置页与账号信息。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
with_subscriptionsboolfalse传给该接口的 with_subscriptions 参数。
METHOD微信文档信号回调open_setting
open_setting(with_subscriptions: bool = false) -> void打开 setting；系统授权范围、设置页与账号信息。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
with_subscriptionsboolfalse传给该接口的 with_subscriptions 参数。
METHOD微信文档信号回调authorize
authorize(scope: String) -> void申请一个平台权限 scope，例如 scope.record。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
scopeString必填传给该接口的 scope 参数。
SIGNALS3
SIGNAL微信文档事件setting_received
setting_received(settings_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
settings_jsonString事件参数传给该接口的 settings_json 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件setting_opened
setting_opened(settings_json: String, error: String)系统授权范围、设置页与账号信息。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
settings_jsonString事件参数传给该接口的 settings_json 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件authorization_result
authorization_result(scope: String, success: bool, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
scopeString事件参数传给该接口的 scope 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
Native buttons
原生按钮
用户信息、设置和游戏圈等原生按钮。
微信文档METHODS7
METHOD微信文档信号回调create_user_info_button
create_user_info_button(options: Dictionary = {}) -> void创建 user_info_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调create_open_setting_button
create_open_setting_button(options: Dictionary = {}) -> void创建 open_setting_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调create_game_club_button
create_game_club_button(options: Dictionary = {}) -> void创建 game_club_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调show_native_button
show_native_button(button_type: String) -> void显示 native_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
button_typeString必填原生按钮类型：userInfo、openSetting 或 gameClub。
METHOD微信文档信号回调hide_native_button
hide_native_button(button_type: String) -> void隐藏 native_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
button_typeString必填原生按钮类型：userInfo、openSetting 或 gameClub。
METHOD微信文档信号回调destroy_native_button
destroy_native_button(button_type: String) -> void销毁 native_button；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
button_typeString必填原生按钮类型：userInfo、openSetting 或 gameClub。
METHOD微信文档信号回调stop_native_button_tap_listener
stop_native_button_tap_listener(button_type: String) -> void停止 native_button_tap_listener；用户信息、设置和游戏圈等原生按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
button_typeString必填原生按钮类型：userInfo、openSetting 或 gameClub。
SIGNALS2
SIGNAL微信文档事件native_button_operation_result
native_button_operation_result(button_type: String, action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
button_typeString事件参数原生按钮类型：userInfo、openSetting 或 gameClub。
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件native_button_tapped
native_button_tapped(button_type: String, data_json: String, error: String)用户信息、设置和游戏圈等原生按钮。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
button_typeString事件参数原生按钮类型：userInfo、openSetting 或 gameClub。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Debug logging
调试与日志
平台调试开关、日志管理器和实时日志。
微信文档METHODS16
METHOD微信文档信号回调set_enable_debug
set_enable_debug(enable_debug: bool) -> void设置 enable_debug；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
enable_debugbool必填传给该接口的 enable_debug 参数。
METHOD微信文档无返回get_log_manager
get_log_manager(level: int = 0) -> void读取 log_manager；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
levelint0传给该接口的 level 参数。
METHOD微信文档无返回log_manager_write
log_manager_write(level: String, args: Array = []) -> void调用 log_manager_write；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
levelString必填传给该接口的 level 参数。
argsArray[]传给该接口的 args 参数。
METHOD微信文档信号回调log_manager_debug
log_manager_debug(args: Array = []) -> void调用 log_manager_debug；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回log_manager_info
log_manager_info(args: Array = []) -> void调用 log_manager_info；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回log_manager_log
log_manager_log(args: Array = []) -> void调用 log_manager_log；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回log_manager_warn
log_manager_warn(args: Array = []) -> void调用 log_manager_warn；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回get_realtime_log_manager
get_realtime_log_manager() -> void读取 realtime_log_manager；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD微信文档无返回realtime_log_write
realtime_log_write(level: String, args: Array = []) -> void调用 realtime_log_write；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
levelString必填传给该接口的 level 参数。
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回realtime_log_info
realtime_log_info(args: Array = []) -> void调用 realtime_log_info；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回realtime_log_warn
realtime_log_warn(args: Array = []) -> void调用 realtime_log_warn；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回realtime_log_error
realtime_log_error(args: Array = []) -> void调用 realtime_log_error；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
argsArray[]传给该接口的 args 参数。
METHOD微信文档无返回realtime_log_set_filter_msg
realtime_log_set_filter_msg(msg: String) -> void调用 realtime_log_set_filter_msg；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
msgString必填传给该接口的 msg 参数。
METHOD微信文档无返回realtime_log_add_filter_msg
realtime_log_add_filter_msg(msg: String) -> void调用 realtime_log_add_filter_msg；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
msgString必填传给该接口的 msg 参数。
METHOD微信文档无返回realtime_log_tag
realtime_log_tag(tag: String) -> void调用 realtime_log_tag；平台调试开关、日志管理器和实时日志。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
tagString必填传给该接口的 tag 参数。
METHOD微信文档同步返回get_account_info
get_account_info() -> Dictionary同步读取当前小程序、插件与账号信息。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS1
SIGNAL微信文档事件debug_operation_result
debug_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Ads
广告
激励视频、Banner 与插屏广告生命周期。
统一桥接METHODS8
METHOD统一桥接信号回调create_rewarded_ad
create_rewarded_ad(ad_unit_id: String) -> void创建激励视频广告实例并返回创建结果。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
ad_unit_idString必填平台后台创建的广告位 ID。
METHOD统一桥接信号回调show_rewarded_ad
show_rewarded_ad() -> void展示已创建的激励视频广告；根据播放完成状态发放奖励。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接无返回create_banner_ad
create_banner_ad(ad_unit_id: String) -> void创建 banner_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
ad_unit_idString必填平台后台创建的广告位 ID。
METHOD统一桥接无返回show_banner_ad
show_banner_ad() -> void显示 banner_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD统一桥接无返回hide_banner_ad
hide_banner_ad() -> void隐藏 banner_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD统一桥接无返回destroy_banner_ad
destroy_banner_ad() -> void销毁 banner_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD统一桥接信号回调create_interstitial_ad
create_interstitial_ad(ad_unit_id: String) -> void创建 interstitial_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
ad_unit_idString必填平台后台创建的广告位 ID。
METHOD统一桥接信号回调show_interstitial_ad
show_interstitial_ad() -> void显示 interstitial_ad；激励视频、Banner 与插屏广告生命周期。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS3
SIGNAL统一桥接事件ad_created
ad_created(ad_type: String, success: bool, error: String)激励视频、Banner 与插屏广告生命周期。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
ad_typeString事件参数传给该接口的 ad_type 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件rewarded_ad_result
rewarded_ad_result(is_ended: bool, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
is_endedbool事件参数传给该接口的 is_ended 参数。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件interstitial_ad_result
interstitial_ad_result(success: bool, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
Payment
支付
按 Provider 显式映射的小游戏支付请求与结果；参数不可跨宿主复用。
按平台映射METHODS1
METHOD按平台映射信号回调request_payment
request_payment(params: Dictionary) -> void按当前 Provider 发起虚拟支付；Dictionary 字段属于平台契约，不能跨宿主复用。
平台支持按平台映射
桥接会选择宿主专属实现；参数、商业资质、返回值和错误语义必须按平台文档处理。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary必填平台 API 参数字典。
SIGNALS1
SIGNAL按平台映射事件payment_result
payment_result(success: bool, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
TikTok missions
TikTok 入口任务
桌面快捷方式、入口任务与奖励领取状态。
TikTokMETHODS4
METHODTikTok信号回调add_shortcut
add_shortcut(params: Dictionary = {}) -> void请求在 TikTok 中添加桌面快捷方式；调用前会检查宿主能力。
平台支持TikTok
TikTok 平台能力；调用前会检查宿主支持情况，发布前仍需真机验证。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary{}平台 API 参数字典。
METHODTikTok信号回调get_shortcut_mission_reward
get_shortcut_mission_reward(params: Dictionary = {}) -> void查询或领取 TikTok 快捷方式任务奖励，并返回当前可领取状态。
平台支持TikTok
TikTok 平台能力；调用前会检查宿主支持情况，发布前仍需真机验证。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary{}平台 API 参数字典。
METHODTikTok信号回调start_entrance_mission
start_entrance_mission(params: Dictionary = {}) -> void启动 TikTok 入口任务；调用前会检查宿主能力。
平台支持TikTok
TikTok 平台能力；调用前会检查宿主支持情况，发布前仍需真机验证。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary{}平台 API 参数字典。
METHODTikTok信号回调get_entrance_mission_reward
get_entrance_mission_reward(params: Dictionary = {}) -> void查询或领取 TikTok 入口任务奖励，并返回当前可领取状态。
平台支持TikTok
TikTok 平台能力；调用前会检查宿主支持情况，发布前仍需真机验证。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary{}平台 API 参数字典。
SIGNALS1
SIGNALTikTok事件tiktok_mission_result
tiktok_mission_result(action: String, success: bool, can_receive_reward: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
can_receive_rewardbool事件参数宿主返回的 canReceiveReward；表示当前任务奖励是否可领取。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Input
振动与键盘
设备振动和平台原生键盘。
统一桥接METHODS4
METHOD统一桥接无返回vibrate_short
vibrate_short(type: String = "medium") -> void调用 vibrate_short；设备振动和平台原生键盘。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
typeString"medium"传给该接口的 type 参数。
METHOD统一桥接无返回vibrate_long
vibrate_long() -> void调用 vibrate_long；设备振动和平台原生键盘。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
METHOD统一桥接信号回调show_keyboard
show_keyboard(default_value: String = "", max_length: int = 140, multiple: bool = false) -> void显示 keyboard；设备振动和平台原生键盘。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
default_valueString""键不存在或离开小游戏运行时时使用的默认值。
max_lengthint140传给该接口的 max_length 参数。
multipleboolfalse传给该接口的 multiple 参数。
METHOD统一桥接信号回调hide_keyboard
hide_keyboard() -> void隐藏 keyboard；设备振动和平台原生键盘。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS1
SIGNAL统一桥接事件keyboard_event
keyboard_event(event_type: String, value: String)设备振动和平台原生键盘。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
valueString事件参数传给该接口的 value 参数。
HTTP & transfer
HTTP 与文件传输
网络请求、文件下载与上传。
跨宿主同名METHODS4
METHOD跨宿主同名信号回调http_request
http_request(url: String, method: String = "GET", data: String = "", headers: Dictionary = {}) -> void发起平台 HTTP 请求；状态码、响应正文和错误由 http_response 返回。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
urlString必填请求或连接的完整 URL。
methodString"GET"平台方法名或 HTTP 方法。
dataString""发送的数据内容。
headersDictionary{}请求头键值对。
METHOD跨宿主同名同步返回http_request_with_id
http_request_with_id(url: String, method: String = "GET", data: String = "", headers: Dictionary = {}) -> int调用 http_request_with_id；网络请求、文件下载与上传。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值int
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
urlString必填请求或连接的完整 URL。
methodString"GET"平台方法名或 HTTP 方法。
dataString""发送的数据内容。
headersDictionary{}请求头键值对。
METHOD跨宿主同名信号回调download_file
download_file( url: String, file_path: String = "", headers: Dictionary = {}, timeout_ms: int = 60000, enable_profile: bool = true, enable_http2: bool = false, enable_quic: bool = false ) -> void下载远程文件到临时路径或指定小游戏文件路径。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
urlString必填请求或连接的完整 URL。
file_pathString""小游戏文件系统路径。
headersDictionary{}请求头键值对。
timeout_msint60000传给该接口的 timeout_ms 参数。
enable_profilebooltrue传给该接口的 enable_profile 参数。
enable_http2boolfalse传给该接口的 enable_http2 参数。
enable_quicboolfalse传给该接口的 enable_quic 参数。
METHOD跨宿主同名信号回调upload_file
upload_file( url: String, file_path: String, name: String = "file", form_data: Dictionary = {}, headers: Dictionary = {}, timeout_ms: int = 60000, enable_profile: bool = true, enable_http2: bool = false, enable_quic: bool = false ) -> void以 multipart/form-data 上传小游戏本地文件。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
urlString必填请求或连接的完整 URL。
file_pathString必填小游戏文件系统路径。
nameString"file"传给该接口的 name 参数。
form_dataDictionary{}传给该接口的 form_data 参数。
headersDictionary{}请求头键值对。
timeout_msint60000传给该接口的 timeout_ms 参数。
enable_profilebooltrue传给该接口的 enable_profile 参数。
enable_http2boolfalse传给该接口的 enable_http2 参数。
enable_quicboolfalse传给该接口的 enable_quic 参数。
SIGNALS3
SIGNAL跨宿主同名事件http_response
http_response(status_code: int, data: String, error: String)网络请求、文件下载与上传。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
status_codeint事件参数传给该接口的 status_code 参数。
dataString事件参数发送的数据内容。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件http_request_completed
http_request_completed(request_id: int, status_code: int, data: String, error: String)对应异步流程结束时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
request_idint事件参数传给该接口的 request_id 参数。
status_codeint事件参数传给该接口的 status_code 参数。
dataString事件参数发送的数据内容。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件file_transfer_result
file_transfer_result(action: String, success: bool, status_code: int, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
status_codeint事件参数传给该接口的 status_code 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
WebSocket
WebSocket
长连接、消息发送和连接事件。
跨宿主同名METHODS3
METHOD跨宿主同名信号回调connect_socket
connect_socket( url: String, headers: Dictionary = {}, protocols: Array = [], tcp_no_delay: bool = false, per_message_deflate: bool = false, timeout_ms: int = 0, force_cellular_network: bool = false ) -> void创建 WebSocket 连接并注册 open、message、close 与 error 事件。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
urlString必填请求或连接的完整 URL。
headersDictionary{}请求头键值对。
protocolsArray[]传给该接口的 protocols 参数。
tcp_no_delayboolfalse传给该接口的 tcp_no_delay 参数。
per_message_deflateboolfalse传给该接口的 per_message_deflate 参数。
timeout_msint0传给该接口的 timeout_ms 参数。
force_cellular_networkboolfalse传给该接口的 force_cellular_network 参数。
METHOD跨宿主同名信号回调send_socket_message
send_socket_message(data: String) -> void发送 socket_message；长连接、消息发送和连接事件。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
dataString必填发送的数据内容。
METHOD跨宿主同名信号回调close_socket
close_socket(code: int = 1000, reason: String = "") -> void关闭 socket；长连接、消息发送和连接事件。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
codeint1000传给该接口的 code 参数。
reasonString""传给该接口的 reason 参数。
SIGNALS5
SIGNAL跨宿主同名事件socket_operation_result
socket_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件socket_opened
socket_opened(data_json: String, error: String)长连接、消息发送和连接事件。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件socket_message_received
socket_message_received(data: String, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
dataString事件参数发送的数据内容。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件socket_closed
socket_closed(code: int, reason: String, data_json: String, error: String)长连接、消息发送和连接事件。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
codeint事件参数传给该接口的 code 参数。
reasonString事件参数传给该接口的 reason 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件socket_error
socket_error(data_json: String, error: String)对应能力发生错误或失败时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
File system
文件系统
小游戏沙盒文件系统的常用操作与通用桥接。
跨宿主同名METHODS17
METHOD跨宿主同名信号回调call_file_system
call_file_system(method: String, options: Dictionary = {}) -> void调用 FileSystemManager 的任意 options-object 异步方法。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
methodString必填平台方法名或 HTTP 方法。
optionsDictionary{}直接传给平台 API 的 options object。
METHOD跨宿主同名信号回调file_system_access
file_system_access(path: String) -> void调用 file_system_access；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
pathString必填目标路径或小程序页面路径。
METHOD跨宿主同名信号回调file_system_read_file
file_system_read_file(file_path: String, encoding: String = "utf8", position: int = -1, length: int = -1) -> void调用 file_system_read_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
encodingString"utf8"传给该接口的 encoding 参数。
positionint-1传给该接口的 position 参数。
lengthint-1传给该接口的 length 参数。
METHOD跨宿主同名信号回调file_system_write_file
file_system_write_file(file_path: String, data: String, encoding: String = "utf8") -> void调用 file_system_write_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
dataString必填发送的数据内容。
encodingString"utf8"传给该接口的 encoding 参数。
METHOD跨宿主同名信号回调file_system_append_file
file_system_append_file(file_path: String, data: String, encoding: String = "utf8") -> void调用 file_system_append_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
dataString必填发送的数据内容。
encodingString"utf8"传给该接口的 encoding 参数。
METHOD跨宿主同名信号回调file_system_mkdir
file_system_mkdir(dir_path: String, recursive: bool = true) -> void调用 file_system_mkdir；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
dir_pathString必填传给该接口的 dir_path 参数。
recursivebooltrue传给该接口的 recursive 参数。
METHOD跨宿主同名信号回调file_system_readdir
file_system_readdir(dir_path: String) -> void调用 file_system_readdir；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
dir_pathString必填传给该接口的 dir_path 参数。
METHOD跨宿主同名信号回调file_system_unlink
file_system_unlink(file_path: String) -> void调用 file_system_unlink；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
METHOD跨宿主同名信号回调file_system_save_file
file_system_save_file(temp_file_path: String, file_path: String = "") -> void调用 file_system_save_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
temp_file_pathString必填传给该接口的 temp_file_path 参数。
file_pathString""小游戏文件系统路径。
METHOD跨宿主同名信号回调file_system_get_saved_file_list
file_system_get_saved_file_list() -> void调用 file_system_get_saved_file_list；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD跨宿主同名信号回调file_system_remove_saved_file
file_system_remove_saved_file(file_path: String) -> void调用 file_system_remove_saved_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
METHOD跨宿主同名信号回调file_system_get_file_info
file_system_get_file_info(file_path: String, digest_algorithm: String = "md5") -> void调用 file_system_get_file_info；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
file_pathString必填小游戏文件系统路径。
digest_algorithmString"md5"传给该接口的 digest_algorithm 参数。
METHOD跨宿主同名信号回调file_system_copy_file
file_system_copy_file(src_path: String, dest_path: String) -> void调用 file_system_copy_file；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
src_pathString必填传给该接口的 src_path 参数。
dest_pathString必填传给该接口的 dest_path 参数。
METHOD跨宿主同名信号回调file_system_rename
file_system_rename(old_path: String, new_path: String) -> void调用 file_system_rename；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
old_pathString必填传给该接口的 old_path 参数。
new_pathString必填传给该接口的 new_path 参数。
METHOD跨宿主同名信号回调file_system_rmdir
file_system_rmdir(dir_path: String, recursive: bool = false) -> void调用 file_system_rmdir；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
dir_pathString必填传给该接口的 dir_path 参数。
recursiveboolfalse传给该接口的 recursive 参数。
METHOD跨宿主同名信号回调file_system_stat
file_system_stat(path: String, recursive: bool = false) -> void调用 file_system_stat；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
pathString必填目标路径或小程序页面路径。
recursiveboolfalse传给该接口的 recursive 参数。
METHOD跨宿主同名信号回调file_system_unzip
file_system_unzip(zip_file_path: String, target_path: String) -> void调用 file_system_unzip；小游戏沙盒文件系统的常用操作与通用桥接。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
zip_file_pathString必填传给该接口的 zip_file_path 参数。
target_pathString必填传给该接口的 target_path 参数。
SIGNALS1
SIGNAL跨宿主同名事件file_system_result
file_system_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Subpackages
分包加载
加载与预下载资源分包并监听进度。
跨宿主同名METHODS2
METHOD跨宿主同名信号回调load_subpackage
load_subpackage(name: String) -> void加载一个已在平台配置中声明的资源分包。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
nameString必填传给该接口的 name 参数。
METHOD跨宿主同名信号回调pre_download_subpackage
pre_download_subpackage(name: String, package_type: String = "normal") -> void预下载资源分包并持续返回下载进度。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
nameString必填传给该接口的 name 参数。
package_typeString"normal"传给该接口的 package_type 参数。
SIGNALS2
SIGNAL跨宿主同名事件subpackage_result
subpackage_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件subpackage_progress
subpackage_progress(action: String, progress: int, total_bytes_written: int, total_bytes_expected: int, data_json: String)加载与预下载资源分包并监听进度。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
progressint事件参数传给该接口的 progress 参数。
total_bytes_writtenint事件参数传给该接口的 total_bytes_written 参数。
total_bytes_expectedint事件参数传给该接口的 total_bytes_expected 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
Worker
Worker
创建后台 Worker、通信与终止。
微信文档METHODS3
METHOD微信文档信号回调create_worker
create_worker(script_path: String, use_experimental_worker: bool = false) -> void创建后台 Worker；新建前会终止已有的活跃 Worker。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
script_pathString必填传给该接口的 script_path 参数。
use_experimental_workerboolfalse传给该接口的 use_experimental_worker 参数。
METHOD微信文档信号回调worker_post_message
worker_post_message(message: Dictionary) -> void调用 worker_post_message；创建后台 Worker、通信与终止。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
messageDictionary必填传给该接口的 message 参数。
METHOD微信文档信号回调worker_terminate
worker_terminate() -> void调用 worker_terminate；创建后台 Worker、通信与终止。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS4
SIGNAL微信文档事件worker_operation_result
worker_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件worker_message
worker_message(data_json: String, error: String)创建后台 Worker、通信与终止。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件worker_error
worker_error(data_json: String, error: String)对应能力发生错误或失败时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件worker_process_killed
worker_process_killed(data_json: String, error: String)创建后台 Worker、通信与终止。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Media & images
图片与媒体
选择、预览、保存和压缩图片或媒体。
微信文档METHODS5
METHOD微信文档信号回调choose_media
choose_media( count: int = 9, media_type: Array = [], source_type: Array = [], max_duration: int = 10, size_type: Array = [], camera: String = "back" ) -> void从相册或相机选择图片/视频媒体。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
countint9传给该接口的 count 参数。
media_typeArray[]传给该接口的 media_type 参数。
source_typeArray[]传给该接口的 source_type 参数。
max_durationint10传给该接口的 max_duration 参数。
size_typeArray[]传给该接口的 size_type 参数。
cameraString"back"传给该接口的 camera 参数。
METHOD微信文档无返回choose_image
choose_image(count: int = 9, size_type: Array = [], source_type: Array = []) -> void调用 choose_image；选择、预览、保存和压缩图片或媒体。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
countint9传给该接口的 count 参数。
size_typeArray[]传给该接口的 size_type 参数。
source_typeArray[]传给该接口的 source_type 参数。
METHOD微信文档无返回preview_image
preview_image(urls: Array, current: String = "", show_menu: bool = true, referrer_policy: String = "no-referrer") -> void预览 image；选择、预览、保存和压缩图片或媒体。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
urlsArray必填传给该接口的 urls 参数。
currentString""传给该接口的 current 参数。
show_menubooltrue传给该接口的 show_menu 参数。
referrer_policyString"no-referrer"传给该接口的 referrer_policy 参数。
METHOD微信文档无返回save_image_to_photos_album
save_image_to_photos_album(file_path: String) -> void保存 image_to_photos_album；选择、预览、保存和压缩图片或媒体。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
file_pathString必填小游戏文件系统路径。
METHOD微信文档无返回compress_image
compress_image(src: String, quality: int = 80, compressed_width: int = 0, compressed_height: int = 0) -> void压缩 image；选择、预览、保存和压缩图片或媒体。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
srcString必填传给该接口的 src 参数。
qualityint80传给该接口的 quality 参数。
compressed_widthint0传给该接口的 compressed_width 参数。
compressed_heightint0传给该接口的 compressed_height 参数。
SIGNALS1
SIGNAL微信文档事件media_result
media_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Camera
相机
相机实例、拍照、录像、缩放和帧监听。
微信文档METHODS8
METHOD微信文档信号回调create_camera
create_camera( x: int = 0, y: int = 0, width: int = 300, height: int = 150, device_position: String = "back", flash: String = "auto", frame_size: String = "small" ) -> void创建平台原生 Camera 实例并注册相机事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
xint0传给该接口的 x 参数。
yint0传给该接口的 y 参数。
widthint300传给该接口的 width 参数。
heightint150传给该接口的 height 参数。
device_positionString"back"传给该接口的 device_position 参数。
flashString"auto"传给该接口的 flash 参数。
frame_sizeString"small"传给该接口的 frame_size 参数。
METHOD微信文档信号回调camera_take_photo
camera_take_photo(quality: String = "normal") -> void调用 camera_take_photo；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
qualityString"normal"传给该接口的 quality 参数。
METHOD微信文档信号回调camera_start_record
camera_start_record() -> void调用 camera_start_record；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调camera_stop_record
camera_stop_record(compressed: bool = true) -> void调用 camera_stop_record；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
compressedbooltrue传给该接口的 compressed 参数。
METHOD微信文档信号回调camera_set_zoom
camera_set_zoom(zoom: float) -> void调用 camera_set_zoom；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
zoomfloat必填传给该接口的 zoom 参数。
METHOD微信文档信号回调camera_listen_frame_change
camera_listen_frame_change(use_active_worker: bool = false) -> void调用 camera_listen_frame_change；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
use_active_workerboolfalse传给该接口的 use_active_worker 参数。
METHOD微信文档信号回调camera_close_frame_change
camera_close_frame_change() -> void调用 camera_close_frame_change；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调camera_destroy
camera_destroy() -> void调用 camera_destroy；相机实例、拍照、录像、缩放和帧监听。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS3
SIGNAL微信文档事件camera_operation_result
camera_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件camera_frame
camera_frame(data_json: String, error: String)相机实例、拍照、录像、缩放和帧监听。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件camera_event
camera_event(event_type: String, data_json: String, error: String)相机实例、拍照、录像、缩放和帧监听。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Video
视频组件
视频实例的播放、定位、全屏和事件。
微信文档METHODS11
METHOD微信文档信号回调create_video
create_video(options: Dictionary = {}) -> void创建平台原生 Video 实例；options 直接映射平台组件属性。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调set_video_properties
set_video_properties(properties: Dictionary = {}) -> void设置 video_properties；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
propertiesDictionary{}传给该接口的 properties 参数。
METHOD微信文档信号回调get_video_state
get_video_state() -> void读取 video_state；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_play
video_play() -> void调用 video_play；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_pause
video_pause() -> void调用 video_pause；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_stop
video_stop() -> void调用 video_stop；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_seek
video_seek(time: float) -> void调用 video_seek；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
timefloat必填传给该接口的 time 参数。
METHOD微信文档信号回调video_request_full_screen
video_request_full_screen(direction: int = 0) -> void调用 video_request_full_screen；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
directionint0传给该接口的 direction 参数。
METHOD微信文档信号回调video_exit_full_screen
video_exit_full_screen() -> void调用 video_exit_full_screen；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调stop_video_listener
stop_video_listener(event_types: Array = []) -> void停止 video_listener；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD微信文档信号回调video_destroy
video_destroy() -> void调用 video_destroy；视频实例的播放、定位、全屏和事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS2
SIGNAL微信文档事件video_operation_result
video_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件video_event
video_event(event_type: String, data_json: String, error: String)视频实例的播放、定位、全屏和事件。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Recorder
录音管理器
录音管理器的创建、录制、暂停与恢复。
微信文档METHODS5
METHOD微信文档信号回调get_recorder_manager
get_recorder_manager() -> void取得全局 RecorderManager，并注册录音事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调recorder_start
recorder_start(options: Dictionary = {}) -> void调用 recorder_start；录音管理器的创建、录制、暂停与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调recorder_pause
recorder_pause() -> void调用 recorder_pause；录音管理器的创建、录制、暂停与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调recorder_resume
recorder_resume() -> void调用 recorder_resume；录音管理器的创建、录制、暂停与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调recorder_stop
recorder_stop() -> void调用 recorder_stop；录音管理器的创建、录制、暂停与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS3
SIGNAL微信文档事件recorder_operation_result
recorder_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件recorder_event
recorder_event(event_type: String, data_json: String, error: String)录音管理器的创建、录制、暂停与恢复。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件available_audio_sources_received
available_audio_sources_received(sources_json: String, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
sources_jsonString事件参数传给该接口的 sources_json 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Decoder & media audio
解码与媒体音频
音频源、VideoDecoder 与 MediaAudioPlayer。
微信文档METHODS16
METHOD微信文档信号回调get_available_audio_sources
get_available_audio_sources() -> void读取 available_audio_sources；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调create_video_decoder
create_video_decoder() -> void创建 VideoDecoder 实例，用于逐帧读取视频数据。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_decoder_start
video_decoder_start(options: Dictionary = {}) -> void调用 video_decoder_start；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调video_decoder_get_frame_data
video_decoder_get_frame_data() -> void调用 video_decoder_get_frame_data；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_decoder_seek
video_decoder_seek(position: float) -> void调用 video_decoder_seek；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
positionfloat必填传给该接口的 position 参数。
METHOD微信文档信号回调video_decoder_stop
video_decoder_stop() -> void调用 video_decoder_stop；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调video_decoder_remove
video_decoder_remove() -> void调用 video_decoder_remove；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_video_decoder_listener
start_video_decoder_listener(event_types: Array = []) -> void开始 video_decoder_listener；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD微信文档信号回调stop_video_decoder_listener
stop_video_decoder_listener(event_types: Array = []) -> void停止 video_decoder_listener；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD微信文档信号回调create_media_audio_player
create_media_audio_player(volume: float = 1.0) -> void创建 MediaAudioPlayer，并设置初始音量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
volumefloat1.0传给该接口的 volume 参数。
METHOD微信文档信号回调set_media_audio_volume
set_media_audio_volume(volume: float) -> void设置 media_audio_volume；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
volumefloat必填传给该接口的 volume 参数。
METHOD微信文档信号回调media_audio_add_video_decoder_source
media_audio_add_video_decoder_source() -> void调用 media_audio_add_video_decoder_source；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调media_audio_remove_video_decoder_source
media_audio_remove_video_decoder_source() -> void调用 media_audio_remove_video_decoder_source；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调media_audio_start
media_audio_start() -> void调用 media_audio_start；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调media_audio_stop
media_audio_stop() -> void调用 media_audio_stop；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调media_audio_destroy
media_audio_destroy() -> void调用 media_audio_destroy；音频源、VideoDecoder 与 MediaAudioPlayer。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS3
SIGNAL微信文档事件video_decoder_operation_result
video_decoder_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件video_decoder_event
video_decoder_event(event_type: String, data_json: String, error: String)音频源、VideoDecoder 与 MediaAudioPlayer。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件media_audio_operation_result
media_audio_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Game recorder
游戏录屏
游戏录屏、剪辑操作与录屏分享按钮。
微信文档METHODS13
METHOD微信文档信号回调get_game_recorder
get_game_recorder() -> void取得平台 GameRecorder 实例并注册录屏事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调game_recorder_start
game_recorder_start(options: Dictionary = {}) -> void调用 game_recorder_start；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD微信文档信号回调game_recorder_stop
game_recorder_stop() -> void调用 game_recorder_stop；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调game_recorder_pause
game_recorder_pause() -> void调用 game_recorder_pause；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调game_recorder_resume
game_recorder_resume() -> void调用 game_recorder_resume；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调game_recorder_abort
game_recorder_abort() -> void调用 game_recorder_abort；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_game_recorder_listener
start_game_recorder_listener(event_types: Array = []) -> void开始 game_recorder_listener；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD微信文档信号回调stop_game_recorder_listener
stop_game_recorder_listener(event_types: Array = []) -> void停止 game_recorder_listener；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD微信文档信号回调operate_game_recorder_video
operate_game_recorder_video(params: Dictionary = {}) -> void调用 operate_game_recorder_video；游戏录屏、剪辑操作与录屏分享按钮。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
paramsDictionary{}平台 API 参数字典。
SIGNALS2
SIGNAL微信文档事件game_recorder_operation_result
game_recorder_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件game_recorder_event
game_recorder_event(event_type: String, data_json: String, error: String)游戏录屏、剪辑操作与录屏分享按钮。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Inner audio
InnerAudio
背景音频上下文的播放、定位、属性与事件。
统一桥接METHODS10
METHOD统一桥接信号回调set_inner_audio_option
set_inner_audio_option(options: Dictionary = {}) -> void设置 inner_audio_option；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
optionsDictionary{}直接传给平台 API 的 options object。
METHOD统一桥接信号回调create_inner_audio_context
create_inner_audio_context(create_options: Dictionary = {}, properties: Dictionary = {}) -> void创建 InnerAudioContext，并应用创建参数与实例属性。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
create_optionsDictionary{}传给该接口的 create_options 参数。
propertiesDictionary{}传给该接口的 properties 参数。
METHOD统一桥接信号回调set_inner_audio_properties
set_inner_audio_properties(properties: Dictionary = {}) -> void设置 inner_audio_properties；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
propertiesDictionary{}传给该接口的 properties 参数。
METHOD统一桥接信号回调get_inner_audio_state
get_inner_audio_state() -> void读取 inner_audio_state；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调inner_audio_play
inner_audio_play() -> void调用 inner_audio_play；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调inner_audio_pause
inner_audio_pause() -> void调用 inner_audio_pause；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调inner_audio_stop
inner_audio_stop() -> void调用 inner_audio_stop；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接信号回调inner_audio_seek
inner_audio_seek(position: float) -> void调用 inner_audio_seek；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
positionfloat必填传给该接口的 position 参数。
METHOD统一桥接信号回调stop_inner_audio_listener
stop_inner_audio_listener(event_types: Array = []) -> void停止 inner_audio_listener；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
event_typesArray[]传给该接口的 event_types 参数。
METHOD统一桥接信号回调inner_audio_destroy
inner_audio_destroy() -> void调用 inner_audio_destroy；背景音频上下文的播放、定位、属性与事件。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
SIGNALS2
SIGNAL统一桥接事件inner_audio_operation_result
inner_audio_operation_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件inner_audio_event
inner_audio_event(event_type: String, data_json: String, error: String)背景音频上下文的播放、定位、属性与事件。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Network status
网络状态
读取网络类型并监听网络变化。
跨宿主同名METHODS3
METHOD跨宿主同名信号回调get_network_type
get_network_type() -> void读取当前网络类型，例如 wifi、4g 或 none。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD跨宿主同名信号回调start_network_status_listener
start_network_status_listener() -> void开始监听网络连接状态和网络类型变化。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD跨宿主同名同步返回stop_network_status_listener
stop_network_status_listener() -> bool停止 network_status_listener；读取网络类型并监听网络变化。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS2
SIGNAL跨宿主同名事件network_type_received
network_type_received(network_type: String, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
network_typeString事件参数传给该接口的 network_type 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL跨宿主同名事件network_status_changed
network_status_changed(is_connected: bool, network_type: String, data_json: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
is_connectedbool事件参数传给该接口的 is_connected 参数。
network_typeString事件参数传给该接口的 network_type 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
Sensors & battery
传感器与电量
加速度、陀螺仪、罗盘、设备方向和电量。
微信文档METHODS10
METHOD微信文档信号回调start_accelerometer
start_accelerometer(interval: String = "normal") -> void开始 accelerometer；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
intervalString"normal"采样频率：game、ui 或 normal。
METHOD微信文档信号回调stop_accelerometer
stop_accelerometer() -> void停止 accelerometer；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_gyroscope
start_gyroscope(interval: String = "normal") -> void开始 gyroscope；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
intervalString"normal"采样频率：game、ui 或 normal。
METHOD微信文档信号回调stop_gyroscope
stop_gyroscope() -> void停止 gyroscope；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_compass
start_compass() -> void开始 compass；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调stop_compass
stop_compass() -> void停止 compass；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_device_motion_listening
start_device_motion_listening(interval: String = "normal") -> void开始 device_motion_listening；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
intervalString"normal"采样频率：game、ui 或 normal。
METHOD微信文档信号回调stop_device_motion_listening
stop_device_motion_listening() -> void停止 device_motion_listening；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调get_battery_info
get_battery_info() -> void读取 battery_info；加速度、陀螺仪、罗盘、设备方向和电量。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回get_battery_info_sync
get_battery_info_sync() -> Dictionary同步返回电量百分比与充电状态。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS7
SIGNAL微信文档事件sensor_started
sensor_started(sensor: String, success: bool, error: String)加速度、陀螺仪、罗盘、设备方向和电量。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
sensorString事件参数传给该接口的 sensor 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件sensor_stopped
sensor_stopped(sensor: String, success: bool, error: String)加速度、陀螺仪、罗盘、设备方向和电量。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
sensorString事件参数传给该接口的 sensor 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件accelerometer_changed
accelerometer_changed(x: float, y: float, z: float, data_json: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
xfloat事件参数传给该接口的 x 参数。
yfloat事件参数传给该接口的 y 参数。
zfloat事件参数传给该接口的 z 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
SIGNAL微信文档事件gyroscope_changed
gyroscope_changed(x: float, y: float, z: float, data_json: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
xfloat事件参数传给该接口的 x 参数。
yfloat事件参数传给该接口的 y 参数。
zfloat事件参数传给该接口的 z 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
SIGNAL微信文档事件compass_changed
compass_changed(direction: float, accuracy: Variant, data_json: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
directionfloat事件参数传给该接口的 direction 参数。
accuracyVariant事件参数传给该接口的 accuracy 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
SIGNAL微信文档事件device_motion_changed
device_motion_changed(alpha: float, beta: float, gamma: float, data_json: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
alphafloat事件参数传给该接口的 alpha 参数。
betafloat事件参数传给该接口的 beta 参数。
gammafloat事件参数传给该接口的 gamma 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
SIGNAL微信文档事件battery_info_received
battery_info_received(level: int, is_charging: bool, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
levelint事件参数传给该接口的 level 参数。
is_chargingbool事件参数传给该接口的 is_charging 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Audio interruption
音频中断
监听系统级音频中断与恢复。
微信文档METHODS2
METHOD微信文档信号回调start_audio_interruption_listener
start_audio_interruption_listener() -> void开始 audio_interruption_listener；监听系统级音频中断与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_audio_interruption_listener
stop_audio_interruption_listener() -> bool停止 audio_interruption_listener；监听系统级音频中断与恢复。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS1
SIGNAL微信文档事件audio_interruption
audio_interruption(event_type: String, data_json: String, error: String)监听系统级音频中断与恢复。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
event_typeString事件参数事件类型。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Theme & performance
主题与性能
主题变化、性能条目与性能上报。
微信文档METHODS4
METHOD微信文档信号回调start_theme_change_listener
start_theme_change_listener() -> void开始 theme_change_listener；主题变化、性能条目与性能上报。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_theme_change_listener
stop_theme_change_listener() -> bool停止 theme_change_listener；主题变化、性能条目与性能上报。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档同步返回get_performance_entries
get_performance_entries(entry_type: String = "") -> Array同步读取平台性能条目；可按 entry_type 过滤。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值Array
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
entry_typeString""传给该接口的 entry_type 参数。
METHOD微信文档同步返回report_performance
report_performance(id: int, value: float, dimensions: Variant = null) -> bool向平台上报自定义性能指标。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
idint必填传给该接口的 id 参数。
valuefloat必填传给该接口的 value 参数。
dimensionsVariantnull传给该接口的 dimensions 参数。
SIGNALS1
SIGNAL微信文档事件theme_changed
theme_changed(theme: String, data_json: String, error: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
themeString事件参数传给该接口的 theme 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
App control
小程序跳转
小程序跳转、返回、退出与重启。
微信文档METHODS4
METHOD微信文档信号回调exit_mini_program
exit_mini_program() -> void调用 exit_mini_program；小程序跳转、返回、退出与重启。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调restart_mini_program
restart_mini_program(path: String) -> void调用 restart_mini_program；小程序跳转、返回、退出与重启。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
pathString必填目标路径或小程序页面路径。
SIGNALS1
Cloud & open data
托管数据与开放域
用户、好友、群托管数据与开放数据域消息。
微信专属METHODS7
METHOD微信专属信号回调set_user_cloud_storage
set_user_cloud_storage(kv_data: Dictionary) -> void写入用户托管数据，供开放数据域排行榜等场景使用。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
kv_dataDictionary必填传给该接口的 kv_data 参数。
METHOD微信专属信号回调remove_user_cloud_storage
remove_user_cloud_storage(key_list: Array) -> void移除 user_cloud_storage；用户、好友、群托管数据与开放数据域消息。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
key_listArray必填传给该接口的 key_list 参数。
METHOD微信专属信号回调get_user_cloud_storage_keys
get_user_cloud_storage_keys() -> void读取 user_cloud_storage_keys；用户、好友、群托管数据与开放数据域消息。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信专属信号回调get_user_cloud_storage
get_user_cloud_storage(key_list: Array) -> void读取 user_cloud_storage；用户、好友、群托管数据与开放数据域消息。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
key_listArray必填传给该接口的 key_list 参数。
METHOD微信专属信号回调get_friend_cloud_storage
get_friend_cloud_storage(key_list: Array) -> void读取 friend_cloud_storage；用户、好友、群托管数据与开放数据域消息。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
key_listArray必填传给该接口的 key_list 参数。
METHOD微信专属信号回调get_group_cloud_storage
get_group_cloud_storage(key_list: Array, share_ticket: String = "", group_id: String = "") -> void读取 group_cloud_storage；用户、好友、群托管数据与开放数据域消息。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
key_listArray必填传给该接口的 key_list 参数。
share_ticketString""传给该接口的 share_ticket 参数。
group_idString""传给该接口的 group_id 参数。
METHOD微信专属同步返回post_open_data_context_message
post_open_data_context_message(message: Dictionary, shared_canvas_mode: String = "offscreenCanvas") -> bool向开放数据域发送消息；返回是否成功发起。
平台支持微信专属
接口语义与微信隐私、Midas 或开放数据域能力绑定。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
messageDictionary必填传给该接口的 message 参数。
shared_canvas_modeString"offscreenCanvas"传给该接口的 shared_canvas_mode 参数。
SIGNALS1
SIGNAL微信专属事件cloud_storage_result
cloud_storage_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Service & subscribe
客服与订阅
客服会话与一次性订阅消息。
微信文档METHODS3
METHOD微信文档信号回调open_customer_service_conversation
open_customer_service_conversation(session_from: String = "", show_message_card: bool = false, send_message_title: String = "", send_message_path: String = "", send_message_img: String = "") -> void从用户触摸事件中打开客服会话。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
session_fromString""传给该接口的 session_from 参数。
show_message_cardboolfalse传给该接口的 show_message_card 参数。
send_message_titleString""传给该接口的 send_message_title 参数。
send_message_pathString""传给该接口的 send_message_path 参数。
send_message_imgString""传给该接口的 send_message_img 参数。
METHOD微信文档信号回调request_subscribe_message
request_subscribe_message(tmpl_ids: Array) -> void请求 subscribe_message；客服会话与一次性订阅消息。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
tmpl_idsArray必填传给该接口的 tmpl_ids 参数。
METHOD微信文档信号回调request_subscribe_system_message
request_subscribe_system_message(msg_type_list: Array) -> void请求 subscribe_system_message；客服会话与一次性订阅消息。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
msg_type_listArray必填传给该接口的 msg_type_list 参数。
SIGNALS2
SIGNAL微信文档事件customer_service_result
customer_service_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件subscribe_message_result
subscribe_message_result(action: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
actionString事件参数触发本次结果的具体平台动作。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Update & runtime
更新与运行时
更新管理、内存告警、窗口和运行时错误。
微信文档METHODS8
METHOD微信文档信号回调start_update_listener
start_update_listener() -> void绑定更新管理器的 check、ready 与 failed 事件。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回apply_update
apply_update() -> bool应用已准备好的更新并重启小游戏。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档信号回调start_memory_warning_listener
start_memory_warning_listener() -> void开始 memory_warning_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_memory_warning_listener
stop_memory_warning_listener() -> bool停止 memory_warning_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档信号回调start_window_resize_listener
start_window_resize_listener() -> void开始 window_resize_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_window_resize_listener
stop_window_resize_listener() -> bool停止 window_resize_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档信号回调start_unhandled_rejection_listener
start_unhandled_rejection_listener() -> void开始 unhandled_rejection_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_unhandled_rejection_listener
stop_unhandled_rejection_listener() -> bool停止 unhandled_rejection_listener；更新管理、内存告警、窗口和运行时错误。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
SIGNALS6
SIGNAL微信文档事件update_checked
update_checked(has_update: bool, data_json: String, error: String)更新管理、内存告警、窗口和运行时错误。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
has_updatebool事件参数传给该接口的 has_update 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件update_ready
update_ready(error: String)对应资源或更新准备完成时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件update_failed
update_failed(error: String)对应能力发生错误或失败时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件memory_warning
memory_warning(level: int, data_json: String, error: String)更新管理、内存告警、窗口和运行时错误。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
levelint事件参数传给该接口的 level 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件window_resized
window_resized(width: int, height: int, data_json: String, error: String)更新管理、内存告警、窗口和运行时错误。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
widthint事件参数传给该接口的 width 参数。
heightint事件参数传给该接口的 height 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件unhandled_rejection
unhandled_rejection(reason: String, data_json: String, error: String)更新管理、内存告警、窗口和运行时错误。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
reasonString事件参数传给该接口的 reason 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Screen & capture
屏幕与录屏状态
亮度、截屏、系统录屏状态和捕获效果。
微信文档METHODS8
METHOD微信文档信号回调get_screen_brightness
get_screen_brightness() -> void异步读取屏幕亮度，取值范围为 0 到 1。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调set_screen_brightness
set_screen_brightness(value: float) -> void设置 screen_brightness；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
valuefloat必填传给该接口的 value 参数。
METHOD微信文档信号回调start_user_capture_screen_listener
start_user_capture_screen_listener() -> void开始 user_capture_screen_listener；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_user_capture_screen_listener
stop_user_capture_screen_listener() -> bool停止 user_capture_screen_listener；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档信号回调get_screen_recording_state
get_screen_recording_state() -> void读取 screen_recording_state；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档信号回调start_screen_recording_state_listener
start_screen_recording_state_listener() -> void开始 screen_recording_state_listener；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD微信文档同步返回stop_screen_recording_state_listener
stop_screen_recording_state_listener() -> bool停止 screen_recording_state_listener；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD微信文档信号回调set_visual_effect_on_capture
set_visual_effect_on_capture(effect: String = "none") -> void设置 visual_effect_on_capture；亮度、截屏、系统录屏状态和捕获效果。
平台支持微信文档
当前文档和自动化覆盖以微信为主；抖音需确认存在同名能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
effectString"none"传给该接口的 effect 参数。
SIGNALS6
SIGNAL微信文档事件screen_brightness_received
screen_brightness_received(value: float, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
valuefloat事件参数传给该接口的 value 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件screen_brightness_set
screen_brightness_set(value: float, success: bool, error: String)亮度、截屏、系统录屏状态和捕获效果。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
valuefloat事件参数传给该接口的 value 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件user_capture_screen
user_capture_screen(data_json: String, error: String)亮度、截屏、系统录屏状态和捕获效果。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件screen_recording_state_received
screen_recording_state_received(state: String, data_json: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
stateString事件参数传给该接口的 state 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件screen_recording_state_changed
screen_recording_state_changed(state: String, data_json: String, error: String)监听期间的平台状态发生变化时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
stateString事件参数传给该接口的 state 参数。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL微信文档事件visual_effect_on_capture_set
visual_effect_on_capture_set(effect: String, success: bool, error: String)亮度、截屏、系统录屏状态和捕获效果。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
effectString事件参数传给该接口的 effect 参数。
successbool事件参数操作是否成功。
errorString事件参数空字符串表示成功，否则为错误信息。
System information
系统信息
能力探测、设备、窗口、启动参数和安全区。
统一桥接METHODS9
METHOD统一桥接同步返回can_i_use
can_i_use(schema: String) -> bool按平台 schema 同步探测 API、参数或返回字段是否可用。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值bool
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
参数
schemaString必填传给该接口的 schema 参数。
METHOD统一桥接同步返回get_device_info
get_device_info() -> Dictionary读取 device_info；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_app_base_info
get_app_base_info() -> Dictionary读取 app_base_info；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_system_setting
get_system_setting() -> Dictionary读取 system_setting；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_app_authorize_setting
get_app_authorize_setting() -> Dictionary读取 app_authorize_setting；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_system_info
get_system_info() -> Dictionary同步读取完整系统信息；不支持时返回空 Dictionary。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_launch_options
get_launch_options() -> Dictionary读取 launch_options；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
METHOD统一桥接同步返回get_window_info
get_window_info() -> Dictionary读取 window_info；能力探测、设备、窗口、启动参数和安全区。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值Dictionary
同步返回；离开小游戏运行时会返回类型安全的默认值。
非小游戏环境Safe fallback
返回空值、false 或调用方提供的默认值，不会崩溃。
此方法没有参数。
Generic bridge
通用平台桥接
调用尚未封装的平台 API，并用统一信号接收结果。
跨宿主同名METHODS1
METHOD跨宿主同名信号回调call_api
call_api(api_name: String, params: Dictionary = {}, completion_mode: String = "auto") -> void调用未被显式封装的平台 API；位置参数可通过 _args 数组传入。
平台支持跨宿主同名
映射多个小游戏宿主的同名能力；仍必须按宿主版本做 capability gating。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
api_nameString必填传给该接口的 api_name 参数。
paramsDictionary{}平台 API 参数字典。
completion_modeString"auto"传给该接口的 completion_mode 参数。
SIGNALS1
SIGNAL跨宿主同名事件generic_api_result
generic_api_result(api_name: String, success: bool, data_json: String, error: String)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
api_nameString事件参数传给该接口的 api_name 参数。
successbool事件参数操作是否成功。
data_jsonString事件参数平台原始响应序列化后的 JSON 字符串。
errorString事件参数空字符串表示成功，否则为错误信息。
Clipboard & native UI
剪贴板与原生 UI
剪贴板、常亮、Toast、Loading 和 Modal。
统一桥接METHODS7
METHOD统一桥接信号回调set_clipboard
set_clipboard(data: String) -> void写入系统剪贴板。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
dataString必填发送的数据内容。
METHOD统一桥接信号回调get_clipboard
get_clipboard() -> void读取系统剪贴板，结果由 clipboard_received 返回。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
此方法没有参数。
METHOD统一桥接无返回set_keep_screen_on
set_keep_screen_on(keep_on: bool) -> void设置 keep_screen_on；剪贴板、常亮、Toast、Loading 和 Modal。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
keep_onbool必填传给该接口的 keep_on 参数。
METHOD统一桥接无返回show_toast
show_toast(title: String, icon: String = "none", duration_ms: int = 1500) -> void显示 toast；剪贴板、常亮、Toast、Loading 和 Modal。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
titleString必填传给该接口的 title 参数。
iconString"none"传给该接口的 icon 参数。
duration_msint1500传给该接口的 duration_ms 参数。
METHOD统一桥接信号回调show_modal
show_modal(title: String, content: String) -> void显示平台原生确认弹窗，选择结果由 modal_result 返回。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；先连接关联信号，再调用方法。
非小游戏环境Safe fallback
结果型调用会发出包含 Not in mini-game environment 的信号。
参数
titleString必填传给该接口的 title 参数。
contentString必填传给该接口的 content 参数。
METHOD统一桥接无返回show_loading
show_loading(title: String = "Loading...") -> void显示 loading；剪贴板、常亮、Toast、Loading 和 Modal。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
参数
titleString"Loading..."传给该接口的 title 参数。
METHOD统一桥接无返回hide_loading
hide_loading() -> void隐藏 loading；剪贴板、常亮、Toast、Loading 和 Modal。
平台支持统一桥接
运行时按目标平台分发，但不代表三个宿主均已验证该能力。
返回值void
无同步返回；属于实例操作或 fire-and-forget 调用。
非小游戏环境Safe fallback
安全 no-op，不会在编辑器中报错。
此方法没有参数。
SIGNALS2
SIGNAL统一桥接事件clipboard_received
clipboard_received(data: String, error: String)异步数据返回时触发；JSON 字段保留平台原始响应。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
dataString事件参数发送的数据内容。
errorString事件参数空字符串表示成功，否则为错误信息。
SIGNAL统一桥接事件modal_result
modal_result(confirmed: bool)相关平台操作完成后触发；success/error 字段表示结果。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
confirmedbool事件参数传给该接口的 confirmed 参数。
Lifecycle
应用生命周期
前后台切换，以及宿主实际暴露时的 JavaScript 运行时错误事件。
统一桥接SIGNALS3
SIGNAL统一桥接事件app_shown
app_shown(options_json: String)前后台切换，以及宿主实际暴露时的 JavaScript 运行时错误事件。 相关事件发生时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
options_jsonString事件参数传给该接口的 options_json 参数。
SIGNAL统一桥接事件app_error
app_error(message: String)对应能力发生错误或失败时触发。
触发方式Signal
使用 connect() 连接回调；监听型信号可能多次触发。
错误约定error == ""
包含 error 参数时，空字符串表示成功。
JSON 约定JSON.parse_string()
data_json 等字段是序列化 JSON，字段形状由宿主平台决定。
载荷
messageString事件参数传给该接口的 message 参数。
// NEED MORE CONTEXT?
签名在这里，完整用法也在。
参数 Dictionary 的业务字段、权限、用户手势与平台基础库版本，请结合使用指南和源码查看。