vePhoneSDK #

类型：class

isSupported #

兼容性检测，判断浏览器是否支持从云机拉流。

• 类型

  () => Promise<boolean>
  

• 示例

  await vePhoneSDK.isSupported()
  

new vePhoneSDK() #

实例化方法，通过 new vePhoneSDK(config) 调用

• 类型

  constructor(options: CloudCoreConfig)
  

• 参数

  • config
    类型：CloudCoreConfig
    入参格式JSON

• 示例

  let config = {"userId":"your_user_id",...};
  let vePlayer = new vePhoneSDK(config);
  

start #

启动云手机服务
启动云手机，需要在初始化成功之后调用。请确认云手机业务 ID 等信息正确。

• 类型

  (options: CoreStartConfig) => Promise<{ width: number; height: number; }>
  

• 参数

  • options
    类型：CoreStartConfig
    入参格式JSON

• 返回值
  类型：Promise<{ width: number; height: number; }>

  • width 云机实例的宽度
  • height 云机实例的高度

• 示例

  vePhone.start(options).then((info) => {
    console.log('start successfully',info)
  }).catch((error) => {
    console.error('start failed', error)
  });
  
  

• 参考

  • 启动云手机可能返回的错误码参考 StartErrorCode

stop #

停止云手机服务
停止从云机拉流，并且退出，但不会回收客户端本地资源。

• 类型

  () => Promise<void>
  

• 返回值
  类型：Promise<void>

destroy #

销毁实例
销毁客户端实例，释放资源。

• 类型

  () => Promise<void>
  

• 返回值
  类型：Promise<void>

pause #

暂停拉取音视频流

• 类型

  () => void
  

resume #

恢复已经暂停的音视频流

• 类型

  () => void
  

playByInteraction #

自动播放失败的情况下，提示和引导用户与页面进行交互来恢复播放

• 类型

  (reload?: boolean) => Promise<void>
  

• 参数

  • reload
    类型：boolean
    默认值：false

• 返回值
  类型：Promise<void>

• 示例
  当检测到自动播放失败的报错后，在页面上动态显示一个按钮让用户点击:

  vePlayer.start(options).then(() => {
    console.log('start successfully')
  }).catch((e) => {
    if (e.errorCode === 10008) {
       // 弹出引导用户点击继续的 UI 界面提示
       showBtnUI();
    }
  })；
  btn.onclick = () => {
    vePlayer.playByInteraction();
  };
  

setVideoStreamProfileId #

清晰度切换
在云手机运行过程中，通过指定清晰度档位 ID，切换视频流的清晰度。

• 类型

  (id: number) => any
  

• 参数

  • id
    类型：number
    有关 streamProfileId 的可选值和详细的清晰度配置，参考云手机清晰度档位说明

• 返回值
  类型：any

sendMessage #

客户端发送消息到云机实例。

• 类型

  ({ message, needAck, timeout, destUserId, }: { message: ArrayBuffer | string; needAck?: boolean; timeout?: number; destUserId?: string;}) => Promise<number>
  

• 参数

  • params
    类型：{ message: ArrayBuffer | string; needAck?: boolean | undefined; timeout?: number | undefined; destUserId?: string | undefined; }
    入参格式JSON

    • 成员

      名称	类型	描述
      message	string | ArrayBuffer	消息内容
      needAck	boolean | undefined	发送的消息否需要应答
      timeout	number | undefined	应答消息的超时时间，单位 ms
      destUserId	string | undefined	云机应用初始化 veMessageChannelClient 时填入的目标用户 ID（如果 Message Channel 连接通道超过1条，必须指定 destUserId） 有关 Message Channel SDK 的使用方法，参考Message Channel SDK 接入说明

• 返回值
  类型：Promise<number> 分别返回发送「成功/失败」的状态

• 示例

  vePhone.sendMessage({
   message: 'message',
   needAck: true,
   timeout: 5 * 1000,
   destUserId: 'appname'
  })
  

sendClipBoardMessage #

发送客户端本地剪贴板消息到云机。

• 类型

  (text: string) => Promise<void>
  

• 参数

  • text
    类型：string

• 返回值
  类型：Promise<void>

launchApp #

启动云机应用

• 类型

  (id: string) => void
  

• 参数

  • id
    类型：string
    启动的应用包名,也可传入应用 ID

setRemoteAppForeground #

