Interface ICameraVideoTrack

本地摄像头视频轨道，继承于 LocalVideoTrack，并在此基础上提供了更换采集设备/调整编码参数的功能。
可以通过 AgoraRTC.createCameraVideoTrack 来获取。

Properties

enabled

enabled: boolean

本地轨道当前的启用状态。

isPlaying

isPlaying: boolean

媒体轨道是否正在页面上播放。

true: 媒体轨道正在页面上播放。
false: 媒体轨道没有在页面上播放。

muted

muted: boolean

本地媒体轨道当前的静音状态。

processorDestination

processorDestination: IBaseProcessor

自从

4.10.0
本地视频轨道上当前媒体处理链路的最终节点。

trackMediaType

trackMediaType: "audio" | "video"

媒体轨道的类型：

"audio": 音频轨道。
"video": 视频轨道。

Methods

clone

clone(config?: VideoEncoderConfiguration | VideoEncoderConfigurationPreset, cloneTrack?: boolean): ICameraVideoTrack

自从

4.19.0

复制当前的视频轨道对象，生成一个新的视频轨道。

在视频会议、在线教育等场景中，你可以用该方法实现同一视频流的两路显示，并为每路显示设置不同的分辨率、帧率、码率等参数。

参数

参数名	描述
config: VideoEncoderConfiguration \| VideoEncoderConfigurationPreset	新生成视频轨道的编码配置。你可以通过 VideoEncoderConfiguration 传入 SDK 内置的编码配置；也可以通过传入一个 VideoEncoderConfigurationPreset 来自定义视频编码配置。
cloneTrack: boolean	是否克隆当前轨道。默认为 `true`。

返回值

ICameraVideoTrack

新生成的视频轨道。

close

close(): void

关闭本地轨道，并释放相关采集设备。

一旦本地轨道被关闭，就无法再次使用。如需再次使用本地轨道，需要重新创建。

返回值

void

getCurrentFrameData

getCurrentFrameData(): ImageData

自从

4.1.0

获取当前渲染的视频帧数据。

注意

只有在播放后才能调用此方法，如果没有调用 play 则返回空数据。

返回值

ImageData

存储了 RGBA 数据的 ImageData 对象。该对象为浏览器原生对象，详见 ImageData。

getListeners

getListeners(event: string): Function[]

指定一个事件名，获取当前所有监听这个事件的回调函数。

参数

参数名	描述
event: string	事件名称。

返回值

Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

获取浏览器原生的 MediaStreamTrack 对象。

返回值

MediaStreamTrack

一个 MediaStreamTrack 对象。

getRTCRtpTransceiver

getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

获取当前轨道的 RTCRtpTransceiver 实例。

该方法目前主要用于视频流的端到端加密（Beta）。

注意

如果 SDK 发生断线重连，当前轨道对应的 RTCRtpTransceiver 实例可能会发生变化。你可以通过以下回调来获取新的 RTCRtpTransceiver 实例：

本地轨道：ILocalTrack.transceiver-updated
远端轨道：IRemoteTrack.transceiver-updated

参数

参数名	描述
type: StreamType	视频流的类型。详见 StreamType。

返回值

RTCRtpTransceiver | undefined

当前轨道的 RTCRtpTransceiver 实例。

getStats

getStats(): LocalVideoTrackStats

获取本地视频轨道的相关信息。

deprecated: 自 v4.1.0 起废弃，请使用 AgoraRTCClient.getLocalVideoStats 和 AgoraRTCClient.getLocalAudioStats。

返回值

LocalVideoTrackStats

getTrackId

getTrackId(): string

获取由 SDK 生成的对于媒体轨道来说的唯一 ID。

返回值

string

媒体轨道 ID。

getTrackLabel

getTrackLabel(): string

获取本地轨道的来源描述。

返回值

string

可能返回以下值：

如果是通过 createMicrophoneAudioTrack 或 createCameraVideoTrack 创建的轨道，返回 MediaDeviceInfo.label 字段。
如果是通过 createScreenVideoTrack 创建的轨道，返回屏幕共享的 sourceId。
如果是 createCustomAudioTrack 或 createCustomVideoTrack 创建的轨道，返回 MediaStreamTrack.label 字段。

