JSDoc: Global

Methods

activateAudioPlayStream(option) → {boolean}

拉流是否接收音频数据,仅拉 UDP 流有效，必须在拉流后调用才有效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	播放流 ID
`is_active`	boolean	true 接收，false 不接收

Source:

ZegoLiveRoom.js, line 577

Returns:

true-成功，false-失败

Type: boolean

activateMediaSideInfo(option)

激活使用媒体次要信息功能

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex
`only_audio_publish`	boolean	true - 纯音频直播，不传输视频数据, false 音视频直播，传输视频数据
`media_info_type`	number	sei类型, 查看 ZEGOCONSTANTS.ZegoSeiMediaInfoType
`sei_send_type`	number	sei发送类型,查看 ZEGOCONSTANTS.ZegoSeiSendType

Source:

ZegoLiveRoom.js, line 546

activateVideoPlayStream(option) → {boolean}

拉流是否接收视频数据

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	播放流 ID
`is_active`	boolean	true 接收，false 不接收
`video_layer`	number	视频分层类型, -1 - 根据网络状态选择图层, 0 - 指定拉基本层（小分辨率）, 1 - 指定拉扩展层（大分辨率)

Source:

ZegoLiveRoom.js, line 592

Returns:

true-成功，false-失败

Type: boolean

audioPlayerCreateAudioPlayer()

创建音效播放器，使用AudioPlayer模块进行播放音效时，确保有先调用过audioPlayerCreateAudioPlayer

Source:

ZegoLiveRoom.js, line 2330

audioPlayerDestroyAudioPlayer()

销毁音效播放器

Source:

ZegoLiveRoom.js, line 2337

audioPlayerGetCurrentDuration(option) → {number}

获取音效的当前进度

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2466

Returns:

返回音效的当前进度, 失败返回 -1

Type: number

audioPlayerGetDuration(option) → {number}

获取音效的总时长

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2456

Returns:

返回音效的总时长, 失败返回 0

Type: number

audioPlayerPauseAll()

暂停全部音效

Source:

ZegoLiveRoom.js, line 2400

audioPlayerPauseEffect(option)

暂停播放音效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2365

audioPlayerPlayEffect(option)

播放音效。使用AudioPlayer模块进行播放音效时，确保有先调用过audioPlayerCreateAudioPlayer

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`path`	string	音效资源文件的本地路径
`sound_id`	number	音效 ID
`loop_count`	number	循环次数
`is_publish`	boolean	是否放入推流中

Source:

ZegoLiveRoom.js, line 2349

audioPlayerPreloadEffect(option)

预加载音效，只支持预加载不超过30秒的音频文件。预加载完成后，通过audioPlayerPlayEffect接口使用同个sound_id播放即可使用AudioPlayer模块时，确保有先调用过audioPlayerCreateAudioPlayer

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`path`	string	音效资源文件的本地路径
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2425

audioPlayerResumeAll()

恢复全部音效

Source:

ZegoLiveRoom.js, line 2407

audioPlayerResumeEffect(option)

恢复播放音效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2374

audioPlayerSeekTo(option) → {number}

设置进度

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID
`timestamp`	number	进度, 单位毫秒

Source:

ZegoLiveRoom.js, line 2446

Returns:

返回 -1 表示失败, 返回 0 表示成功

Type: number

audioPlayerSetVolume(option)

设置单个音效的音量

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID
`volume`	number	音量，有效范围 0 到 100，默认 100

Source:

ZegoLiveRoom.js, line 2384

audioPlayerSetVolumeAll(option)

设置所有音效的音量

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`volume`	number	音量，有效范围 0 到 100，默认 100

Source:

ZegoLiveRoom.js, line 2393

audioPlayerStopAll()

停止全部音效

Source:

ZegoLiveRoom.js, line 2414

audioPlayerStopEffect(option)

停止播放音效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2357

audioPlayerUnloadEffect(option)

删除预加载音效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 2434

checkScreenCaptureAuthority(option) → {boolean}

检测mac是否有屏幕捕捉的权限

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`handle`	number	窗口句柄，目标窗口句柄，从接口screenCaptureEnumWindowList 返回的对象数组列表中每项的handle字段

Source:

ZegoLiveRoom.js, line 2304

Returns:

是否拥有屏幕检测权限，若还未获取该权限则触发获取权限弹窗

Type: boolean

createCustomCaptureSource(option) → {number}

创建自定义采集源，在初始化sdk成功之后调用

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_type`	number	自定义采集源的类型，支持自定义图片、摄像头、视频文件、屏幕分享，查看定义 ZEGOCONSTANTS.ZegoCustomCaptureType

Source:

ZegoLiveRoom.js, line 2188

Returns:

-1 - 失败，结果大于0 返回自定义采集源句柄

Type: number

enableAEC(option)

回声消除开关，建议在推流前调用设置

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭

Source:

ZegoLiveRoom.js, line 841

enableAGC(option)

音频采集自动增益开关

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭

Source:

ZegoLiveRoom.js, line 851

enableANS(option)

音频采集噪声抑制开关

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭

Source:

ZegoLiveRoom.js, line 861

enableCamera(option)

是否使用摄像头

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true-开启， false-关闭
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 780

enableCaptureMirror(option)

是否开启本地摄像头镜像模式

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true-使用镜像， false-不使用镜像模式
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 792

enableCaptureStereo(option) → {boolean}

设置双声道采集，仅windows平台支持

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_type`	number	default is 0. 0:capture mono any time; 1: capture stereo any time;2: capture mono when voice chat(publish and play at the same time), capture stereo when only publish.PS: Do not do inner processing when capture stereo.

Source:

ZegoLiveRoom.js, line 1762

Returns:

true-设置成功，false-设置失败

Type: boolean

enableCheckPoc(option)

帧顺序检测开关

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 检测帧顺序，不支持B帧； false 不检测帧顺序，支持B帧，可能出现短暂花屏

Source:

ZegoLiveRoom.js, line 1043

enableCustomCapture(option)

开启自定义采集，必须在initSDK之前调用

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 2179

enableDTX(option)

是否开启离散音频包发送,确保在推流前调用，只有纯 UDP 方案才可以调用此接口

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，此时关闭麦克风后，不会发送静音包；false 关闭，此时关闭麦克风后会发送静音包

Source:

ZegoLiveRoom.js, line 1021

enableExternalRender(option)

视频外部自定义渲染开关

Parameters:

Name Type Description

option

object

对象参数

Properties

Name	Type	Description
`enable`	string	true - 使用外部自定义渲染，设置为true之后，在 onVideoData 事件回调里获取视频数据，false - 使用sdk渲染视频

Source:

ZegoLiveRoom.js, line 335

enableLoopback(option) → {boolean}

开启采集监听

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭

Source:

ZegoLiveRoom.js, line 872

Returns:

true 成功，false 失败

Type: boolean

enableMic(option) → {boolean}

开启麦克风

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 打开，false 关闭。麦克风默认是打开

Source:

ZegoLiveRoom.js, line 1735

Returns:

true - 成功， false - 失败

Type: boolean

enableMixSystemPlayout(option)

开启系统声卡声音采集

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`enable`	boolean	true - 开启， false - 关闭

Source:

ZegoLiveRoom.js, line 1524

enableSpeaker(option) → {boolean}

（声音输出）静音开关, 设置为关闭后，默认扬声器和耳机均无声音输出

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 不静音，false 静音。默认 true

Source:

ZegoLiveRoom.js, line 1348

Returns:

true 成功，false 失败

Type: boolean

enableTrafficControl(option)