云机应用切换到前台

• 类型

  (packageName?: string) => Promise<void>
  

• 参数

  • packageName
    类型：string | undefined
    应用包名

• 返回值
  类型：Promise<void>

closeApp #

关闭云机应用

• 类型

  (id: string) => void
  

• 参数

  • id
    类型：string
    关闭的应用包名,也可传入应用 ID

getRemoteBackgroundAppList #

获取已切换到后台的云机应用列表

• 类型

  () => Promise<string[]>
  

• 返回值
  类型：Promise<string[]>

• 示例

  vePlayer.getRemoteBackgroundAppList();
  

setAudioMute #

关闭/开启播放声音
在调用 start() 接口之后才可调用。

• 类型

  (mute: boolean) => void
  

• 参数

  • mute
    类型：boolean
    是否静音，默认为false,不静音

muteAudio #

媒体流静音开关
媒体流静音开关，在调用 start() 接口之后才可调用。

• 类型

  (mute: boolean) => void
  

• 参数

  • mute
    类型：boolean
    是否静音，默认为false,不静音

isAudioMuted #

检查媒体流静音状态

• 类型

  () => boolean
  

• 返回值
  类型：boolean

  • true 静音
  • false 不静音

muteVideo #

媒体流视频开关

• 类型

  (mute: boolean) => void
  

• 参数

  • mute
    类型：boolean
    是否停止播放视频流,默认为false，播放

isVideoMuted #

检查媒体流视频播放状态
检查当前视频流是否处在停止播放状态。

• 类型

  () => boolean
  

• 返回值
  类型：boolean

  • true 停止
  • false 播放

getLocalAudioPlaybackVolume #

获取客户端本地播放音量

• 类型

  () => number
  

• 返回值
  类型：number 音量大小

setLocalAudioPlaybackVolume #

设置客户端本地播放音量

• 类型

  (volume: number) => void
  

• 参数

  • volume
    类型：number
    音量大小，范围 [0,1]

• 返回值
  -调节成功返回0，调节失败返回-1

volumeUp #

调高音量

• 类型

  () => void
  

• 返回值
  void

volumeDown #

调低音量

• 类型

  () => void
  

• 返回值
  void

getAudioPlaybackDeviceList #

获取音频播放设备列表

• 类型

  () => Promise<MediaDeviceInfo[]>
  

• 返回值
  类型：Promise<MediaDeviceInfo[]>

• 参考

  • MediaDeviceInfo

getAudioPlaybackDevice #

获取当前音频播放设备

• 类型

  () => string
  

• 返回值
  类型：string

• 参考

  • MediaDeviceInfo

getAudioCaptureDeviceList #

获取音频采集设备列表

• 类型

  () => Promise<MediaDeviceInfo[]>
  

• 返回值
  类型：Promise<MediaDeviceInfo[]>

• 参考

  • MediaDeviceInfo

getAudioCaptureDevice #

获取当前音频采集设备

• 类型

  () => string
  

• 返回值
  类型：string

• 参考

  • MediaDeviceInfo

setAudioPlaybackDevice #

设置音频播放设备

• 类型

  (deviceId: string) => void
  

• 参数

  • deviceId
    类型：string
    设备Id

setAudioCaptureDevice #

设置音频采集设备

• 类型

  (deviceId: string) => Promise<void>
  

• 参数

  • deviceId
  • 类型：string
  • 设备Id

startSendAudioStream #

采集并发送音频数据
开启采集麦克风音频数据后发送给云机实例。注意: 需要开启麦克风使用权限。

• 类型

  () => Promise<{ success: boolean; }>
  

• 返回值
  类型：Promise<{ success: boolean; }>

  • true 采集成功
  • false 采集失败

stopSendAudioStream #

关闭音频数据发送
关闭音频数据发送，并且不进行音频采集。

• 类型

  () => void
  

startVideoStream #

开启视频采集
获取本地摄像头权限后，采集并发送摄像头视频数据。

• 类型

  () => Promise<{ success: boolean; }>
  

• 返回值
  类型：Promise<{ success: boolean; }>

  • true 采集成功
  • false 采集失败

getVideoPlaybackDeviceList #

设置视频采集设备列表

• 类型

  () => Promise<MediaDeviceInfo[]>
  

• 返回值
  类型：Promise<MediaDeviceInfo[]>