getVideoElementVisibleStatus

getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined

@自从
4.8.0

获取 HTML <video> 标签的可见状态和不可见原因。

调用 localVideoTrack.play 后 SDK 会创建 HTML <video> 标签用于播放视频轨道。当 localVideoTrack.isPlaying 为 true 却看不到图像时，你可调用该方法进行问题排查。

返回值

CheckVideoVisibleResult | undefined

CheckVideoVisibleResult 对象。如果该方法返回 undefined，可能为以下原因：

localVideoTrack.isPlaying 为 false。
<video> 标签不存在。
<video> 标签不是通过 play 方法调用产生的。

off

off(event: string, listener: Function): void

取消一个指定事件的监听。

参数

参数名	描述
event: string	指定事件的名称。
listener: Function	监听事件时传入的回调函数。

返回值

void

on

on(event: "track-updated", listener: typeof event_track_updated): void

on(event: "track-updated", listener: typeof event_track_updated): void

参数

参数名	描述
event: "track-updated"	事件名称。
listener: typeof event_track_updated	详见 track-updated。

返回值

void

on(event: "track-ended", listener: typeof event_track_ended): void

on(event: "track-ended", listener: typeof event_track_ended): void

参数

参数名	描述
event: "track-ended"	事件名称。
listener: typeof event_track_ended	详见 track-ended。

返回值

void

on(event: "video-element-visible-status", listener: typeof event_video_element_visible_status): void

on(event: "video-element-visible-status", listener: typeof event_video_element_visible_status): void

参数

参数名	描述
event: "video-element-visible-status"	事件名称。
listener: typeof event_video_element_visible_status	详见 video-element-visible-status。

返回值

void

on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void

on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void

添加事件监听器。

参数

参数名	描述
event: "transceiver-updated"	事件名称。
listener: typeof event_transceiver_updated	详见 ILocalTrack.transceiver-updated。

返回值

void

once

once(event: string, listener: Function): void

监听一个指定的事件，当事件触发时会调用传入的回调函数。

当监听后事件第一次触发时，该监听和回调函数就会被立刻移除，也就是只监听一次指定事件。

参数

参数名	描述
event: string	指定事件的名称。
listener: Function	传入的回调函数。

返回值

void

pipe

pipe(processor: IBaseProcessor): IBaseProcessor

自从

4.10.0

将 Processor 注入本地视频轨道。

参数

参数名	描述
processor: IBaseProcessor	`Processor` 实例。每个插件均有对应类型的 `Processor`。

返回值

IBaseProcessor

Processor 实例。

play

play(element: string | HTMLElement, config?: VideoPlayerConfig): void

在页面上播放远端视频轨道。

参数

参数名	描述
element: string \| HTMLElement	指定一个 DOM 元素，SDK 将在这个元素下创建 `<video>` 元素播放视频轨道，支持 2 种类型： `string`: 指定该 DOM 元素的 ID 值。 `HTMLElement`: 直接传入一个 DOM 元素对象。
config: VideoPlayerConfig	设置播放参数（镜像/显示模式）。详见 VideoPlayerConfig。对于本地视频轨道，镜像模式默认开启。

返回值

void

removeAllListeners

removeAllListeners(event?: string): void

指定一个事件，取消其所有的监听。

参数

参数名	描述
event: string	指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

返回值

void

replaceTrack

replaceTrack(track: MediaStreamTrack, stopOldTrack: boolean): Promise<void>

自从

4.17.0

替换本地视频轨道。

该方法在本地视频流发布前或发布后都可以调用：

在发流前调用，新的视频轨道会在本地播放。
在发流后调用，远端会接收到新的视频轨道。

新的视频轨道可以通过 ILocalVideoTrack.getMediaStreamTrack 或者 mediaStream.getVideoTracks 方法获取。你可以选择是否停止被替换的视频轨道。

注意

注意事项：

