调节音乐文件音量。
该方法调节混音里伴奏的播放音量大小。请在房间内调用该方法。
伴奏发送音量。取值范围为 0~100。默认 100,即原始文件音量。
清除录制的音视频。
参数对象。
录制 ID。可以通过 Stream.listMediaRecording 接口获取。
关闭音视频输入设备,如麦克风、摄像头、屏幕共享,并且停止发布。
配置对象
媒体流类型,即 audio、video、 screen 或 screenAudio。
销毁音视频流对象。
下载录制的音视频。
参数对象。
录制 ID。可以通过 Stream.listMediaRecording 接口获取。
获取从麦克风中采集的当前音量。
获取音乐文件当前播放进度。
该方法获取当前伴奏播放进度,单位为毫秒。请在房间内调用该方法。
方法调用成功返回音乐文件播放进度。
获取音乐文件时长。
该方法获取伴奏时长,单位为毫秒。请在房间内调用该方法。
方法调用成功返回音乐文件时长,单位为毫秒(ms)。
获取音频流 MediaStream 对象,可用于自定义音频渲染。
您可以自行渲染这个对象,例如将 audio dom 节点的 srcObject 属性设为该对象。
获取音频轨道。
获取所有音效文件播放音量。
可能返回的错误码:
获取音视频流 ID。
获取视频轨道。
获取音频 flag。
该方法用于确认当前音视频流对象(Stream)中是否包含音频资源。
获取屏幕共享 flag。
该方法用于确认当前音视频流对象(Stream)中是否包含屏幕共享资源。
获取视频 flag。
该方法用于确认当前音视频流对象(Stream)中是否包含视频资源。
初始化音视频流对象。
该方法用于初始化本地创建的音视频流对象。
返回音视频流当前是否在播放状态。
媒体流类型。
枚举录制的音视频。
录制的音视频信息。
id
:ID。type
:录制类型。name
:录制文件名称。status
:录制状态。isRecording
:是否正在录制。startTime
:录制开始时间。endTime
:录制结束时间。禁用音频轨道。
禁用屏幕共享轨道。
调用该方法会停止发送屏幕共享,远端会触发 Client.on("mute-screen") 回调。
禁用视频轨道。
打开音视频输入设备,如麦克风、摄像头、屏幕共享,并且发布出去。
代码示例可见Stream.switchDevice
配置对象。
指定要开启的设备ID。
您可以通过 getDevices 接口获取设备列表。
指定屏幕共享时是否共享本地播放的背景音。
仅在 type 为 screen 时有效。详细说明请参考 StreamOptions.screenAudio。
在V4.4.0之前,麦克风和屏幕共享音频不能同时开启。
Electron 屏幕共享的数据源 ID,您可以自行获取。
媒体流类型,即 audio、video 或 screen。
暂停播放所有音效文件。
可能返回的错误码:
暂停播放音乐文件。
请在房间内调用该方法。
暂停播放指定音效文件。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
可能返回的错误码:
播放音视频流。
div 标签,播放画面的 dom 容器节点。
播放的音视频选项。
是否播放音频流。
默认播放本地音频流,不播放远端音频流。
是否播放辅流。
默认播放辅流。
主流和辅流可在不同画布上播放。需调用play两次,即:
localStream.play(videoContainer, {video: true, screen: false});
localStream.play(screenContainer, {video: false, screen: true});
是否播放视频流。
默认播放视频流。
播放指定音效文件。
可选,指定音效文件循环播放的次数。默认值为 1,即播放 1 次。
必选。指定在线音效文件的 URL地址。
支持的音效文件类型包括 MP3,AAC 等浏览器支持的其他音频格式。
必选,指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
如果您已通过 preloadEffect 将音效加载至内存,确保 playEffect 的 soundID 与 preloadEffect 设置的 soundID 相同。
可能返回的错误码:
播放视频录制。
参数对象。
录制 ID。可以通过 Stream.listMediaRecording 接口获取。
音频或者视频画面待渲染的 DOM 节点,如 div、span 等非流媒体节点。
预加载指定音效文件。
该方法缓存音效文件,以供快速播放。为保证通信畅通,请注意控制预加载音效文件的大小。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
必选。指定在线音效文件的绝对路径。支持MP3、AAC 以及浏览器支持的其他音频格式。
可能返回的错误码:
恢复播放所有音效文件。
恢复播放音乐文件。
请在房间内调用该方法。
恢复播放指定音效文件。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
可能返回的错误码:
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
音乐文件的播放位置,单位为毫秒。
设置订阅流的音频输出设备。
该方法可以在语音场景下设置订阅流的音频输出设备,在通话时切换扬声器。在播放订阅流之前或之后都可以调用该方法。
设备的 ID,可以通过 getDevices 方法获取。获取的 ID 为 ASCII 字符,字符串长度大于 0 小于 256 字节。
设置音频属性。
要设置的音频的属性类型,可设置为:
设置音频播放的音量。
要设置的远端音频的播放音量,范围为 [0-100]。0 表示静音。
添加视频画布水印。
画布水印设置。支持设置文字水印、图片水印和时间戳水印,设置为 null 表示清除水印。
设置麦克风采集的音量。
要设置的采集音量。范围为 [0-100]。0 表示静音。
要设置的采集类型。可分开设置麦克风与屏幕共享音频。如您未使用屏幕共享音频功能,则忽略该参数。
设置所有音效文件播放音量。
音效音量。整数,范围为 [0,100]。默认 100 为原始文件音量。
可能返回的错误码:
配置对象。
媒体流类型。即指定设置的是摄像头画面还是屏幕共享画面。
配置对象。
媒体流类型。即指定设置的是摄像头画面还是屏幕共享画面。
设置屏幕共享中的屏幕属性。
该方法设置屏幕共享时屏幕的显示属性,必须在 Stream.init 之前调用。
屏幕属性。
设置本端屏幕共享帧率。参考NERTC.VIDEO_FRAME_RATE。
设置本端屏幕共享分辨率。参考NERTC.VIDEO_QUALITY。
设置视频订阅的参数。
配置参数。
是否订阅音频。
订阅大流或小流。
0 表示小流,1 表示大流。
是否订阅屏幕共享。
是否订阅视频。
设置视频属性。
设置本端视频帧率,详细信息请参考 NERTC.VIDEO_FRAME_RATE。
设置本端视频分辨率,详细信息请参考 NERTC.VIDEO_QUALITY。
调节指定音效文件的音量。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
音效音量。整数,范围为 [0,100]。默认为 100,即原始文件音量。
可能返回的错误码:
开始播放音乐文件。
该方法指定在线音频文件和麦克风采集的音频流进行混音或替换,即用音频文件替换麦克风采集的音频流。
混音设置。
必选,在线音乐文件的 URL 地址。
可选,伴音文件播放完成的通知反馈。正常停止伴音或关掉通话获取其他原因停止伴音不会触发。
可选,指定音频文件循环播放的次数。
是否循环播放音频文件,默认为 false。
可选,设置音频文件开始播放的时间位置,单位为秒(s)。默认为 0,即从头开始播放。
可选,是否要用音频文件替换本地音频流。
可选,音乐文件的播放音量,取值范围为 0~100。默认为 100,表示使用文件的原始音量。
开启单人视频录制。
参数对象。
如果之前的录制视频未下载,是否重置,默认 false。
流类型,即 'audio'、'video' 或 'screen'。其中,video
或 screen
会带上音频。
停止音视频流。
该方法用于停止播放 Stream.play 播放的音视频流。
停止播放所有音效文件。
可能返回的错误码:
停止播放音乐文件。
请在房间内调用该方法。
停止播放指定音效文件。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
可能返回的错误码:
结束视频录制。
参数对象。
录制 ID。可以通过 Stream.listMediaRecording 接口获取。
切换媒体输入设备。
该方法用于切换本地流的媒体输入设备,例如麦克风,摄像头。
设备的类型。
设备的 ID,可以通过 getDevices 方法获取。获取的 ID 为 ASCII 字符,字符串长度大于 0 小于 256 字节。
截取指定用户的视频流画面。
截图文件保存在浏览器默认路径下。
截图的视频流类型。
截图文件名称,默认格式为 uid-1。
释放指定音效文件。
该方法从内存释放某个预加载的音效文件,以节省内存占用。
指定音效的 ID。每个音效均有唯一的 ID。正整数,取值范围为 [1,10000]。
可能返回的错误码:
启用音频轨道。
启用屏幕共享轨道。
如果您调用了 muteScreen,可调用本方法启用屏幕共享轨道。远端会触发 Client.on("ummute-screen") 回调。
启用视频轨道。
视频轨道默认为开启状态。如果您调用了 Stream.muteVideo,可调用本方法启用视频轨道。
对本地流启用视频轨道后远端会触发 Client.on("unmute-video") 回调。
音视频流对象。
Stream 接口提供的方法用于定义音视频流对象的行为,例如流的播放控制、音视频的编码配置等。
您可以使用 NERTC.createStream 创建音视频流对象。 一个 Stream 对象指通话中发布的本地音视频流或订阅的远端音视频流。