getVideoCaptureDevice #

获取当前视频采集设备信息

• 类型

  () => string
  

• 返回值
  类型：string

switchCamera #

设置视频采集设备

• 类型

  (deviceId: string) => Promise<void>
  

• 参数

  • deviceId
    类型：string

• 返回值
  类型：Promise<void>

• 参考

  • MediaDeviceInfo

stopVideoStream #

停止视频采集
关闭视频数据发送，并且不进行视频采集。

• 类型

  () => Promise<void>
  

• 返回值
  类型：Promise<number>

  • 0 停止采集成功
  • -1 停止采集失败

setLocalVideoView #

设置本地视频画面布局

• 类型

  (options: { streamIndex: number; videoPlayerOption: Partial<VideoPlayerOption>;}) => HTMLVideoElement | undefined
  

• 参数

  • options
    类型：{ streamIndex: number; videoPlayerOption: VideoPlayerOption; }
    可选枚举值及说明如下：

    • 成员

      名称	类型	描述
      streamIndex	number	可选枚举值及说明如下： 1：RENDER_MODE_HIDDEN（默认，视窗填满优先；缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长） 2：RENDER_MODE_FIT（视频帧内容全部显示优先；缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长） 3：RENDER_MODE_Fill（视频帧自适应画布；视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化）
      videoPlayerOption	VideoPlayerOption	VideoPlayerOption

• 返回值
  类型：HTMLVideoElement | undefined

• 参考

  • HTMLVideoElement

setLocalVideoMirrorMode #

镜像翻转本地摄像头画面
使用“前置摄像头”采集时，是否开启镜像翻转本地摄像头画面

• 类型

  (mirrorType: number) => void
  

• 参数

  • mirrorType
    类型：number
    可选枚举值及说明如下：
    0（MIRROR_MODE_OFF，不开启镜像翻转，默认）
    1（MIRROR_MODE_ON，开启镜像翻转）

getLocalVideoMirrorMode #

获取是否开启镜像翻转本地摄像头画面
使用“前置摄像头”采集时，获取是否开启镜像翻转本地摄像头画面

• 类型

  () => number
  

• 返回值
  类型：number

  • 0（MIRROR_MODE_OFF，不开启镜像翻转）
  • 1（MIRROR_MODE_ON，开启镜像翻转）

updateVideoRenderMode #

设置视频渲染模式

• 类型

  (videoRenderMode: number) => void
  

• 参数

  • videoRenderMode
    类型：number
    • 0 VIDEO_RENDER_MODE.CONTAIN（默认）

• 1 VIDEO_RENDER_MODE.FILL: 非等比拉伸视频画面并充满整个容器

• 2 VIDEO_RENDER_MODE.COVER: 根据视频画面分辨率长边做裁剪

startExternalVideoTrack #

开启视频外部采集
需要先调用 setVideoSourceType，将采集模式设置为外部采集。

• 类型

  (streamIndex: number, mediaStreamTrack: MediaStreamTrack) => Promise<void>
  

• 参数

  • streamIndex
    类型：number
    外部采集的 AudioTrack 视频流 MediaStreamTrack
  • mediaStreamTrack
    类型：MediaStreamTrack
    外部采集的 AudioTrack 视频流 MediaStreamTrack

• 返回值
  类型：Promise<void>

stopExternalVideoTrack #

关闭视频外部采集
关闭视频的外部采集（需要先调用 setVideoSourceType，将采集模式设置为外部采集）。

• 类型

  () => Promise<void>
  

• 返回值
  类型：Promise<void>

startExternalAudioTrack #

开启音频外部采集
开启音频的外部采集（需要先调用 setAudioSourceType，将采集模式设置为外部采集）。

• 类型

  (streamIndex: number, mediaStreamTrack: MediaStreamTrack) => Promise<void>
  

• 参数

  • streamIndex
    类型：number
    外部采集的 AudioTrack 视频流 MediaStreamTrack
  • mediaStreamTrack
    类型：MediaStreamTrack
    外部采集的 AudioTrack 视频流 MediaStreamTrack

• 返回值
  类型：Promise<void>

stopExternalAudioTrack #

关闭音频外部采集
关闭音频的外部采集（需要先调用 setAudioSourceType，将采集模式设置为外部采集）。

• 类型

  () => Promise<void>
  

• 返回值
  类型：Promise<void>

