StartErrorCode

类型：enum

SDK start 启动失败对应的错误码信息

• 成员

  属性	值	说明
  ERROR_START_GENERAL	10000	启动云手机失败。原因：通用错误。建议：请检查启动云手机 start 接口参数。
  ERROR_START_STREAM_AUTO_PLAY_FAILED	10008	启动云手机失败。原因：串流自动播放失败。建议：使用 playByInteraction() 方法进行处理。
  ERROR_START_AUTHENTICATION_KEY_FAILED	10009	启动云手机失败。原因：火山引擎服务鉴权失败。建议：请检查 Token 有效期。
  ERROR_START_CONNECTION_ENDED	10011	启动云手机失败。原因：在调用启动接口后，且启动成功回调触发前，云手机被停止（可能是因为服务端 “游戏” 崩溃或者调用了OpenAPI stop 请求）。
  ERROR_START_USER_CONFLICT	10018	启动云手机失败。原因：触发了多设备冲突逻辑。建议：需要客户端提示用户不要进行多开操作。
  ERROR_START_INVALID_LOCAL_TIME	10027	启动云手机失败。原因：用户手机时间和服务端时间相差超过7天，导致鉴权 Token 过期。建议：需要客户端提示用户把手机时间修正为标准时间。
  ERROR_START_PRODUCT_NOT_EXIST	11001	启动云手机失败。原因：业务 ID 错误。建议：请通过火山引擎云手机控制台『业务详情』页面获取。
  ERROR_START_APPLICATION_NOT_EXIST	11002	启动云手机失败。原因：应用 ID 错误。建议：请通过火山引擎云手机控制台『应用管理』页面获取。
  ERROR_START_CONFIGURATION_CODE_NOT_EXIST	11003	启动云手机失败。原因：资源套餐 ID 错误。建议：请通过调用服务端 ListPod 接口获取。
  ERROR_START_POD_NOT_EXIST	11004	启动云手机失败。原因：实例 ID 错误。建议：请通过火山引擎云手机控制台『实例管理』页面获取。
  ERROR_REQUEST_PARAMETER_BINDING_ERROR	11005	请求参数绑定错误。建议：请检查请求参数是否正确。
  ERROR_INVALID_REQUEST_PARAMETER	11006	请求参数错误。建议：请检查请求参数是否正确。
  ERROR_BUSINESS_ID_ERROR	11007	业务 ID 错误。建议：请检查业务是否存在，可通过火山引擎云手机控制台『业务详情』页面获取。
  ERROR_ACCOUNT_ID_INIT_ERROR	11008	火山引擎账号 ID 错误。建议：请检查使用的账号和签名，可通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取正确的账号。
  ERROR_ACCOUNT_ID_NOT_FOUND	11009	火山引擎账号 ID 不合法。建议：通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取正确的账号。。
  ERROR_USER_IS_INVALID	11010	子账号不合法。建议：请检查子账号是否有业务和实例相关操作权限。可参考 创建和管理子账号权限。
  ERROR_GENERIC_INSTANCE_ERROR	11011	套餐、实例不存在。建议：请检查实例状态、订购的资源是否过期。
  ERROR_INSTANCE_OFFLINE	11012	实例离线。建议：请检查实例状态。
  ERROR_UNIVERSAL_STARTUP_FAILED	11013	启动云手机失败。
  ERROR_INTERNAL_POD_START_FAILED	11014	启动云手机失败。建议：请检查实例状态或联系火山引擎云手机技术支持。
  ERROR_INTERNAL_POD_MUTE_FAILED	11015	启动云手机失败。建议：请检查实例状态或联系火山引擎云手机技术支持。
  ERROR_INTERNAL_CONFIG_FAILED	11016	启动云手机失败。建议：请检查实例状态或联系火山引擎云手机技术支持。
  ERROR_ACCOUNTID_MISMATCH	11019	指定的火山引擎账号校验失败。建议：通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取正确的账号。
  ERROR_POD_NOT_READY	11020	云机实例未就绪。建议：请检查指定的实例已开机运行。
  ERROR_DOWN_STREAM_UNKNOWN_ERROR	11021	服务端下游错误。建议：请联系火山引擎云手机技术支持。

• 示例

  vePlayer = new Player(config).then(res=>{
       console.log('start success, result:', res)
   }).catch(err=>{
       console.error('start error, errorMessage:', err)
   })
  

ErrorCode

类型：enum

SDK 运行过程中的error错误回调中对应的错误码信息

