Skip to main content

继承关系


BaseTrack

所有轨道的基类,提供轨道元信息访问。

id

轨道 ID,在频道内唯一标识该轨道。

kind

轨道类型:'audio''video'

desc

轨道描述,由发布时指定,例如 'camera_big''screen'

getInfo

获取完整轨道信息,例如分辨率、码率、采样率等。
返回值: TrackInfo,详见 类型定义

getUid

获取轨道所属用户的 UID。

getMediaStreamTrack

获取底层 MediaStreamTrack,可用于 Web Audio API、自定义后处理等场景。

LocalAudioTrack

本地音频轨道基类,也用于自定义音频流,例如 srtc.createLocalCustomAudioTrack(...) 的返回值。 继承自 BaseTrack

startPlay

播放音频,可用于本地监听。

stopPlay

停止播放,释放对播放设备的占用。

getVolume

获取当前音频输入音量,范围 0 ~ 100

isPlaying

当前是否正在播放。

setProcessor

挂载音频处理器(如 RNN 降噪、变声)。需先 startCapture 采集到轨道后调用;传入数组时按顺序串联。已发布的轨道也可挂载,SDK 会免重协商地切换;切换设备后处理器会自动重挂。详见音视频处理器

removeProcessor

卸载已挂载的处理器,还原为原始采集轨道并释放处理器资源。

LocalMicTrack

本地麦克风轨道,继承自 LocalAudioTrack,通过 srtc.createLocalMicTrack 创建。

startCapture

开始采集,会向用户请求麦克风权限。

stopCapture

停止采集,释放麦克风设备。

changeDeviceId

热切换麦克风设备。

LocalScreenAudioTrack

屏幕共享附带的系统音频轨道,继承自 LocalAudioTrack 这个类通常不直接手动创建,而是通过 LocalScreenTrack.getAudioTrack() 获取。

stopCapture

停止系统音频采集。
其余播放相关方法继承自 LocalAudioTrack,例如 startPlay()stopPlay()isPlaying()

LocalVideoTrack

本地视频轨道基类,也用于自定义视频流,例如 srtc.createLocalCustomVideoTrack(...) 的返回值。 继承自 BaseTrack

addPlayView

将视频渲染到指定 HTML 容器元素。

hasPlayView

判断是否已有渲染容器。

removePlayView

移除指定渲染容器。

removeAllPlayViews

移除所有渲染容器。

enterPictureInPicture

让指定容器对应的视频进入画中画模式。
默认优先使用 Document PiP。若浏览器不支持,会自动降级到传统 video.requestPictureInPicture()

exitPictureInPicture

退出指定容器的画中画模式。

isPictureInPicture

判断指定容器是否处于画中画模式。

popOutToWindow

将指定容器对应的视频弹出到独立浏览器窗口。

closePopOutWindow

关闭指定容器对应的弹出窗口。

isPopOut

判断指定容器是否已经弹出到独立窗口。

getSimulcastTrack

基于给定的联播发布参数创建或获取一个联播子轨道。

setProcessor

挂载视频处理器(如美颜、虚化背景)。需先 startCapture 采集到轨道后调用;传入数组时按顺序串联。已发布的轨道也可挂载,SDK 会免重协商地切换;切换设备后处理器会自动重挂。详见音视频处理器

removeProcessor

卸载已挂载的处理器,还原为原始采集轨道并释放处理器资源。
对于 LocalCameraTrackLocalScreenTrackRemoteVideoTrack,以上 PiP / 弹窗方法均可使用。 options.hideOriginViewtrue(默认值)时:
  • Document PiP弹出窗口 会隐藏主页面中的原始播放视图,避免双重渲染
  • 传统 video PiP 仍依赖原始 video 元素,因此不会隐藏原始视图

LocalCameraTrack

本地摄像头视频轨道,继承自 LocalVideoTrack,通过 srtc.createLocalCameraTrack 创建。

startCapture

开始采集,会向用户请求摄像头权限。

stopCapture

停止采集,释放摄像头设备。

changeDeviceId

热切换摄像头设备。

switchFacingMode

在前置/后置摄像头之间切换,仅移动端生效。

setMirror

设置本地预览镜像开关。前置摄像头默认开启镜像(如同照镜子),可在此调整;后置摄像头不支持镜像,调用无任何反应。 镜像只影响本地预览的渲染(含画中画、弹出窗口),不会改变推流数据与远端看到的画面。切换前后置摄像头会自动重新计算镜像状态,并保留用户对前置摄像头的开关偏好。

isMirrored

返回当前是否处于镜像状态(前置摄像头且镜像开关开启)。后置摄像头恒为 false,可用于 UI 回显当前镜像状态。

isFrontFacing

判断当前是否为前置摄像头。采集时显式指定的 facingMode 最可靠;未指定时按前置处理。

LocalScreenTrack

本地屏幕共享视频轨道,继承自 LocalVideoTrack,通过 srtc.createLocalScreenTrack 创建。

startCapture

开始屏幕采集,浏览器会弹出屏幕选择窗口。

stopCapture

停止屏幕采集。

getAudioTrack

获取同时采集的系统音频轨道。仅当 createLocalScreenTrack 传入了 audioPreset 且浏览器支持时有效。
详细用法见 屏幕共享 - 同时采集系统音频

RemoteAudioTrack

远端单路音频轨道,通过 srtc.subscribeRemoteAudioTrack 订阅。 继承自 BaseTrack

startPlay

播放远端音频。

stopPlay

停止播放,释放对播放设备的占用。

isPlaying

当前是否正在播放。

RemoteAudioMixTrack

远端全频道混音流,继承自 RemoteAudioTrack,通过 srtc.subscribeRemoteAudioMixTrack 订阅。 大多数场景下只需要订阅这一路混音流,而无需订阅每个用户的单独音频流。

getFilterUids

获取当前从混音中排除的用户 ID 列表。
播放相关方法继承自 RemoteAudioTrack,例如 startPlay()stopPlay()isPlaying()

RemoteVideoTrack

远端视频轨道,通过 srtc.subscribeRemoteVideoTrack 订阅。 继承自 BaseTrack

setJitterBufferTarget

设置接收端抗抖动缓冲的目标延迟,单位 ms。
参数说明:
该能力依赖浏览器 WebRTC 接收端实现。Chrome / Edge 会优先使用 jitterBufferTarget,并兼容旧的 playoutDelayHint;Firefox / Safari 不支持时会静默忽略。

getJitterBufferTarget

获取当前设置的接收端抗抖动缓冲目标延迟。
返回值为当前业务设置的目标延迟,单位 ms;返回 undefined 表示未设置,使用浏览器默认自适应策略。

addPlayView

将远端视频渲染到指定 HTML 容器元素。

hasPlayView

判断是否已有渲染容器。

removePlayView

移除指定渲染容器。

removeAllPlayViews

移除所有渲染容器。

enterPictureInPicture

让指定容器对应的远端视频进入画中画模式。

exitPictureInPicture

退出指定容器的画中画模式。

isPictureInPicture

判断指定容器是否处于画中画模式。

popOutToWindow

将远端视频弹出到独立窗口。

closePopOutWindow

关闭指定容器对应的弹出窗口。

isPopOut

判断指定容器是否已经弹出到独立窗口。