sendTouchMessage #

发送触控事件

• 类型

  (touchMessage: { action: number; pointerId: number; x: number; y: number;}) => void
  

• 参数

  • touchMessage
    类型：{ action: number; pointerId: number; x: number; y: number; }
    入参格式JSON

    • 成员

      名称	类型	描述
      action	number	触控动作，可选 ACTION.TOUCH_START、ACTION.TOUCH_END、ACTION.TOUCH_MOVE（见 ACTION）
      pointerId	number	触控ID，用于标识单个手指
      x	number	取值范围 [0,1] 。云手机画面的 x 轴相对坐标，可根据 DOM 的宽高比以及 start 接口返回的云机实例宽高比进行计算
      y	number	取值范围 [0,1] 。云手机画面的 y 轴相对坐标，可根据 DOM 的宽高比以及 start 接口返回的云机实例宽高比进行计算

• 返回值
  分别返回发送「成功/失败」的状态

sendKeycodeMessage #

发送按键事件

• 类型

  (keycodeMessage: { keycode: number; action: number;}) => Promise<void>
  

• 参数

  • keycodeMessage
    类型：{ keycode: number; action: number; }
    入参格式为JSON

    • 成员

      名称	类型	描述
      keycode	number	键码，可选 KEYCODE 枚举类型（见 KEYCODE）
      action	number	按键动作，可选 ACTION 枚举类型（见 ACTION）

• 返回值
  类型：Promise<void> 分别返回发送「成功/失败」的状态

sendMouseMessage #

发送鼠标事件

• 类型

  (mouseMessage: { button?: number; action: number; wheel?: number; x: number; y: number;}) => void
  

• 参数

  • mouseMessage
    类型：{ button?: number | undefined; action: number; wheel?: number | undefined; x: number; y: number; }
    入参格式JSON

    • 成员

      名称	类型	描述
      button	number | undefined	鼠标按键标示，MOUSE_BUTTON.LEFT、MOUSE_BUTTON.RIGHT、MOUSE_BUTTON.CENTER。action 为 DOWN、UP、MOVE 时有效 （见 MOUSE_BUTTON）
      action	number	鼠标动作，可选 ACTION.DOWN、ACTION.UP、ACTION.MOVE、ACTION.WHEEL（见 ACTION）
      wheel	number | undefined	滚轮值，action 为 WHEEL 时有效
      x	number	相对屏幕位置 x 轴 0.00000 - 1.00000
      y	number	相对屏幕位置 y 轴 0.00000 - 1.00000

setRemoteLocationMock #

设置远端位置信息
设置远端经纬度信息

• 类型

  (location: { latitude: number; longitude: number;}) => Promise<{ latitude: number; longitude: number; }>
  

• 参数

  • location
    类型：{ latitude: number; longitude: number; }

    • 成员

      名称	类型	描述
      latitude	number	纬度
      longitude	number	经度

• 返回值
  类型：Promise<{ latitude: number; longitude: number; }>

• 示例

  vePlayer.setRemoteLocationMock({
    latitude: 39.916527,
    longitude: 116.397128
  })
  

setLocationServiceMode #

设置远端请求位置信息的模式

• 类型

  (mode: number) => void
  

• 参数

  • mode
    类型：number
    0（自动模式，默认，需要在实例化 vePhoneSDK 时通过 enableLocationService 参数开启定位信息同步）
    1（手动模式，通过 setRemoteLocationMock 接口设置远端位置信息）

• 返回值
  void

setIdleTime #

设置保活时间
在应用中动态设置客户端切后台之后，云机应用服务的保活时间（如不设置，则使用默认保活时长300秒）

• 注意
  当客户端切后台时开始计时。如用户在设置的保活时间到达时未切回前台，服务端将断开应用连接。

• 类型

  (time: number) => Promise<void>
  

• 参数

  • aliveTime
    类型：number
    保活时长，单位秒

• 返回值
  类型：Promise<void> Promise

getIdleTime #

获取保活时间
在应用中动态设置客户端切后台之后，云机应用服务的保活时间（如不设置，则使用默认保活时长300秒）

• 注意
  当客户端切后台时开始计时。如用户在设置的保活时间到达时未切回前台，服务端将断开应用连接。

• 类型

  () => Promise<number>
  

• 返回值
  类型：Promise<number> Promise