支持 Chrome 65+，Safari 以及最新版 Firefox 浏览器。
部分移动设备上该方法可能不生效。
建议在相同类型、相同编码配置的视频轨道之间进行替换，原因如下：
- 如果视频轨道类型不同，例如用 ScreenVideoTrack 对象替换 CameraVideoTrack 对象，由于 CameraVideoTrack 默认开启镜像（详见 VideoPlayerConfig.mirror），会导致画面发生镜像翻转。
- 如果编码配置（encoderConfig）不同，可能导致实际发送的分辨率或帧率不准。
订阅端无法知悉视频轨道被替换。
如果需要切换媒体输入设备，推荐使用 ICameraVideoTrack.setDevice 方法。

示例代码

// 原有的本地视频轨道
const localVideoTrack = await AgoraRTC.createCameraVideoTrack();
// 获取新的视频轨道（方式一）
const newTrack = localVideoTrack.getMediaStreamTrack();
// 获取新的视频轨道（方式二）
const newTrack = await navigator.mediaDevices.getUserMedia({audio: true, video: true}).then(mediaStream => mediaStream.getVideoTracks()[0]);
// 替换本地视频轨道，并且停止原有的视频轨道
await localVideoTrack.replaceTrack(newTrack, true);

参数

参数名	描述
track: MediaStreamTrack	新的视频轨道。需要传入一个 MediaStreamTrack 对象。
stopOldTrack: boolean	是否停止原有的视频轨道：停止原有的视频轨道。保留原有的视频轨道。

返回值

Promise<void>

sendSeiData

sendSeiData(sei: Uint8Array): void

在 H.264 视频流中添加 SEI 数据。

参数

参数名	描述
sei: Uint8Array	SEI 数据。

返回值

void

setDevice

setDevice(deviceId: string | RequiredOnlyOneOf<object>): Promise<void>

设置负责采集视频数据的摄像头设备。

注意

在发布前和发布后均可调用此方法。

参数

参数名描述

参数名	描述
deviceId: string \| RequiredOnlyOneOf<object>	设备 ID，支持通过以下方式传入：传入字符串：传入通过 AgoraRTC.getCameras 获取的 `deviceId`。传入对象：自 4.19.0 起，你可以传入一个包含 `facingMode` 或 `deviceId` 的对象，但只能指定其中一个属性的值。其中 `deviceId` 通过 AgoraRTC.getCameras 获取，`facingMode` 支持设为以下值： `"environment"`: 使用后置摄像头。 `"user"`: 使用前置摄像头。

deviceId: string | RequiredOnlyOneOf<object>

设备 ID，支持通过以下方式传入：

传入字符串：传入通过 AgoraRTC.getCameras 获取的 deviceId。
传入对象：自 4.19.0 起，你可以传入一个包含 facingMode 或 deviceId 的对象，但只能指定其中一个属性的值。其中 deviceId 通过 AgoraRTC.getCameras 获取，facingMode 支持设为以下值：
- "environment": 使用后置摄像头。
- "user": 使用前置摄像头。

返回值

Promise<void>

setEnabled

setEnabled(enabled: boolean): Promise<void>

自从

4.0.0

启用/禁用该轨道。

轨道禁用后，播放和发布都将被停止。

注意

禁用轨道不会触发 LocalTrack.on("track-ended") 事件。
如果该轨道已发布，禁用轨道后，远端会触发 user-unpublished 事件。重新启用后，远端会触发 user-published 事件。
setEnabled 和 setMuted 不能同时调用。

参数

参数名	描述
enabled: boolean	是否启用该轨道: `true`: 启用该轨道. `false`: 禁用该轨道.

返回值

Promise<void>

setEncoderConfiguration

setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset): Promise<void>

设置视频的编码参数，包括分辨率、帧率、码率。

参数

参数名	描述
config: VideoEncoderConfiguration \| VideoEncoderConfigurationPreset	你可以传入 SDK 预设的视频编码配置 VideoEncoderConfigurationPreset，也可以传入自定义的 VideoEncoderConfiguration 对象。

返回值

Promise<void>

setMuted

setMuted(muted: boolean): Promise<void>

发送或暂停发送该轨道的媒体数据。

自从

4.6.0

如果该轨道已发布，调用 setMuted(true) 后，远端会触发 user-unpublished 事件。再调用 setMuted(false) 后，远端会触发 user-published 事件。

注意