是否开启流量控制,确保在推流前调用，在纯 UDP 方案才可以调用此接口

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`control_property`	number	流量控制属性 (帧率，分辨率）
`enable`	boolean	true 开启，false 关闭。默认开启

Source:

ZegoLiveRoom.js, line 1032

enableTransientNoiseSuppress(option) → {number}

音频采集的瞬态噪声抑制开关（消除键盘、敲桌子等瞬态噪声）

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭

Source:

ZegoLiveRoom.js, line 1124

Returns:

0 代表设置成功成功，否则设置失败

Type: number

enableVAD(option) → {boolean}

是否开启语音活动检测, 确保在推流前调用，只有纯 UDP 方案才可以调用此接口,在有音频的条件下检测到语音时才发送语音包，有效减少流量消耗降低成本

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	开启；false 关闭，默认关闭

Source:

ZegoLiveRoom.js, line 1744

Returns:

true - 成功， false - 失败

Type: boolean

getAudioDeviceList(option) → {object|array}

获取音频设备列表

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_type`	number	设备类型，查看ZEGOCONSTANTS.AudioDeviceType

Source:

ZegoLiveRoom.js, line 1483

Returns:

返回音频设备id和名字的对象列表

Type: object | array

getCaptureSoundLevel() → {float}

获取当前采集的音量

Source:

ZegoLiveRoom.js, line 1752

Returns:

当前采集音量大小

Type: float

getDefaultAudioDeviceId(option)

获取默认的音频设备

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_type`	number	设备类型，查看 ZEGOCONSTANTS.AudioDeviceType

string 设备id

Source:

ZegoLiveRoom.js, line 1692

getDefaultVideoDeviceId()

获取默认的摄像头设备

Source:

ZegoLiveRoom.js, line 1701

getElectronSDKVersion() → {string}

获取Electron SDK版本号，比如：2.0.0 从2.0.0 这个版本开始

Source:

ZegoLiveRoom.js, line 417

Returns:

Electron SDK

Type: string

getEngineVersion() → {string}

获取引擎版本信息

Source:

ZegoLiveRoom.js, line 408

Returns:

引擎版本信息

Type: string

getMaxPlayChannelCount() → {number}

获取 SDK 支持的最大同时播放流数

Source:

ZegoLiveRoom.js, line 1369

Returns:

最大支持播放流数

Type: number

getMicDeviceMute(option)

获取麦克风是否静音

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`device_id`	string	麦克风 deviceId

Source:

ZegoLiveRoom.js, line 1565

getMicDeviceVolume(option) → {number}

获取麦克风音量，切换麦克风后需要重新获取麦克风音量

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`device_id`	string	设备id

Source:

ZegoLiveRoom.js, line 1543

Returns:

-1: 获取失败，0~100 麦克风音量

Type: number

getSDKVersion() → {string}

获取sdk版本信息

Source:

ZegoLiveRoom.js, line 401

Returns:

sdk 版本信息

Type: string

getSpeakerDeviceMute(option) → {boolean}

获取扬声器是否静音

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId

Source:

ZegoLiveRoom.js, line 1640

Returns:

- true 静音，false 不静音

Type: boolean

getSpeakerDeviceVolume(option) → {number}

获取扬声器音量

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId

Source:

ZegoLiveRoom.js, line 1589

Returns:

- -1: 获取失败，0~100 麦克风音量

Type: number

getSpeakerSimpleMute(option) → {boolean}

获取 App 中扬声器是否静音，该接口只支持Windows平台，Mac下调用无效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId

Source:

ZegoLiveRoom.js, line 1666

Returns:

true - 静音，false 不静音

Type: boolean

getSpeakerSimpleVolume(option) → {number}

获取 App 中扬声器音量该接口只支持Windows平台，Mac下调用无效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId

Source:

ZegoLiveRoom.js, line 1615

Returns:

-1: 获取失败，0~100 扬声器音量

Type: number

getVideoDeviceList() → {object|array}

获取视频设备列表

Source:

ZegoLiveRoom.js, line 1504

Returns:

- 返回视频设备id和名字的对象列表

Type: object | array

initSDK(option, cb) → {boolean}

初始化sdk

Parameters:

Name Type Description

option

object

初始化对象参数

Properties

Name	Type	Description
`app_id`	string	app id ，需要向zego申请获取
`sign_key`	number \| Array	sign key , 需要向zego申请获取
`user_id`	string	唯一用户id
`user_name`	string	用户名

cb onInitSDK 初始化结果回调

Source:

ZegoLiveRoom.js, line 371

Returns:

返回true表示正在初始化，false初始化失败

Type: boolean

loginMultiRoom(option, cb) → {boolean}

登录第二套房间接口

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`room_id`	boolean	房间id
`role`	number	角色，取值查看 ZEGOCONSTANTS.ZegoRoomRole
`room_name`	string	房间名字

cb onLoginMultiRoom onLoginMultiRoom 登陆回调

Source:

ZegoLiveRoom.js, line 1464

Returns:

true - 正在异步登陆，false - 失败

Type: boolean

loginRoom(option, cb) → {boolean}

登录房间

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`room_id`	string	房间id
`room_name`	string	房间名字
`role`	number	角色，取值查看 ZEGOCONSTANTS.ZegoRoomRole

cb onLoginRoom 登录房间结果回调

Source:

ZegoLiveRoom.js, line 632

Returns:

true-正在异步登陆，false-失败

Type: boolean

logoutMultiRoom(cb) → {boolean}

退出第二套房间

Parameters:

Name	Type	Description
`cb`	OnLogoutMultiRoom	OnLogoutMultiRoom 退出第二套房间回调

Source:

ZegoLiveRoom.js, line 1472

Returns:

true - 正在异步退出，false - 失败

Type: boolean

logoutRoom(cb) → {boolean}

登出房间

Parameters:

Name	Type	Description
`cb`	onLogoutRoom	登出房间结果回调

Source:

ZegoLiveRoom.js, line 644

Returns:

true-正在异步退出，false-失败

Type: boolean

loseCanvasContext(option, cb)

释放webgl context 停止拉流后，如果不需要再使用该canvas，使用该接口进行释放webgl context 注意：此接口只能在停止拉流后使用，使用此接口释放canvas后，不能再次使用该canvas进行拉流和显示，除非通过restoreCanvasContext恢复成功后，才能再次调用拉流接口显示

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`canvas`	string	canvas

cb onLostContext function(lose_context){} 释放回调，lose_context - 释放上下文，成功不等于null，失败为null。需要再次使用该canvas时，通过lose_context 和接口restoreCanvasContext 来恢复上下文

Source:

ZegoLiveRoom.js, line 1274

mediaPlayerEnableRepeatMode(option)

设置是否循环播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true: 循环播放，false: 不循环播放
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1981

mediaPlayerGetAudioStreamCount(option) → {number}

获取音轨个数

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1969

Returns:

音轨个数

Type: number

mediaPlayerGetCurrentDuration(option) → {number}

获取当前播放的进度

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1870

Returns:

当前播放进度，单位毫秒

Type: number

mediaPlayerGetDuration(option) → {number}

获取整个文件的播放时长

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1858

Returns:

文件的播放时长，单位毫秒

Type: number

mediaPlayerInitWithType(option)

初始化播放器，如果不调用本函数进行初始化，mediaplayer将收不到回调通知事件

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`type`	number	媒体播放器类型, 0 - 本地播放模式，不会将音频混入推流中，只有调用端可以听到播放的声音，1 - 推流播放模式，会将音频混流推流中，调用端和拉流端都可以听到播放的。查看 ZEGOCONSTANTS.ZegoMediaPlayerType
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1772

mediaPlayerLoad(option)

预加载资源

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`path`	boolean	媒体文件的路径
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1895

mediaPlayerMuteLocal(option)

设置本地静默播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mute`	boolean	是否静默播放, 如果mediaPlayerInitWithType设置了 1 模式, 推出的流是有声音的
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1882

mediaPlayerPause(option)

暂停播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1822

mediaPlayerResume(option)

恢复播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1833

mediaPlayerSeekTo(option)

设置指定的进度进行播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`duration`	number	指定的进度，单位毫秒
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1845

mediaPlayerSetAudioStream(option)

设置播放文件的音轨

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_index`	boolean	音轨序号，可以通过 mediaPlayerGetAudioStreamCount 接口获取音轨个数
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1943

mediaPlayerSetPlayerType(option)

设置播放器类型

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`type`	boolean	媒体播放器类型, 0 - 本地播放模式，不会将音频混入推流中，只有调用端可以听到播放的声音，1 - 推流播放模式，会将音频混流推流中，调用端和拉流端都可以听到播放的。查看 ZEGOCONSTANTS.ZegoMediaPlayerType
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1956

mediaPlayerSetView(option)

设置显示视频的view

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`canvas_view`	boolean	要显示的canvas
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1908

mediaPlayerSetVolume(option)

设置音量

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`volume`	number	音量
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1784

mediaPlayerStart(option)

开始播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`path`	string	媒体文件的路径
`repeat`	number	是否重复播放
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1798

mediaPlayerStop(option)

停止播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`player_index`	number	播放器序号, 默认为0，多实例下用来区分哪个播放器,目前支持0，1，或者2

Source:

ZegoLiveRoom.js, line 1811

mixEnginePlayout(option) → {number}

把引擎播放的声音混到推流中

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 混到推流中，false 不混到推流中，默认为false

Source:

ZegoLiveRoom.js, line 1112

Returns:

0 代表设置成功成功，否则设置失败

Type: number

mixStreamEx(option) → {number}

混流接口，支持混流一路或者多路输出

Parameters:

Name Type Description

option

object

参数对象

Properties

Name Type Description

mix_stream_id string 混流任务id，标识唯一混流任务，调用方应该保证 mix_stream_id 的唯一性。如果 mix_stream_id 相同，服务端就认为是更新同一个混流。

output_fps number 混流输出帧率,值范围：[1,30]，根据网络情况设定值，帧率越高画面越流畅

output_width number 混流输出视频分辨率宽，不确定用什么分辨率时可采用16:9的规格设置，此值必须大于等于输入流列表中所有输入流中最大的分辨率宽，即right布局值，且输入流的布局位置不能超出此值规定的范围

output_height number 混流输出视频分辨率高，不确定用什么分辨率时可采用16:9的规格设置，此值大于等于输入流列表中所有输入流中最大的分辨率高，即bottom布局值，，且输入流的布局位置不能超出此值规定的范围

output_rate_control_mode number 混流输出码率控制模式，0 表示 CBR 恒定码率，1 表示 CRF 恒定质量，默认为 0；CRF 恒定质量表示保证视频的清晰度在固定水平上，因此若采用此控制模式，码率会根据网速的变化波动。；比如游戏类直播时，为了让观众看到比较流畅的操作类画面会使用恒定质量模式，提升视频质量

output_bitrate number 混流输出码率，输出码率控制模式设置为 CBR恒定码率时有效, 视频码率值范围： <= 10M，此参数单位是 bps，1M = 1 * 1000 * 1000 bps

output_quality number 混流输出质量，输出码率控制模式设置为 CRF恒定质量时有效，有效范围 0-51，默认值是 23；若想视频质量好点，在23的基础上降低质量值测试调整；若想文件大小小一点，在23的基础上升高质量值测试调整，以 x 值下的文件大小为例， x + 6 下的文件大小是 x 值下文件大小的一半，x - 6 下的文件大小是 x 值下文件大小的两倍

channels number 混流声道数，默认为单声道

output_audio_config number 混流输出音频格式，0--默认编码在低码率下，编码后的音质要明显好于 1--可选编码，在码率较大后，达到128kbps及以上，两种编码后的音质近乎相同；1--可选编码的优点在于低复杂性，能兼容更多的设备播放；但是目前经过 0--默认编码编码后的音频不能正常播放的情况很少

output_audio_bitrate number 混流输出音频码率，码率范围值是[10000, 192000]。若音频编码格式采用默认音频编码--output_audio_config 参数填0，采用 1/2声道时，建议码率值是 48k/64k，可根据需要在此基础上调整；若音频编码格式采用可选音频编码--output_audio_config 参数填1，采用 1/2声道时，建议码率值是 80k/128k，可根据需要在此基础上调整

output_background_color number 混流背景颜色，前三个字节为 RGB 颜色值，即 0xRRGGBBFF。如 0x0000FFFF 为黄色

output_background_image string 混流背景图，支持预设图片，如 (preset-id://zegobg.png) ，此值由zego提供，开发者先将背景图提供给zego，zego设置后再反馈背景图片的设置参数

with_sound_level boolean 是否开启音浪。true：开启，false：关闭。开启音浪后，拉混流时可以收到混流前的每条流的音量信息回调。

single_stream_pass_through boolean 混流输入为一条流时，混流输出的属性与单流一致(分辨率，编码格式等)，若需要开启此功能，请与即构技术支持联系

user_data string 用户自定义数据，接收端通过媒体次要信息onRecvMediaSideInfo 接口回调

extra number 扩展信息，备用

input_stream_list

object | array

混流输入流对象数组列表，SDK 根据输入流列表中的流进行混流，输入流信息对象的属性如下：

Properties

Name Type Description

stream_id string 流id

sound_level_id number 音浪id，用于标识用户，注意大小是32位无符号数，sound_level_id必须 >= 0 且 <= 4294967295L（即2^32-1）

content_control number 推流内容控制，0表示音视频都要，1表示只要音频，2表示只要视频。默认值：0

layout

object

流的布局对象，布局对象属性如下：

Properties

Name	Type	Description
`left`	number	左上角点x坐标
`top`	number	左上角点y坐标
`right`	number	右下角点x坐标
`bottom`	number	右下角点y坐标

output_stream_list

object | array

混流输出目标对象数组列表，目标输出流对象属性如下：

Properties

Name	Type	Description
`is_url`	boolean	true: target 为完整 RTMP URL，false: target 为流名
`target`	string	当is_url为true 时， target 为完整 RTMP URL，当is_url为false时，target 为混流流id ，拉混流时要通过该id进行拉混流

output_watermark

object

混流水印对象，水印对象属性如下：

Properties

Name Type Description

image string 水印图片，支持预设图片，如 (preset-id://zegowp.png) ，此值由zego提供，开发者先将图片提供给zego，zego设置后再反馈水印图片的设置参数

layout

object

混流水印布局，布局对象属性如下：

Properties

Name	Type	Description
`left`	number	左上角点x坐标
`top`	number	左上角点y坐标
`right`	number	右下角点x坐标
`bottom`	number	右下角点y坐标

Source:

ZegoLiveRoom.js, line 2053

Returns:

返回 seq ，如果seq > 0 表示调用成功，而且这个返回值会和 onMixStreamEx 的参数 seq 一一匹配。

Type: number

mixSysPlayoutWithProperty(option)

开启系统声卡声音采集，mac 上使用

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`enable`	boolean	true - 开启， false - 关闭
`properties`	number	0 - MIX_PROP_NONE, 1 - MIX_PROP_ENABLE_AGC_FOR_SYS_PLAYOUT

Source:

ZegoLiveRoom.js, line 1533

muteAudioPublish(option) → {number}

推流时是否发送音频数据

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`is_mute`	boolean	true 不发送，false 发送
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 1085

Returns:

0 代表设置成功成功，否则设置失败

Type: number

muteVideoPublish(option) → {number}

推流时是否发送视频数据,拉流端通过 onRemoteCameraStatusUpdate 回调监听此状态是否改变

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`is_mute`	boolean	true 不发送（仅预览），false 发送
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 1099

Returns:

0 代表设置成功成功，否则设置失败

Type: number

onEventHandler(event_name, cb) → {boolean}

注册事件监听

Parameters:

Name Type Description

event_name string 事件名称

cb

function

可以注册的事件有：

Properties

Name	Type	Description
`cb`	onAVKitEvent	SDK 引擎事件通知
`cb`	onPlayStateUpdate	拉流状态通知
`cb`	onPlayQualityUpdate	拉流质量更新事件通知
`cb`	onPublishStateUpdate	推流状态更新返回
`cb`	onStreamUpdated	流更新事件通知添加或者删除流的事件
`cb`	onPublishQualityUpdate	推流质量通知
`cb`	onUserUpdate	房间用户信息更新
`cb`	onUpdateOnlineCount	房间在线人数更新
`cb`	onSendRoomMessage	发送房间消息结果返回
`cb`	onRecvRoomMessage	收到房间消息通知
`cb`	onSendBigRoomMessage	发送大房间消息结果返回
`cb`	onRecvBigRoomMessage	收到大房间消息通知
`cb`	onCustomCommand	发送自定义消息结果返回
`cb`	onRecvCustomCommand	收到自定义消息通知
`cb`	onStreamExtraInfoUpdated	流额外信息更新通知
`cb`	onAudioDeviceStateChanged	音频设备状态更新通知
`cb`	onVideoDeviceStateChanged	视频设备状态更新通知
`cb`	onAudioVolumeChanged	音量变更事件通知
`cb`	onDeviceError	设备状态错误事件通知
`cb`	onRetryDevice	当前正在尝试使用的设备回调
`cb`	onKickOut	被挤掉线通知
`cb`	onDisconnect	已从房间断开连接
`cb`	onReconnect	与 server 重连成功通知
`cb`	onTempBroken	与 server 连接中断通知
`cb`	onAVEngineStart	音视频引擎启动时通知
`cb`	onAVEngineStop	音视频引擎停止时通知
`cb`	onRecvMediaSideInfo	收到媒体次要信息通知
`cb`	onMixStreamEx	混流结果回调通知
`cb`	onSoundLevelInMixedPlayStream	混流音浪回调通知，在回调中可以拿到混流中每条的音量大小信息
`cb`	onSoundLevelUpdate	拉流音浪回调通知，调用startSoundLevelMonitor后生效
`cb`	onCaptureSoundLevelUpdate	采集音浪回调通知，调用startSoundLevelMonitor后生效
`cb`	onVideoData	渲染前的视频数据回调
`cb`	onMediaPlayerPlayStart	MediaPlayer 开始播放通知，注意：所有mediaplayer事件的通知，播放前必须调用mediaPlayerInitWithType进行初始化播放器才会有回调
`cb`	onMediaPlayerPlayError	MediaPlayer 播放出错通知
`cb`	onMediaPlayerVideoBegin	MediaPlayer 视频开始播放通知
`cb`	onMediaPlayerAudioBegin	MediaPlayer 音频开始播放通知
`cb`	onMediaPlayerPlayEnd	MediaPlayer 播放结束通知
`cb`	onMediaPlayerSeekComplete	MediaPlayer 快进到指定时刻的回调
`cb`	onMediaPlayerPlayPause	MediaPlayer 暂停播放的回调
`cb`	onMediaPlayerPlayResume	MediaPlayer 恢复播放的回调
`cb`	onMediaPlayerPlayStop	MediaPlayer 主动停止播放的回调
`cb`	onMediaPlayerBufferBegin	MediaPlayer 开始缓冲通知
`cb`	onMediaPlayerBufferEnd	MediaPlayer 结束缓冲通知
`cb`	onMediaPlayerLoadComplete	MediaPlayer 调用 mediaPlayerLoad 接口加载完成的回调
`cb`	onAudioPlayerPlayEffect	AudioPlayer 调用 audioPlayerPlayEffect 的回调
`cb`	onAudioPlayerPlayEnd	AudioPlayer 音效播放结束的回调
`cb`	onAudioPlayerPreloadEffect	AudioPlayer 调用 audioPlayerPreloadEffect 预加载音效的回调
`cb`	onAudioPlayerPreloadComplete	AudioPlayer 预加载音效完成的回调
`cb`	onRemoteCameraStatusUpdate	远端摄像头状态通知
`cb`	onRemoteMicStatusUpdate	远端麦克风状态通知
`cb`	onRecvRemoteAudioFirstFrame	接收到远端音频的首帧通知
`cb`	onRecvRemoteVideoFirstFrame	接收到远端视频的首帧通知
`cb`	onRenderRemoteVideoFirstFrame	远端视频渲染首帧通知
`cb`	onMultiRoomStreamUpdated	第二套房间流更新事件通知
`cb`	onMultiRoomUserUpdate	第二套房间用户信息更新通知
`cb`	onMultiRoomUpdateOnlineCount	第二套房间在线人数更新通知
`cb`	onMultiRoomStreamExtraInfoUpdated	第二套房间流附加信息更新
`cb`	onMultiRoomDisconnect	第二套房间断开连接的通知
`cb`	onMultiRoomReconnect	第二套房间与 server 重连成功通知
`cb`	onMultiRoomTempBroken	第二套房间与 server 连接中断通知，SDK会尝试自动重连
`cb`	onSendMultiRoomMessage	第二套房间发送房间消息结果返回
`cb`	onRecvMultiRoomMessage	第二套房间收到房间消息通知
`cb`	onSendMultiRoomBigRoomMessage	第二套房间发送大房间消息结果返回通知
`cb`	onRecvMultiRoomBigRoomMessage	第二套房间收到大房间消息通知
`cb`	onSendMultiRoomCustomCommand	第二套发送自定义消息结果返回
`cb`	onRecvMultiRoomCustomCommand	第二套房间收到自定义消息
`cb`	onFrequencySpectrumUpdate	拉流的频域功率谱信息回调
`cb`	onCaptrueFrequencySpectrumUpdate	采集的频域功率谱信息回调
`cb`	onCaptureVideoFirstFrame	视频采集首帧回调
`cb`	onCaptureAudioFirstFrame	音频采集首帧回调

Source:

ZegoLiveRoom.js, line 322

Returns:

- 是否注册成功

Type: boolean

requireHardwareDecoder(option)

硬件解码,如果要打开，需要在拉流前设置,打开硬编硬解开关需后台可控，避免碰到版本升级或者硬件升级时出现硬编硬解失败的问题

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`required`	boolean	true 打开，false 关闭。默认 false

Source:

ZegoLiveRoom.js, line 1337

requireHardwareEncoder(option)

硬件编码开关,如果要打开，需要在推流前设置,打开硬编硬解开关需后台可控，避免碰到版本升级或者硬件升级时出现硬编硬解失败的问题

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`enable`	boolean	true 开启，false 关闭。默认 false

Source:

ZegoLiveRoom.js, line 902

restoreCanvasContext(option, cb)

恢复canvas的 webgl context，仅在使用loseCanvasContext后，还需要重新使用该canvas时才要调用本接口

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`canvas`	string	canvas
`lose_context`	string	通过restoreCanvasContext释放canvas成功后返回的释放上下文

cb onLostContext function(error_code){} 恢复回调，error_code， 0 - 成功，-1 - 失败

Source:

ZegoLiveRoom.js, line 1307

screenCaptureEnumScreenList() → {object|array}

枚举屏幕列表

Source:

ZegoLiveRoom.js, line 2285

Returns:

返回{is_primary, screen_name} 的对象数组列表

Type: object | array

screenCaptureEnumWindowList(option) → {object|array}

枚举窗口列表

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`is_include_iconic`	number	枚举时是否包括最小化的窗口。true - 表示包括最小化窗口；false - 不包括最小化窗口。

Source:

ZegoLiveRoom.js, line 2294

Returns:

返回{handle, title, image_path} 的对象数组列表, mac 下image_path 无效，返回空

Type: object | array

screenCaptureGetVirtualDesktopRect() → {object}

获取虚拟桌面的大小

Source:

ZegoLiveRoom.js, line 2323

Returns:

返回{left, top, width, height} 的对象

Type: object

screenCaptureGetWindowScreen(option) → {string}

获取窗口所在的屏幕

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`window_handle`	number	窗口句柄

Source:

ZegoLiveRoom.js, line 2316

Returns:

返回所在屏幕的name

Type: string

screenCaptureInit()

屏幕分享初始化

Source:

ZegoLiveRoom.js, line 2477

sendBigRoomMessage(option) → {number}

发送不可靠信道消息，主要用于大并发的场景，发送一些非必须到达的消息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`msg_type`	number	消息类型，查看 ZEGOCONSTANTS.ZegoMessageType
`msg_category`	number	消息分类，查看 ZEGOCONSTANTS.ZegoMessageCategory
`msg_content`	string	消息内容

Source:

ZegoLiveRoom.js, line 1408

Returns:

返回消息的seq

Type: number

sendCustomCommand(option)

发送自定义消息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`member_list`	object \| array	发送目标列表，数据格式为：[{user_id:'1', user_name:'1'},{user_id:'2', user_name:'3'}]
`msg_content`	string	消息内容

Source:

ZegoLiveRoom.js, line 1421

sendMediaSideInfo(option)

发送媒体次要信息，使用前先调用activateMediaSideInfo

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`side_info`	string	要发送的媒体次要信息
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 557

sendRoomMessage(option) → {number}

发送聊天室消息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`msg_type`	number	消息类型，查看 ZEGOCONSTANTS.ZegoMessageType
`msg_category`	number	消息分类，查看 ZEGOCONSTANTS.ZegoMessageCategory
`msg_content`	string	消息内容

Source:

ZegoLiveRoom.js, line 1393

Returns:

返回消息的seq

Type: number

setAudioBitrate(option)

设置音频比特率

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`bitrate`	number	比特率值

Source:

ZegoLiveRoom.js, line 947

setAudioChannelCount(option)

设置推流音频声道数,必须在推流前设置

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_count`	number	声道数，1 或 2，默认为 1（单声道）

Source:

ZegoLiveRoom.js, line 1011

setAudioDevice(option)

选择音频设备

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_type`	number	设备类型，查看ZEGOCONSTANTS.AudioDeviceType
`device_id`	string	设备id

Source:

ZegoLiveRoom.js, line 1494

setAudioDeviceMode(option)

设置音频设备模式，确保在 initSDK 前调用

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_mode`	number	模式，查看 ZEGOCONSTANTS.ZegoAVAPIAudioDeviceMode

Source:

ZegoLiveRoom.js, line 831

setAudioPrepCallback(option)

设置音频前处理函数, 必须在 InitSDK 后且在推流前调用

Parameters:

Name Type Description

option

objct

对象参数

Properties

Name	Type	Description
`call_back`	number	AVE::OnPrepCallback,音频前回调函数
`encode`	number	是否编码默认false, 输出 PCM 数据， true，输出AAC编码数据
`samplerate`	number	采样率，为0时，默认用SDK设置参数
`channel`	number	通道数，为0时，默认用SDK设置参数
`samples`	number	采样点数，为0时，默认用SDK设置参数

Source:

ZegoLiveRoom.js, line 2140

setAudioSrcForAuxiliaryPublishChannel(option)

选择辅助推流通道的音频来源

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`type`	number	辅助推流通道音频来源类别，查看 ZEGOCONSTANTS.ZegoAuxPublishChannelAudioSrcType

Source:

ZegoLiveRoom.js, line 501

Returns:

0 - 成功

setAudioVolumeNotify(option)

监听设备的音量变化，设置后如果有音量变化（包括 app 音量）通过 onAudioVolumeChanged 事件通知，支持windows，mac下无效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_type`	number	设备类型，查看 ZEGOCONSTANTS.AudioDeviceType
`device_id`	string	设备id

Source:

ZegoLiveRoom.js, line 1711

setAuxPlayVolume(volume)

设置混音本地播放音量

Parameters:

Name	Type	Description
`volume`		音量 0 ~ 200，默认为 100

Source:

ZegoLiveRoom.js, line 1154

setAuxPublishVolume(volume)

设置混音推流音量

Parameters:

Name	Type	Description
`volume`		音量 0 ~ 200，默认为 100

Source:

ZegoLiveRoom.js, line 1144

setAuxVolume(volume)

设置混音音量

Parameters:

Name	Type	Description
`volume`		音量值范围 0 ~ 200，默认为 100。

Source:

ZegoLiveRoom.js, line 1135

setCameraCaptureSourceParam(option) → {boolean}

配置摄像头源参数，可用于切换摄像头，更新摄像头设备id即可

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_src`	number	采集源，填写通过createCustomCaptureSource接口创建返回的摄像头源
`device_id`	string	摄像头设备id，可以通过getVideoDeviceList接口获取得到video_devices_list，取video_devices_list项中的device_id

Source:

ZegoLiveRoom.js, line 2219

Returns:

true - 成功， false - 失败，输入的源无效

Type: boolean

setCapturePipelineScaleMode(option)

设置视频采集缩放时机,初始化 SDK 后，startPreview 前调用。

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mode`	number	视频采集缩放时机 0 - 采集后立即进行缩放，默认，效果：当设置采集分辨率和编码分辨率不一致时，本地预览画面跟编码分辨率一致； 1 - 编码时进行缩放，效果：当设置采集分辨率和编码分辨率不一致时，本地预览画面跟采集分辨率一致，在编码时才进行缩放；

Source:

ZegoLiveRoom.js, line 1072

setCaptureVolume(option)

设置采集音量,SDK初始化成功后调用

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`volume`	number	volume 音量大小，取值（0, 100）。默认 100

Source:

ZegoLiveRoom.js, line 892

setCDNPublishTarget(option)

自定义直推CDN的地址

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`cdn_publish_target`	string	目的 rmtp 推流地址
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 999

setCustomCaptureSource(option) → {boolean}

设置当前采集源，需要在startPreview预览前调用

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_src`	number	采集源，填写通过createCustomCaptureSource 返回的采集源
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 2199

Returns:

true - 成功， false - 失败，输入的源无效

Type: boolean

setCustomPublishTarget(option)

自定义转推目的地

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`target_addr`	string	目的 rmtp 推流地址
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 985

setCustomToken(option)

设置自定义token信息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`third_party_token`	string	第三方传入的token 使用此函数验证登录时用户的合法性，登录房间前调用，token的生成规则请联系即构。若不需要验证用户合法性，不需要调用此函数在登录房间前调用有效，退出房间后失效

Source:

ZegoLiveRoom.js, line 619

setFrequencySpectrumMonitorCycle(timeInMS)

设置获取频域功率谱的监控周期

Parameters:

Name	Type	Description
`timeInMS`		时间间隔，最小值为10ms,默认为500ms

Source:

ZegoLiveRoom.js, line 2154

Returns:

true 成功；false 失败

setGeneralConfig(option)

设置配置信息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`config`	string	配置信息配置项的写法，例如 "keep_audio_session_active=true", 等号后面值的类型要看下面每一项的定义 "prefer_play_ultra_source", int value, 确保在 InitSDK 前调用，但开启拉流加速(config为“prefer_play_ultra_source=1”)可在 InitSDK 之后，拉流之前调用 "camera_orientation_mode", string value: auto/hardcode/0/90/180/270. for Android, Windows。 "alsa_capture_device_name" string value: plughw:[card_id],[device_id], eg: plughw:1,0, default is plug:default. view the device list with arecord. for Linux。 "alsa_playback_device_name" string value: plughw:[card_id],[device_id], eg: plughw:1,0, default is plug:default. view the device list with aplay. for Linux。

Source:

ZegoLiveRoom.js, line 962

setImageCaptureSourceParam(option) → {boolean}

配置图像源参数，可用于切换图片，更新图片路径即可

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_src`	number	采集源，填写通过createCustomCaptureSource接口创建返回的图像源
`image_path`	string	图像路径，图像支持bmp图像

Source:

ZegoLiveRoom.js, line 2209

Returns:

true - 成功， false - 失败，输入的源无效

Type: boolean

setLatencyMode(option)

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mode`	number	延时模式,取值查看 ZEGOCONSTANTS.ZegoAVAPILatencyMode 0 - 普通延迟模式； 1 - 低延迟模式，无法用于 RTMP 流； 2 - 普通延迟模式，最高码率可达 192K； 3 - 低延迟模式，无法用于 RTMP 流。相对于 ZEGO_LATENCY_MODE_LOW 而言，CPU 开销稍低； 4 - 低延迟模式，无法用于 RTMP 流。支持WebRTC必须使用此模式； 5 - 普通延迟模式，使用此模式前先咨询即构技术支持；

Source:

ZegoLiveRoom.js, line 1059

setLogDir(option) → {boolean}

设置日志存储路径

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`log_dir`	string	配置sdk日志存储路径
`log_level`	number	配置sdk日志等级， 3 - 通常在发布产品中使用， 4 - 调试阶段使用

Source:

ZegoLiveRoom.js, line 449

Returns:

设置结果是否成功

Type: boolean

setLogSize(option)

配置日志最大文件大小

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`log_size`	number	日志文件最大大小值

Source:

ZegoLiveRoom.js, line 460

setLoopbackVolume(option)

设置监听音量,推流时可调用本 API 进行参数配置

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`volume`	number	音量大小，取值（0, 100）。默认 100

Source:

ZegoLiveRoom.js, line 882

setMicDeviceMute(option)

设置麦克风静音

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`device_id`	string	麦克风 deviceId
`is_mute`	boolean	true 静音，false 不静音

Source:

ZegoLiveRoom.js, line 1576

setMicDeviceVolume(option)

设置麦克风音量

Parameters:

Name Type Description

option

object

参数对像

Properties

Name	Type	Description
`device_id`	string	麦克风 deviceId
`volume`	number	音量，取值(0,100)

Source:

ZegoLiveRoom.js, line 1554

setMultiRoomConfig(option)

设置第二套房间配置信息,在登录房间前调用有效，退出房间后失效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`audience_create_room`	boolean	观众是否可以创建房间
`user_state_update`	object	用户状态（用户进入、退出房间）是否广播。true 广播，false 不广播。默认 false

Source:

ZegoLiveRoom.js, line 1435

setMultiRoomCustomToken(option)

设置第二套房间自定义token信息，使用此函数验证登录时用户的合法性，登录房间前调用，token的生成规则请联系即构。若不需要验证用户合法性，不需要调用此函数在登录房间前调用有效，退出房间后失效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`third_part_token`	string	第三方传入的token

Source:

ZegoLiveRoom.js, line 1444

setMultiRoomMaxUserCount(option)

设置第二套房间最大在线人数,在登录房间前调用有效，退出房间后失效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`max_count`	number	最大人数

Source:

ZegoLiveRoom.js, line 1452

setPlayQualityMonitorCycle(option) → {boolean}

设置拉流质量监控周期

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`cycle_ms`	number	时间周期，单位为毫秒，取值范围为(500, 60000)。默认为 3000

Source:

ZegoLiveRoom.js, line 1378

Returns:

true 成功，false 失败

Type: boolean

setPlayVolume(option)

设置播放音量

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`volume`	number	音量取值范围为(0, 200)，数值越大，音量越大。默认 100
`stream_id`	string	流id

Source:

ZegoLiveRoom.js, line 1359

setPreviewView(option) → {boolean}

设置本地摄像头预览目标

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`canvas_view`	object	预览的canvas标签对象，例如：document.getElementById("localVideo")
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 656

Returns:

true-成功，false-失败

Type: boolean

setPreviewViewBackgroundColor(option)

设置推流端预览控件的背景颜色,在调用setPreviewView 之前调用才会生效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`color`	number	颜色，取值为0xFFRRGGBB
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 681

setPreviewViewMode(option)

设置预览视频渲染模式

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mode`	0 \| 1 \| 2	0 为等比缩放，不足部分会有黑边；1 为等比缩放填充整个 view；多余部分会被裁剪；2 为完全填充整个 view，不会多余和裁剪

Source:

ZegoLiveRoom.js, line 1993

setPublishStreamExtraInfo(option)

设置或更新推流的附加信息,更新流附加信息成功后，同一房间内的其他人会收到 onStreamExtraInfoUpdated 通知

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`extra_info`	string	流附加信息
`channel_index`	number	推流 channel Index, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 973

setQualityCallbackInterval(interval)

设置网络测速时回调质量的时间间隔

Parameters:

Name	Type	Description
`interval`		测速时回调质量的时间间隔单位ms

Source:

ZegoLiveRoom.js, line 2547

setRoomConfig(option)

设置房间配置信息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`audience_create_room`	bool	观众是否可以创建房间。true 可以，false 不可以。默认 true
`user_state_update`	bool	用户状态（用户进入、退出房间）是否广播。true 广播，false 不广播。默认 false 在登录房间前调用有效，退出房间后失效

Source:

ZegoLiveRoom.js, line 607

setScreenCaptureSourceParam(option)

设置屏幕分享源的参数

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_src`	number	屏幕采集源，填写通过createCustomCaptureSource接口创建返回的屏幕采集源
`full_screen`	boolean	设置采集主屏幕全屏，true - 采集全屏
`virtual_full_screen`	boolean	设置采集虚拟桌面全屏，true - 采集虚拟全屏。在full_screen为false时有效
`cursor_visible`	boolean	是否显示光标，true - 显示，false - 不显示
`click_animation`	boolean	是否显示鼠标点击动画，true - 显示鼠标点击动画, false - 不显示鼠标点击动画
`activate_window_when_capturing`	boolean	在目标窗口模式下，初次选择窗口时，设置是否激活窗口，true - 激活窗口，false - 不激活窗口
`target_screen`	string	设置采集目标屏幕名，从接口screenCaptureEnumScreenList 返回的对象数组列表中每项的screen_name字段
`target_window`	number	设置采集目标窗口句柄，从接口screenCaptureEnumWindowList 返回的对象数组列表中每项的handle字段
`target_window_model`	number	1 - 窗口截屏，带窗口标题栏， 2 - 窗口客户区截屏，不带窗口标题栏，仅windows 支持
`target_rect_left`	number	设置采集目标区域，单位为像素，支持高DPI，目标区域左上角横坐标
`target_rect_top`	number	目标区域左上角纵坐标
`target_rect_width`	number	目标区域宽
`target_rect_height`	number	目标区域高

Source:

ZegoLiveRoom.js, line 2253

setSoundLevelMonitorCycle(option)

设置是否循环播放

Parameters:

Name Type Description

option

object

设置 soundLevel 的监控周期

Properties

Name	Type	Description
`time_ms`	boolean	时间周期，单位为毫秒，取值范围 [100, 3000], 默认 200 ms

Source:

ZegoLiveRoom.js, line 2127

setSpeakerDeviceMute(option)

设置扬声器静音

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId
`is_mute`	boolean	静音，false 不静音

Source:

ZegoLiveRoom.js, line 1652

setSpeakerDeviceVolume(option)

设置扬声器音量

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId
`volume`	number	音量，取值 (0，100)

Source:

ZegoLiveRoom.js, line 1601

setSpeakerSimpleMute(option)

设置 App 中扬声器静音，该接口只支持Windows平台，Mac下调用无效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	扬声器 deviceId
`is_mute`	boolean	true 静音，false 不静音

Source:

ZegoLiveRoom.js, line 1679

setSpeakerSimpleVolume()

设置 App 中扬声器音量，该接口只支持Windows平台，Mac下调用无效

Parameters:

Name	Type	Description
`option.device_id`	string	扬声器 deviceId
`option.volume`	number	音量，取值 (0，100)

Source:

ZegoLiveRoom.js, line 1627

setUseEnv(option)

配置sdk环境，测试环境、正式环境

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`use_test_env`	boolean	是否使用测试环境
`use_alpha_env`	boolean	是否使用alpha环境

Source:

ZegoLiveRoom.js, line 427

setUser(option) → {boolean}

设置用户信息

Parameters:

Name Type Description

option

objct

对象参数

Properties

Name	Type	Description
`user_id`	number	用户唯一 ID，业务上要保证appid下唯一，否则同个用户登陆另外一个用户会onKickOut被踢出
`user_name`	number	用户名字

Source:

ZegoLiveRoom.js, line 354

Returns:

- true - 成功，false - 失败

Type: boolean

setVerbose(option)

设置是否打印SDK控制台信息

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`is_verbose`	boolean	true - 打印， false - 不打印

Source:

ZegoLiveRoom.js, line 438

setVideoBitrate(option)

设置视频带宽比特率

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`bitrate`	number	比特率
`channel_index`	number	通道索引 , 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 913

setVideoCaptureResolution(option)

设置摄像头采集分辨率

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`width`	number	宽
`height`	number	高
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 819

setVideoCodecId(option) → {boolean}

设置选用分层编码

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`codec_id`	string	1为开启，0为关闭
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 567

Returns:

true-成功，false-失败

Type: boolean

setVideoDevice(option)

设置选用视频设备

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_id`	string	设备id
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 1513

setVideoEncodeResolution(option)

设置视频编码分辨率

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`width`	number	宽
`height`	number	高
`channel_index`	number	通道索引, 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 935

setVideoFileCaptureSourceParam(option) → {boolean}

配置视频文件源参数，可用于切换视频文件，更新视频文件路径即可，视频文件路径传入空字符串，可停止当前播放。

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`capture_src`	number	采集源，填写通过createCustomCaptureSource接口创建返回的视频文件源
`video_file_path`	string	视频文件路径
`is_repeat`	boolean	是否重复播放，true - 播放完从头开始重复播放，false - 播放完则停止
`media_player_type`	number	媒体播放器的类型，当调用startPublishing 推流时，0 - 本地播放模式，不会将音频混入推流中，只有调用端可以听到播放的声音，1 - 推流播放模式，会将音频混流推流中，调用端和拉流端都可以听到播放的。
`media_player_index`	number	媒体播放器的索引，sdk内部支持多路播放器同时播放，最多支持4路媒体文件同时播放

Source:

ZegoLiveRoom.js, line 2232

Returns:

true - 成功， false - 失败，输入的源无效

Type: boolean

setVideoFilterFactory(option)

设置外部滤镜

Parameters:

Name Type Description

option

objct

对象参数

Properties

Name	Type	Description
`factory`	number	在initsdk之前调用用户需要自己编写外部滤镜扩展

Source:

ZegoLiveRoom.js, line 344

setVideoFPS(option)

设置视频帧率

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`fps`	number	帧率
`channel_index`	number	通道索引 , 查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 922

setVideoMirrorMode(option)

是否启用预览和推流镜像

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mode`	boolean	镜像模式， 0 - 预览启用镜像，推流不启用镜像；1 - 预览启用镜像，推流启用镜像；2 - 预览不启用镜像，推流不启用镜像；3 - 预览不启用镜像，推流启用镜像；
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 805

setViewBackgroundColor(option)

设置拉流播放控件的背景颜色,在startPlayingStream接口前调用才会生效

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`color`	number	颜色，取值为0xFFRRGGBB
`stream_id`	string	拉流的流id

Source:

ZegoLiveRoom.js, line 702

setViewMode(option)

设置拉流视频渲染模式

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`mode`	0 \| 1 \| 2	0 为等比缩放，不足部分会有黑边；1 为等比缩放填充整个 view；多余部分会被裁剪；2 为完全填充整个 view，不会多余和裁剪
`stream_id`	string	流id

Source:

ZegoLiveRoom.js, line 2004

startConnectivityTest()

启动连通性测试 InitSDK 后调用同一时间内与StartSpeedTest只有一个生效推拉流会中断此操作此接口仅仅只会检测与zego服务的连通性，不会产生媒体数据

Source:

ZegoLiveRoom.js, line 2513

startDownlinkSpeedTest(bitrate)

开始下行网络测速 InitSDK 后调用同一时间内与StartConnectivityTest只有一个生效，启动推拉流会中断此操作不建议长时间测速，可能会影响推拉流体验

Parameters:

Name	Type	Description
`bitrate`		测速推流时的比特率单位bps

Source:

ZegoLiveRoom.js, line 2569

startFrequencySpectrumMonitor()

启动频域功率谱监听

Source:

ZegoLiveRoom.js, line 2162

Returns:

true 成功；false 失败

startNetworkTrace(traceroute)

开启网络模块测试

Parameters:

Name	Type	Description
`traceroute`		参见NetworkTraceConfig

Source:

ZegoLiveRoom.js, line 2495

startPlayingStream(option)

拉流播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	流id
`canvas_view`	string	要显示的 canvas 对象
`params`	string	拉流参数，要与推流参数一致

Source:

ZegoLiveRoom.js, line 1169

startPlayingStream2(option)

拉流播放

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	流id
`canvas_view`	string	要显示的 canvas 对象
`urls`	string \| array	rtmp flv播放地址数组列表，尝试播放第一个地址，播放失败会按顺序往下播放
`params`	string	拉流参数，要与推流参数一致
`should_switch_server`	boolean	连麦时是否切换服务器

Source:

ZegoLiveRoom.js, line 1208

startPreview(option) → {boolean}

开始预览

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 721

Returns:

true-成功，false-失败

Type: boolean

startPublishing(option) → {boolean}

开始推流

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`title`	string	推流标题
`stream_id`	string	推流流id
`publish_flag`	number	推流flag，查看 ZEGOCONSTANTS.ZegoPublishFlag
`params`	string	推流附带参数
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex
`media_player_index`	number	多实例mediaplayer下，需要推流哪个实例的播放器

Source:

ZegoLiveRoom.js, line 749

Returns:

true - 开始异步推流， false - 失败

Type: boolean

startRecord(option) → {boolean}

开始录制

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel`	number	录制通道, 0 - 第一路媒体录制通道, 1 - 第二路媒体录制通道
`record_type`	number	录制类型, 查看 ZEGOCONSTANTS.ZegoMediaRecordType
`storage_path`	string	录制文件存储路径
`enable_status_callback`	boolean	是否开启录制状态回调，true - 表示会以指定的interval间隔回调onRecordStatusUpdate, false - 表示不回调
`interval`	number	录制信息更新频率，单位毫秒，有效范围：1000-10000，默认值3000
`record_format`	number	录制格式, 1 - flv, 2 - mp4
`is_fragment`	boolean	录制文件是否分片，MP4格式才有效

Source:

ZegoLiveRoom.js, line 517

Returns:

true 开始异步录制，通过onMediaRecord回调获取是否录制成功， false 失败

Type: boolean

startSoundLevelMonitor(true)

启动 soundLevel 监听

Parameters:

Name	Type	Description
`true`	boolean	成功， false - 失败

Source:

ZegoLiveRoom.js, line 2110

startUplinkSpeedTest(bitrate)

开始网络测速 InitSDK 后调用同一时间内与StartConnectivityTest只有一个生效，启动推拉流会中断此操作不建议长时间测速，可能会影响推拉流体验

Parameters:

Name	Type	Description
`bitrate`		测速推流时的比特率单位bps

Source:

ZegoLiveRoom.js, line 2535

stopAudioVolumeNotify(option)

停止监听设备的音量变化

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`device_type`	number	设备类型，查看 ZEGOCONSTANTS.AudioDeviceType
`device_id`	string	设备id

Source:

ZegoLiveRoom.js, line 1723

stopConnectivityTest()

停止连通性测试

Source:

ZegoLiveRoom.js, line 2523

stopFrequencySpectrumMonitor()

停止频域功率谱监听

Source:

ZegoLiveRoom.js, line 2170

Returns:

true 成功；false 失败

stopNetworkTrace()

停止网络模块测试

Source:

ZegoLiveRoom.js, line 2503

stopPlayingStream(option)

停止拉流

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	流id

Source:

ZegoLiveRoom.js, line 1250

stopPreview(option) → {boolean}

停止预览

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	摄像头通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 730

Returns:

true-成功， false-失败

Type: boolean

stopPublishing(option)

停止推流

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`msg`	string	停止推流额外信息
`channel_index`	number	推流通道，查看 ZEGOCONSTANTS.PublishChannelIndex

Source:

ZegoLiveRoom.js, line 768

stopRecord(option)

停止录制

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	录制通道, 0 - 第一路媒体录制通道, 1 - 第二路媒体录制通道

Source:

ZegoLiveRoom.js, line 534

stopSoundLevelMonitor(true)

停止 soundLevel 监听

Parameters:

Name	Type	Description
`true`	boolean	成功， false - 失败

Source:

ZegoLiveRoom.js, line 2118

takeSnapshot(option, cb)

拉流截图

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`stream_id`	string	流id

cb onTakeSnapshot 拉流截图回调

Source:

ZegoLiveRoom.js, line 491

takeSnapshotPreview(option, cb)

本地预览截图

Parameters:

Name Type Description

option

object

参数对象

Properties

Name	Type	Description
`channel_index`	number	通道索引，查看 ZEGOCONSTANTS.PublishChannelIndex

cb onTakeSnapshotPreview 本地预览截图回调

Source:

ZegoLiveRoom.js, line 482

unInitSDK()

反初始化sdk

Source:

ZegoLiveRoom.js, line 394

uploadLog()

上传sdk日志

Source:

ZegoLiveRoom.js, line 468

windowThumbnailEnumWindowlist(cb)

枚举缩略图的窗口列表

Parameters:

Name	Type	Description
`cb`	object \| array	缩略图回调，返回thumb_windows_list（），是 {id, handle,title,isScreen,iconBit,imageBit} 的对象数组列表, iconBit,imageBit是{width,height,format,len,image_data}的对象 iconBit ：缩略图标数据， imageBit : 缩略图数据 image_data 是 png图像的base64字符串；设置如下标签属性即可显示图像：img.setAttribute('src', "data:image/png;base64," + rs.image_data)

Source:

ZegoLiveRoom.js, line 2487

Type Definitions

onAudioDeviceStateChanged(result)

音频设备状态更新通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`device_type`	number	0-输入设备，1-输出设备
`device_state`	number	0-添加设备，1-删除设备
`device_id`	string	设备id
`device_name`	string	设备名字

Source:

ZegoLiveRoom.js, line 2978

onAudioPlayerPlayEffect(result)

播放音效的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	string	0 成功，-1 失败
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 3281

onAudioPlayerPlayEnd(result)

播放音效完成的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	string	0 成功，-1 失败
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 3290

onAudioPlayerPreloadComplete(result)

预加载音效完成的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 3308

onAudioPlayerPreloadEffect(result)

预加载音效的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`sound_id`	number	音效 ID

Source:

ZegoLiveRoom.js, line 3300

onAudioVolumeChanged(result)

音量变更事件通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`device_type`	number	0-输入设备，1-输出设备
`device_id`	string	设备id
`volume_type`	number	音量类型，0-设备音量，1-App音量
`volume`	number	音量值
`is_mute`	boolean	是否静音，true-静音，false-非静音

Source:

ZegoLiveRoom.js, line 2997

onAVEngineStart()

音视频引擎启动时回调

Source:

ZegoLiveRoom.js, line 3096

onAVEngineStop()

音视频引擎停止时回调

Source:

ZegoLiveRoom.js, line 3091

onAVKitEvent(result)

SDK 引擎事件通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

event_code number 事件码，1-开始重试拉流，2-重试拉流成功，3-开始重试推流，4-重试推流成功，5-拉流临时中断，6-推流临时中断，7-拉流卡顿(视频)。

event_info

object | array

事件信息对象数组，事件信息对象属性如下：

Properties

Name	Type	Description
`event_key`	string	事件名称
`event_value`	string	事件值

Source:

ZegoLiveRoom.js, line 2640

onCaptrueFrequencySpectrumUpdate(result)

采集的频域功率谱信息的回调。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	number	流id
`spectrum_list`	objct \| array	频域功率谱信息数组

Source:

ZegoLiveRoom.js, line 3375

onCaptureAudioFirstFrame()

音频采集首帧回调

Source:

ZegoLiveRoom.js, line 3389

onCaptureSoundLevelUpdate(result)

获取 captureSoundLevel 更新的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`sound_level`	number	房间内采集 soundLevel 值（自己推的流）

Source:

ZegoLiveRoom.js, line 3271

onCaptureVideoFirstFrame()

视频采集首帧回调

Source:

ZegoLiveRoom.js, line 3384

onConnectResult(result)

网络测速模块连通回调探测连接和测速都会回调此值

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码 0 成功操作
`net_connectcost`	number

Source:

ZegoLiveRoom.js, line 3422

onCustomCommand(result)

发送自定义消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	字符串
`request_seq`	number	序号

Source:

ZegoLiveRoom.js, line 2912

onDeviceError(result)

设备状态错误事件通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码, -1 - 一般性错误, -2 - 无效设备 ID, -3 - 没有权限, -4 - 采集帧率为0, -5 - 设备被占用, -6 - 设备未插入, -7 - 需要重启系统, -8 - 媒体服务无法恢复
`device_name`	string	设备名字，值为"camera"、"microphone"或者"speaker"

Source:

ZegoLiveRoom.js, line 3009

onDisconnect(result)

已从房间断开连接的通知，建议开发者在此通知中进行重新登录、推/拉流、报错、友好性提示等其他恢复逻辑。与 server 断开连接后，SDK 会进行重试，重试失败抛出此错误。请注意，此时 SDK 与服务器的所有连接均会断开。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3043

onFrequencySpectrumUpdate(result)

拉流的频域功率谱信息的回调。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

spectrum_info_list

objct | array

房间内所有流（非自己推的流）的频域功率谱信息

Properties

Name	Type	Description
`stream_id`	number	流id
`spectrum_list`	objct \| array	频域功率谱信息数组

Source:

ZegoLiveRoom.js, line 3365

onInitSDK(result)

初始化sdk回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码,0-成功，其它值，查看官网错误码列表

Source:

ZegoLiveRoom.js, line 2589

onKickOut(result)

被踢掉线通知，可在该回调中处理用户被踢出房间后的下一步处理（例如报错、重新登录提示等）

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`reason`	number	被踢出原因，查看官网错误码列表
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3027

onKickOutMultiRoom(result)

第二套房间被踢掉线通知，可在该回调中处理用户被踢出房间后的下一步处理（例如报错、重新登录提示等）

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`reason`	number	被踢出原因，查看官网错误码列表
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3035

onLoginMultiRoom(result)

登陆第二套房间返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

error_code number 错误码，0-成功，其它值，查看官网错误码列表

room_id string 房间id

stream_count number 房间媒体流的数量

stream_list

string

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`stream_id`	string	流id
`user_name`	string	用户名
`user_id`	string	用户id
`extra_info`	string	流额外信息

Source:

ZegoLiveRoom.js, line 2610

onLoginRoom(result)

登陆房间返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

error_code number 错误码，0-成功，其它值，查看官网错误码列表

room_id string 房间id

stream_count number 房间媒体流的数量

stream_list

string

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`stream_id`	string	流id
`user_name`	string	用户名
`user_id`	string	用户id
`extra_info`	string	流额外信息

Source:

ZegoLiveRoom.js, line 2596

onLogoutMultiRoom(result)

退出第二套房间返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码,0-成功
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 2624

onLogoutRoom(result)

登出房间返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码,0-成功
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 2632

onMediaPlayerAudioBegin(result)

MediaPlayer 音频开始播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3152

onMediaPlayerBufferBegin(result)

MediaPlayer 开始缓冲

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3197

onMediaPlayerBufferEnd(result)

MediaPlayer 结束缓冲

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3204

onMediaPlayerLoadComplete(result)

MediaPlayer 调用 mediaPlayerLoad 接口加载完成的回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3211

onMediaPlayerMediaSideInfo(sei_data, data_len, index)

媒体播放器sei信息回调

Parameters:

Name	Type	Description
`sei_data`	number	sei信息
`data_len`	number	sei信息长度
`index`	number	媒体播放器索引

Source:

ZegoLiveRoom.js, line 3449

onMediaPlayerPlayEnd(result)

MediaPlayer 播放结束

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3160

onMediaPlayerPlayError(result)

MediaPlayer播放出错

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引
`error_code`	number	0 - 没有错误， -1 - 文件格式不支持，-2 - 路径不存在，-3 - 文件无法解码， -4 - 文件中没有可播放的音视频流，-5 - 文件解析过程中出现错误

Source:

ZegoLiveRoom.js, line 3136

onMediaPlayerPlayPause(result)

MediaPlayer 暂停播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3176

onMediaPlayerPlayResume(result)

MediaPlayer 恢复播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3183

onMediaPlayerPlayStart(result)

MediaPlayer开始播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3129

onMediaPlayerPlayStop(result)

MediaPlayer 主动停止播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3190

onMediaPlayerSeekComplete(result)

MediaPlayer 快进到指定时刻

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引
`state`	number	状态 >=0 成功，其它表示失败
`duration`	number	实际快进的进度，单位毫秒

Source:

ZegoLiveRoom.js, line 3167

onMediaPlayerVideoBegin(result)

MediaPlayer 视频开始播放

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`player_index`	number	播放器索引

Source:

ZegoLiveRoom.js, line 3145

onMixStreamEx(result)

混流回调接口

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

error_code number 混流结果， 0 - 成功

seq number 请求 seq，与mixStreamEx返回的结果一致，关联标识是哪次发起的混流任务的回调

mix_stream_id string 混流任务id，标识唯一混流任务

non_exists_stream_list

object | array

不存在的输入流信息对象数组列表，流信息对象属性如下：

Properties

Name	Type	Description
`stream_id`	string	不存在的流的流id

output_stream_info_list

object | array

混流输出对象数组列表，输出对象属性如下：

Properties

Name	Type	Description
`stream_id`	string	混流的流id
`mix_stream_id`	string	混流任务id，标识一个混流任务
`rtmp_url_list`	string \| array	RTMP 播放 URL 数组列表
`flv_url_list`	string \| array	flv 播放 URL 数组列表
`hls_url_list`	string \| array	hls 播放 URL 数组列表

Source:

ZegoLiveRoom.js, line 3218

onMultiRoomDisconnect(result)

第二套房间断开连接的通知，建议开发者在此通知中进行重新登录、推/拉流、报错、友好性提示等其他恢复逻辑。与 server 断开连接后，SDK 会进行重试，重试失败抛出此错误。请注意，此时 SDK 与服务器的所有连接均会断开。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3051

onMultiRoomReconnect(result)

第二套房间与 server 重连成功通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3067

onMultiRoomStreamExtraInfoUpdated(result)

第二套房间流附加信息更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

stream_count number 流数量

stream_list

object | array

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`stream_id`	string	流id
`extra_info`	string	extra_info信息

Source:

ZegoLiveRoom.js, line 2964

onMultiRoomStreamUpdated(result)

第二套房间流更新事件通知，房间内增加流、删除流，均会触发此更新。主播推流，自己不会收到此回调，房间内其他成员会收到。建议对流增加和流删除分别采取不同的处理。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

stream_update_type number 2001-新增流，2002-删除流

stream_count number 流数量

stream_list

object | array

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`stream_id`	string	流id
`extra_info`	string	流额外信息

Source:

ZegoLiveRoom.js, line 2747

onMultiRoomTempBroken(result)

第二套房间与 server 连接中断通知，SDK会尝试自动重连

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3083

onMultiRoomUpdateOnlineCount(result)

第二套房间在线人数更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`room_id`	string	房间id
`online_count`	number	在线人数

Source:

ZegoLiveRoom.js, line 2794

onMultiRoomUserUpdate(result)

第二套房间用户信息更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

update_type number 更新类型，1-全量更新，2-增量更新

users

object | array

用户信息对象数组，用户信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`update_flag`	number	更新属性，1-新增，2-删除
`role`	number	成员角色，1-主播，2-观众

Source:

ZegoLiveRoom.js, line 2774

OnNetworkTrace(result, tcpResult, udpResult, tracerouteResult)

网络模块测试回调值

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

httpResult

object

htttp测试结果对象

Properties

Name	Type	Description
`code`	number	探测是否成功。0成功非0失败
`request_ms`	number	探测消耗时间单位ms

tcpResult object tcp测试结果对象

result.tcpResult.code number 探测是否成功。0成功非0失败

result.tcpResult.connect_ms number 探测链接消耗时间单位ms

result.tcpResult.rtt number 探测rtt

udpResult object udp测试结果对象

result.udpResult.code number 探测是否成功。0成功非0失败

result.udpResult.rtt number 探测rtt

tracerouteResult object traceroute测试结果对象

result.tracerouteResult.code number 探测是否成功。0成功非0失败

result.tracerouteResult.time number 消耗时间单位ms

Source:

ZegoLiveRoom.js, line 3403

onPlayQualityUpdate(result)

拉流质量更新事件通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	事件码
`stream_id`	string	流id
`fps`	number	视频帧率(网络接收)
`vdj_fps`	number	视频帧率(dejitter)
`vdec_fps`	number	视频帧率(解码)
`vrnd_fps`	number	视频帧率(渲染)
`kbps`	number	视频码率(kb/s)
`afps`	number	音频帧率(网络接收)
`adj_fps`	number	音频帧率(dejitter)
`adec_fps`	number	音频帧率(解码)
`arnd_fps`	number	音频帧率(渲染)
`akbps`	number	音频码率(kb/s)
`audio_break_rate`	number	音频卡顿次数
`video_break_rate`	number	视频卡顿次数
`rtt`	number	延时(ms)
`pkt_lost_rate`	number	丢包率(0~255)
`quality`	number	质量(0~3)
`delay`	number	语音延时(ms)
`is_hardware_vdec`	number	是否硬解
`width`	number	视频宽度
`height`	number	视频高度
`total_bytes`	number	已接收的总字节数，包括音频、视频及媒体次要信息等
`audio_bytes`	number	已接收的音频字节数
`video_bytes`	number	已接收的视频字节数
`cpu_app_usage`	number	当前 APP 的 CPU 使用率
`cpu_total_usage`	number	当前系统的 CPU 使用率
`memory_app_usage`	number	当前 APP 的内存使用率
`memory_total_usage`	number	当前系统的内存使用率
`memory_app_used`	number	当前系统的内存使用率

Source:

ZegoLiveRoom.js, line 2658

onPlayStateUpdate(result)

拉流状态通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0-成功，其它值查看官网3 onPlayStateUpdate的错误码说明
`stream_id`	string	流id

Source:

ZegoLiveRoom.js, line 2650

onPublishQualityUpdate(result)

推流质量通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`cfps`	number	视频帧率(采集)
`venc_fps`	number	视频帧率(编码)
`fps`	number	视频帧率(网络发送)
`kbps`	number	视频码率(kb/s)
`acap_fps`	number	音频帧率（采集）
`afps`	number	音频帧率（网络发送）
`akbps`	number	音频码率(kb/s)
`rtt`	number	延时(ms)
`pkt_lost_rate`	number	丢包率(0~255)
`quality`	number	质量(0~3)
`is_hardware_venc`	number	是否硬编
`width`	number	视频宽度
`height`	number	视频高度
`total_bytes`	number	已发送的总字节数，包括音频、视频及媒体次要信息等
`audio_bytes`	number	已发送的音频字节数
`video_bytes`	number	已发送的视频字节数
`cpu_app_usage`	number	当前 APP 的 CPU 使用率
`cpu_total_usage`	number	当前系统的 CPU 使用率
`memory_app_usage`	number	当前 APP 的内存使用率
`memory_total_usage`	number	当前系统的内存使用率
`memory_app_used`	number	当前系统的内存使用率

Source:

ZegoLiveRoom.js, line 2704

onPublishStateUpdate(result)

推流状态更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0-成功，其它值查看官网2 onPublishStateUpdate的错误码说明
`stream_id`	string	流id
`rtmp_urls`	string \| array	rtmp url数组
`flv_urls`	string \| array	flv url 数组
`hls_urls`	string \| array	hls url 数组

Source:

ZegoLiveRoom.js, line 2693

onReconnect(result)

与 server 重连成功通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3059

onRecvBigRoomMessage(result)

收到大房间消息通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

msg_list

object | array

消息信息对象数组，消息信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`role`	number	成员角色，1-主播，2-观众
`content`	string	消息内容
`msg_id`	string	消息id
`msg_type`	string	消息类型
`msg_category`	number	消息类别，1-聊天，2-系统，3-点赞，4-送礼物，100-其它
`send_time`	number	消息发送时间

Source:

ZegoLiveRoom.js, line 2878

onRecvCustomCommand(result)

收到自定义消息

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`user_id`	string	消息来源用户id
`user_name`	string	消息来源用户名字
`room_id`	string	房间id
`content`	string	消息内容

Source:

ZegoLiveRoom.js, line 2930

onRecvMediaSideInfo(result)

收到媒体次要信息时回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`side_info`	string	媒体次要信息内容

Source:

ZegoLiveRoom.js, line 3101

onRecvMultiRoomBigRoomMessage(result)

第二套房间收到大房间消息通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

msg_list

object | array

消息信息对象数组，消息信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`role`	number	成员角色，1-主播，2-观众
`content`	string	消息内容
`msg_id`	string	消息id
`msg_type`	string	消息类型
`msg_category`	number	消息类别，1-聊天，2-系统，3-点赞，4-送礼物，100-其它
`send_time`	number	消息发送时间

Source:

ZegoLiveRoom.js, line 2895

onRecvMultiRoomCustomCommand(result)

第二套房间收到自定义消息

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`user_id`	string	消息来源用户id
`user_name`	string	消息来源用户名字
`room_id`	string	房间id
`content`	string	消息内容

Source:

ZegoLiveRoom.js, line 2940

onRecvMultiRoomMessage(result)

第二套房间收到房间消息通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

msg_list

object | array

消息信息对象数组，消息信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`role`	number	成员角色，1-主播，2-观众
`content`	string	消息内容
`msg_id`	string	消息id
`msg_type`	string	消息类型
`msg_priority`	number	消息优先级，2-默认优先级，3-高优先级
`msg_category`	number	消息类别，1-聊天，2-系统，3-点赞，4-送礼物，100-其它
`send_time`	number	消息发送时间

Source:

ZegoLiveRoom.js, line 2840

onRecvRemoteAudioFirstFrame(result)

接收到远端音频的首帧通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	number	流id

Source:

ZegoLiveRoom.js, line 3337

onRecvRemoteVideoFirstFrame(result)

接收到远端视频的首帧通知当远端视频频的首帧到达后，会收到该 API 回调通知。从调用开始拉流接口到显示第一帧数据的过程中可能存在一个短暂的时间差（具体时长取决于当前的网络状态），推荐在进入直播页面时加载一张预览图以提升用户体验，然后在收到本回调后去掉预览图。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	number	流id

Source:

ZegoLiveRoom.js, line 3345

onRecvRoomMessage(result)

收到房间消息通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

msg_list

object | array

消息信息对象数组，消息信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`role`	number	成员角色，1-主播，2-观众
`content`	string	消息内容
`msg_id`	string	消息id
`msg_type`	string	消息类型
`msg_priority`	number	消息优先级，2-默认优先级，3-高优先级
`msg_category`	number	消息类别，1-聊天，2-系统，3-点赞，4-送礼物，100-其它
`send_time`	number	消息发送时间

Source:

ZegoLiveRoom.js, line 2822

onRemoteCameraStatusUpdate(result)

远端摄像头状态通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`status`	number	0 - 设备已打开， 1 - 设备已关闭
`reason`	number	设备状态变化原因，查看 ZEGOCONSTANTS.ZegoDeviceErrorReason

Source:

ZegoLiveRoom.js, line 3316

onRemoteMicStatusUpdate(result)

远端麦克风状态通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`status`	number	0 - 设备已打开， 1 - 设备已关闭
`reason`	number	设备状态变化原因，查看 ZEGOCONSTANTS.ZegoDeviceErrorReason

Source:

ZegoLiveRoom.js, line 3327

onRenderRemoteVideoFirstFrame(result)

远端视频渲染首帧通知当开始要渲染远端的视频首帧时，会收到该 API 回调通知。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	number	流id

Source:

ZegoLiveRoom.js, line 3355

onRetryDevice(result)

当前正在尝试使用的设备回调，只有windows平台才支持在初始化SDK之前调用zegoClient.setGeneralConfig({config:"device_mgr_mode=3"});配置后，自动重试设备才会生效，建议业务层在该接口里获取当前尝试的设备信息后，更新相关的设备选择界面信息。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`device_id`	number	设备id
`device_name`	string	设备名字，值为"camera"、"microphone"或者"speaker"

Source:

ZegoLiveRoom.js, line 3017

onScreenCapWindowStateChange(status_code)

屏幕采集窗口状态发生变化的回调。

Parameters:

Name	Type	Description
`status_code`	number	窗口状态：0：窗口无变化;1：窗口销毁;2：窗口最大化;3:窗口最小化;4:窗口激活;5 窗口失去激活;6 窗口显示;7 窗口隐藏;8 窗口移动;9 窗口被覆盖;10 覆盖窗口被移开
`result.handle`	number	窗口句柄
`result.left、result.top、result.right、result.bottom窗口大小`	number

Source:

ZegoLiveRoom.js, line 3395

onSendBigRoomMessage(result)

发送大房间消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	房间id
`send_seq`	number	消息序号
`msg_id`	string	消息id

Source:

ZegoLiveRoom.js, line 2858

onSendMultiRoomBigRoomMessage(result)

第二套房间发送大房间消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	房间id
`send_seq`	number	消息序号
`msg_id`	string	消息id

Source:

ZegoLiveRoom.js, line 2868

onSendMultiRoomCustomCommand(result)

第二套发送自定义消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	字符串
`request_seq`	number	序号

Source:

ZegoLiveRoom.js, line 2921

onSendMultiRoomMessage(result)

第二套房间发送房间消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	房间id
`send_seq`	number	发送的消息序号
`msg_id`	number	消息id

Source:

ZegoLiveRoom.js, line 2812

onSendRoomMessage(result)

发送房间消息结果返回

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码
`room_id`	string	房间id
`send_seq`	number	发送的消息序号
`msg_id`	number	消息id

Source:

ZegoLiveRoom.js, line 2802

onSoundLevelInMixedPlayStream(result)

混流中，音浪回调通知，显示发言者及音量大小的回调。每秒钟10次通知，不拉流没有通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

volume_list

objct | array

音量数组对象列表，音量对象属性如下：

Properties

Name	Type	Description
`sound_level_id`	number	音浪id，对应混流输入流的音浪id
`sound_level`	number	音浪值，标识音量的大小

Source:

ZegoLiveRoom.js, line 3236

onSoundLevelUpdate(result)

获取 soundLevel 更新的回调, 可以获取房间内所有流（非自己推的流）的 soundLevel 值

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`sound_level`	number	音浪值

Source:

ZegoLiveRoom.js, line 3262

onStreamExtraInfoUpdated(result)

流附加信息更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

stream_count number 流数量

stream_list

object | array

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`stream_id`	string	流id
`extra_info`	string	extra_info信息

Source:

ZegoLiveRoom.js, line 2950

onStreamUpdated(result)

流更新事件通知，房间内增加流、删除流，均会触发此更新。主播推流，自己不会收到此回调，房间内其他成员会收到。建议对流增加和流删除分别采取不同的处理。

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

room_id string 房间id

stream_update_type number 2001-新增流，2002-删除流

stream_count number 流数量

stream_list

object | array

流信息对象数组，流信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`stream_id`	string	流id
`extra_info`	string	流额外信息

Source:

ZegoLiveRoom.js, line 2733

onTakeSnapshot(result)

拉流截图回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`stream_id`	string	流id
`width`	number	图像宽
`height`	number	图像高
`image_data`	string	截图png图像的base64字符串；设置如下标签属性即可显示图像：img.setAttribute('src', "data:image/png;base64," + rs.image_data);

Source:

ZegoLiveRoom.js, line 3119

onTakeSnapshotPreview(result)

本地预览截图回调

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`channel_index`	number	通道索引
`width`	number	图像宽
`height`	number	图像高
`image_data`	string	截图png图像的base64字符串；设置如下标签属性即可显示图像：img.setAttribute('src', "data:image/png;base64," + rs.image_data);

Source:

ZegoLiveRoom.js, line 3109

onTempBroken(result)

与 server 连接中断通知，SDK会尝试自动重连

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码，0 表示无错误
`room_id`	string	房间id

Source:

ZegoLiveRoom.js, line 3075

onTestStop(result)

网络测速模块连通回调探测连接和测速都会回调此值

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`error_code`	number	错误码 0 成功操作
`probe_type`	number	1 连通性测试 2 上行测速 3 下行测速

Source:

ZegoLiveRoom.js, line 3441

onUpdateOnlineCount(result)

房间在线人数更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`room_id`	string	房间id
`online_count`	number	在线人数

Source:

ZegoLiveRoom.js, line 2786

onUpdateSpeed(result)

网络测速模块连通回调探测连接和测速都会回调此值

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`net_connectcost`	number
`net_rtt`	number	rtt
`net_pktlostrate`	number	丢包率
`net_quality`	number	网络质量等级
`probe_type`	number	1 连通性测试 2 上行测速 3 下行测速

Source:

ZegoLiveRoom.js, line 3430

onUserUpdate(result)

房间用户信息更新

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name Type Description

update_type number 更新类型，1-全量更新，2-增量更新

users

object | array

用户信息对象数组，用户信息对象属性如下：

Properties

Name	Type	Description
`user_id`	string	用户id
`user_name`	string	用户名字
`update_flag`	number	更新属性，1-新增，2-删除
`role`	number	成员角色，1-主播，2-观众

Source:

ZegoLiveRoom.js, line 2762

onVideoData(result)

渲染前的视频数据回调，可以在该回调中拿到视频RGBA数据并修改

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`is_local_stream`	boolean	是否是本地采集的视频数据
`local_stream_channel`	number	当is_local_stream为true时有效，local_stream_channel 等于ZEGOCONSTANTS.PublishChannelIndex.PUBLISH_CHN_MAIN 时是主通道视频数据，local_stream_channel 等于ZEGOCONSTANTS.PublishChannelIndex.PUBLISH_CHN_AUX 是辅通道数据
`is_media_player_stream`	boolean	是否是使用mediaplayer播放的视频数据
`player_index`	number	当is_media_player_stream为true时有效，表示播放器索引，多实例播放器下区分哪个播放器播放的视频
`stream_id`	string	流id，当is_local_stream、is_media_player_stream 都为false时生效，表示拉流的流id
`width`	number	视频宽
`height`	number	视频高
`data`	byte \| array	视频数据buffer，都为RGBA数据

Source:

ZegoLiveRoom.js, line 3246

onVideoDeviceStateChanged(result)

视频设备状态更新通知

Parameters:

Name Type Description

result

object

结果数据对象

Properties

Name	Type	Description
`device_state`	number	0-添加设备，1-删除设备
`device_id`	string	设备id
`device_name`	string	设备名字

Source:

ZegoLiveRoom.js, line 2988