• 成员

  属性	值	说明
  ERROR_STREAM_GENERAL	20000	串流连接错误。原因：网络原因。建议：请检查网络。
  ERROR_STREAM_CHANGE_CLARITY_ID_NOT_IN_START_STATE	20002	切换清晰度失败。原因：当前处于非播放状态 。建议：请调用启动接口，在收到播放成功回调后，再调用切换清晰度档位接口。
  ERROR_SDK_GENERAL	30000	客户端 SDK 通用错误。
  ERROR_SDK_INIT_FAILED	30001	客户端 SDK 初始化失败。
  ERROR_SDK__EMPTY	30002	客户端调用 SDK 接口错误。原因：接口参数为空。建议：请参考接口说明文档，检查接口参数。
  ERROR_SDK_LACK_OF_LOCATION_PERMISSION	30007	SDK 无定位服务权限。原因：定位服务权限未开启。建议：检查设备定位服务权限是否开启。
  ERROR_INIT_ACCOUNT_ID_ILLEGAL	30009	未指定火山引擎账号。建议：通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取正确的账号。
  ERROR_SDK_MANY_CONNECTION	30012	启动云手机失败。原因：创建连接超出浏览器限制。
  ERROR_SDK_USER_HAS_LEAVE_ROOM	30013	启动云手机失败。原因：用户已终止连接。
  ERROR_SDK_JOIN_ROOM_FAILED	30014	启动云手机失败。原因：用户连接失败。
  ERROR_REMOTE_ABNORMAL_EXIT	40000	应用停止。原因：云机服务异常退出。
  ERROR_REMOTE_CRASH	40001	应用停止。原因：服务端应用崩溃。建议：请联系火山引擎技术支持。
  ERROR_STREAM_STOPPED_AUTO_RECYCLE	40004	应用停止。原因：5分钟未操作，服务端自动断开应用连接。
  ERROR_REMOTE_STOPPED_API	40006	应用停止。原因：服务端主动停止了应用。
  ERROR_GAME_STOPPED_DUPLICATE_START	40007	应用停止。原因：在不同设备上，前后使用了相同的 userId 和 applicationId，前一个 Start 请求会返回此错误码。 建议：请检查调用启动云手机接口的参数是否重复。如果需要重新启动被停止的应用，请再次使用相同的 userId 和 applicationId 调用启动云手机接口。
  ERROR_POD_STOPPED_BACKGROUND_TIMEOUT	40008	应用停止。原因：应用切换后台，超过指定的保活时长未切换前台，服务端自动断开连接。建议：客户端需要提示用户因为应用切后台超过保活时长，连接断开。
  ERROR_POD_EXIT_GENERAL	40009	应用停止。原因：云机服务退出。建议：请联系火山引擎技术支持。
  ERROR_GAME_ALREADY_STOPPED	40010	应用停止。原因：重连失败，目前已经没有推流，应用已经停止。
  ERROR_SET_INVALID_AUTO_RECYCLE_TIME	40039	设置无操作推流服务回收时长错误，请查看 设置无操作推流服务回收时长 接口文档进行设置。
  ERROR_STORAGE_NOT_ENOUGH	40045	云手机存储空间不足。原因：存储云手机画面截图文件的空间不足，请清理存储空间后再尝试截图操作。
  ERROR_POD_UNKNOWN_FAILURE	40046	未知错误，云手机画面截图失败，请稍后重试。
  ERROR_REMOTE_STOPPED_TOKEN_EXPIRED	40055	应用停止。原因：拉流 token 已过期，请再次调用 start 接口重新启动拉流。
  ERROR_MESSAGE_GENERAL	50000	未知错误
  ERROR_MESSAGE_NOT_READY	50001	消息通道未就绪。原因：客户端 SDK 与火山引擎云手机 PaaS 服务未连接。建议：请监听 message-channel-connected 回调后，再使用 sendMessage 接口进行重新发送。
  ERROR_MESSAGE_FAILED_TO_PARSE_MSG	50002	消息通道数据解析失败。原因：无法解析接收到的消息。
  ERROR_MESSAGE_CHANNEL_UID_ILLEGAL	50003	指定的消息通道 ID 无效。原因：指定的消息通道 ID 与云机初始化 veMessageChannelClient 时填入的用户 ID 不符。
  ERROR_MESSAGE_FAILED	50004	发送消息错误。建议：请检查网络。
  ERROR_MESSAGE_NOT_CLOUD_RUNTIME	50005	消息通道错误。原因：云机 SDK 未运行。建议：请检查网络。
  ERROR_MESSAGE_CONNECT_VERIFY_FAILED	50006	消息通道错误。原因：鉴权失败。建议：请检查参数配置。
  ERROR_MESSAGE_OVER_SIZED	50007	通过客户端 SDK 发送的消息错误。原因：消息包体过大（不应超过64kb）。建议：减小发送包体大小，重新发送。
  ERROR_MESSAGE_NOT_CONNECTED	50008	发送消息错误。原因：客户端 SDK 与火山引擎云手机 PaaS 服务未连接。建议：请检查网络后，重新调用发送触控事件、按键事件、鼠标事件接口，进行消息发送。
  ERROR_MESSAGE_TIMEOUT_ILLEGAL	50009	发送消息错误。原因：指定的消息发送超时时长不符合要求，必须为大于0的值。
  ERROR_NET_REQUEST_ERROR	60001	网络请求失败。
  ERROR_HTTP_REQUEST_ERROR	60002	网络请求失败。
  ERROR_FILE_CHANNEL_FILE_NOT_FOUND	71001	文件传输失败。原因：推送或拉取的文件不存在。建议：请检查文件名是否正确且确保文件存在后重试。
  ERROR_FILE_CHANNEL_FILE_NO_ACCESS	71002	文件传输失败。原因：推送或拉取的文件无权限访问。建议：请检查文件的访问权限。
  ERROR_FILE_CHANNEL_NETWORK_ABORT	71003	文件传输失败。原因：推送或拉取文件过程中网络异常中断。建议：请检查网络连接后重试。
  ERROR_FILE_CHANNEL_TIMEOUT	71004	文件传输失败。原因：推送或拉取文件过程中超时。建议：请检查网络连接后重试。
  ERROR_FILE_CHANNEL_STORAGE_NOT_ENOUGH	71005	文件传输失败。原因：推送或拉取文件磁盘空间不足。建议：请确保有足够的存储空间保存文件。
  ERROR_FILE_CHANNEL_INTERNAL_ERROR	71006	文件传输失败。原因：推送或拉取文件发生内部错误。