与 setEnabled 相比，调用该方法响应速度更快且不影响视频采集状态，详见 setEnabled 和 setMuted 有什么区别？。
setEnabled 和 setMuted 不能同时调用。

参数

参数名	描述
muted: boolean	是否发送该轨道的媒体数据: `true`: 暂停发送该轨道的媒体数据。 `false`: 恢复发送该轨道的媒体数据。

返回值

Promise<void>

setOptimizationMode

setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>

自从

4.2.0

设置视频传输优化模式。

你可以在视频通话、视频直播或屏幕共享过程中调用此方法动态调整视频的传输优化模式。例如你想要把屏幕共享内容从演示文稿切换为视频时，你可以将传输优化模式从 "detail" 切换为 "motion"，确保视频画面在网络波动时不会出现卡顿。

注意

注意事项：该方法只支持 Chrome 浏览器。

参数

参数名描述

参数名	描述
mode: "balanced" \| "motion" \| "detail"	视频传输优化模式： `"balanced"`: 使用默认的传输优化模式：对于屏幕共享视频流，SDK 默认的优化策略为清晰优先。对于其他视频流，SDK 默认的优化策略为兼顾清晰和流畅，弱网条件下，帧率和分辨率都会被调整。 `"detail"`: 清晰优先。 SDK 会自动根据你的采集分辨率和帧率设定一个最小码率。即使遭遇网络波动，发送码率也不会低于这个值，从而确保清晰的视频画面。大部分情况下，SDK 不会降低发送分辨率，但是可能会降低帧率。 `"motion"`: 自 4.21.0 开始，SDK 默认开启流畅优先模式。 SDK 不会启用最小码率策略。遭遇网络波动时，发送端会降低码率来确保接收端的视频画面不会出现中断和卡顿。大部分情况下，SDK 不会降低帧率，但是可能会降低发送分辨率。

mode: "balanced" | "motion" | "detail"

视频传输优化模式：

"balanced": 使用默认的传输优化模式：
- 对于屏幕共享视频流，SDK 默认的优化策略为清晰优先。
- 对于其他视频流，SDK 默认的优化策略为兼顾清晰和流畅，弱网条件下，帧率和分辨率都会被调整。
"detail": 清晰优先。
- SDK 会自动根据你的采集分辨率和帧率设定一个最小码率。即使遭遇网络波动，发送码率也不会低于这个值，从而确保清晰的视频画面。
- 大部分情况下，SDK 不会降低发送分辨率，但是可能会降低帧率。
"motion": 自 4.21.0 开始，SDK 默认开启流畅优先模式。
- SDK 不会启用最小码率策略。遭遇网络波动时，发送端会降低码率来确保接收端的视频画面不会出现中断和卡顿。
- 大部分情况下，SDK 不会降低帧率，但是可能会降低发送分辨率。

返回值

Promise<void>

stop

stop(): void

停止播放。

返回值

void

unpipe

unpipe(): void

自从

4.10.0

取消本地视频轨道上注入的 Processor。

返回值

void

Properties​

enabled

isPlaying

muted

processorDestination

trackMediaType

Methods​

clone

参数​

返回值​

close

返回值​

getCurrentFrameData

返回值​

getListeners

参数​

返回值​

getMediaStreamTrack

返回值​

getRTCRtpTransceiver

参数​

返回值​

getStats

返回值​

getTrackId

返回值​

getTrackLabel

返回值​

getVideoElementVisibleStatus

返回值​

off

参数​

返回值​

on

参数​

返回值​

参数​

返回值​

参数​

返回值​

参数​

返回值​

once

参数​

返回值​

pipe

参数​

返回值​

play

参数​

返回值​

removeAllListeners

参数​

返回值​

replaceTrack

参数​

返回值​

sendSeiData

参数​

返回值​

setDevice

参数​

返回值​

setEnabled

参数​

返回值​

setEncoderConfiguration

参数​

返回值​

setMuted

参数​

返回值​

setOptimizationMode

参数​

返回值​

stop

返回值​

unpipe

返回值​

Properties

Methods

参数

返回值

返回值

返回值

参数

返回值

返回值

参数

返回值

返回值

返回值

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

返回值

返回值