• 示例

  vePlayer = new Player(config);
   vePlayer.on('error', err => {
       console.log('errorMessage:',err)
   })
  

WarningCode

类型：enum

SDK 运行过程中的warning警告回调中对应的警告码信息

• 成员

  属性	值	说明
  WARNING_START_NO_STOP_BEFORE	10010	启动云手机失败。原因：同一个客户端连续调用了两次启动接口之间没有调用停止接口。建议：请调用停止接口，结束上一次 “游戏”，再调用启动接口。
  WARNING_START_INVALID_AUTO_RECYCLE_TIME	10019	设置无操作推流服务回收时长出错。建议：请参考 setAutoRecycleTime 接口说明进行设置。
  WARNING_START_AUDIO_AUTO_PLAY_FAILED	10022	启动云手机后，音频自动播放失败。原因：浏览器对网页上的自动播放 Autoplay 功能做了限制，不允许音频自动播放。 建议：监听 UI 点击事件回调，通过 playByInteraction 接口，提示和引导用户与页面进行交互来恢复音频播放，从而解除浏览器对音频自动播放的限制。
  WARNING_SDK_LACK_OF_LOCATION_PERMISSION	30007	SDK 无定位服务权限。原因：定位服务权限未开启。建议：检查设备定位服务权限是否开启。
  WARNING_TOKEN_WILL_EXPIRE	34001	拉流 token 即将过期，如果想继续维持拉流状态，请调用 updateExpireTime 接口以延长拉流有效期。
  WARNING_LOCAL_ALREADY_SET_BACKGROUND	40037	应用切换后台失败。原因：应用已处于后台，请勿重复调用。
  WARNING_LOCAL_ALREADY_SET_FOREGROUND	40038	应用切换前台失败。原因：应用已处于前台，请勿重复调用。
  WARNING_FOREGROUND_CHANGE_STATUS_NO_PACKAGENAME	40040	云机应用切换前台失败。原因：应用包名不存在。建议：请检查指定的应用包名是否正确。
  WARNING_FOREGROUND_CHANGE_STATUS_REPEAT	40041	云机应用切换前台失败。原因：云机应用已处于前台，请勿重复调用。
  WARNING_FOREGROUND_CHANGE_STATUS_NOTFOND	40043	云机应用切换前台失败。原因：指定的应用不在后台或已被关闭。
  WARNING_GAME_STOPPED_INGAME_EXIT	40044	应用停止。原因：一般是因为云机运行的应用主动退出了。建议：客户端需要提示用户目前应用主动被结束了，如果需要，可以重新开始应用。

• 示例

  vePlayer = new Player(config);
   vePlayer.on('warning', warning => {
       console.log('warningMessage:',warning)
   })