# Interface ILocalTrack (/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

## Events [#events]

<a id="event_track_ended"></a>

### track-ended [#track-ended]

<ApiSignature>

track-ended(): void

</ApiSignature>

音频或视频轨道被终止，终止的原因可能是：

- 摄像头被拔出
- 麦克风被拔出
- 用户主动停止了屏幕共享
- 用户主动关闭了底层的 `MediaStreamTrack`
- 媒体设备故障
- 正在使用中的媒体设备的权限被收回

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="event_transceiver_updated"></a>

### transceiver-updated [#transceiver-updated]

<ApiSignature>

transceiver-updated(transceiver: RTCRtpTransceiver, type?: [StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)): void

</ApiSignature>

当前轨道的 `RTCRtpTransceiver` 实例更新回调。

<ParameterList title="Parameters">
<Parameter name="transceiver" type="RTCRtpTransceiver" required>

新的 `RTCRtpTransceiver` 实例。

</Parameter>
<Parameter name="type" optional>

<ParameterType>

[StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)

</ParameterType>

当前轨道所属视频流的类型。详见 [StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

## Properties [#properties]

<a id="enabled"></a>

### enabled [#enabled]

<ApiSignature>

enabled: boolean

</ApiSignature>

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

<a id="isplaying"></a>

### isPlaying [#isplaying]

<ApiSignature>

isPlaying: boolean

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[isPlaying](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#isplaying)

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

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

<a id="muted"></a>

### muted [#muted]

<ApiSignature>

muted: boolean

</ApiSignature>

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

<a id="trackmediatype"></a>

### trackMediaType [#trackmediatype]

<ApiSignature>

trackMediaType: "audio"|"video"

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[trackMediaType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#trackmediatype)

媒体轨道的类型：

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

## Methods [#methods]

<a id="close"></a>

### close [#close]

<ApiSignature>

close(): void

</ApiSignature>

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

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

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="getlisteners"></a>

### getListeners [#getlisteners]

<ApiSignature>

getListeners(event: string): Function[]

</ApiSignature>

Inherited from EventEmitter.getListeners

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

<ParameterList title="Parameters">
<Parameter name="event" type="string" required>

事件名称。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

Function[]

</ApiReturnType>

</ApiReturns>

<a id="getmediastreamtrack"></a>

### getMediaStreamTrack [#getmediastreamtrack]

<ApiSignature>

getMediaStreamTrack(): MediaStreamTrack

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[getMediaStreamTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#getmediastreamtrack)

获取浏览器原生的 [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) 对象。

<ApiReturns>

<ApiReturnType>

MediaStreamTrack

</ApiReturnType>

一个 [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) 对象。

</ApiReturns>

<a id="getrtcrtptransceiver"></a>

### getRTCRtpTransceiver [#getrtcrtptransceiver]

<ApiSignature>

getRTCRtpTransceiver(type?: [StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)): RTCRtpTransceiver | undefined

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[getRTCRtpTransceiver](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#getrtcrtptransceiver)

获取当前轨道的 [RTCRtpTransceiver](https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpTransceiver) 实例。

该方法目前主要用于视频流的[端到端加密（Beta）](/zh-CN/realtime-media/rtc/build/security-and-auth/e2e-encryption)。

> 如果 SDK 发生断线重连，当前轨道对应的 `RTCRtpTransceiver` 实例可能会发生变化。你可以通过以下回调来获取新的 `RTCRtpTransceiver` 实例：
>
> - 本地轨道：[ILocalTrack.transceiver-updated](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#event_transceiver_updated)
> - 远端轨道：[IRemoteTrack.transceiver-updated](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iremotetrack#event_transceiver_updated_2)

<ParameterList title="Parameters">
<Parameter name="type" optional>

<ParameterType>

[StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)

</ParameterType>

视频流的类型。详见 [StreamType](/zh-CN/api-reference/rtc/react-sdk/web-sdk/enums/streamtype)。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

RTCRtpTransceiver | undefined

</ApiReturnType>

当前轨道的 `RTCRtpTransceiver` 实例。

</ApiReturns>

<a id="getstats"></a>

### getStats [#getstats]

<ApiSignature>

getStats(): [LocalVideoTrackStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/localvideotrackstats) | [LocalAudioTrackStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/localaudiotrackstats)

</ApiSignature>

#### deprecated [#deprecated]

自 v4.1.0 起废弃，请使用 [AgoraRTCClient.getLocalVideoStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#getlocalvideostats) 和 [AgoraRTCClient.getLocalAudioStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#getlocalaudiostats)。

获取本地轨道相关信息。

:::note[注意事项]
获取本地视频轨道数据时，iOS 上无法获取到 `encodeDelay` 字段。
:::

<ApiReturns>

<ApiReturnType>

[LocalVideoTrackStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/localvideotrackstats) | [LocalAudioTrackStats](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/localaudiotrackstats)

</ApiReturnType>

</ApiReturns>

<a id="gettrackid"></a>

### getTrackId [#gettrackid]

<ApiSignature>

getTrackId(): string

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[getTrackId](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#gettrackid)

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

<ApiReturns>

<ApiReturnType>

string

</ApiReturnType>

媒体轨道 ID。

</ApiReturns>

<a id="gettracklabel"></a>

### getTrackLabel [#gettracklabel]

<ApiSignature>

getTrackLabel(): string

</ApiSignature>

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

<ApiReturns>

<ApiReturnType>

string

</ApiReturnType>

可能返回以下值：

- 如果是通过 `createMicrophoneAudioTrack` 或 `createCameraVideoTrack` 创建的轨道，返回 [MediaDeviceInfo.label](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/label) 字段。
- 如果是通过 `createScreenVideoTrack` 创建的轨道，返回屏幕共享的 `sourceId`。
- 如果是 `createCustomAudioTrack` 或 `createCustomVideoTrack` 创建的轨道，返回 [MediaStreamTrack.label](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/label) 字段。

</ApiReturns>

<a id="off"></a>

### off [#off]

<ApiSignature>

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

</ApiSignature>

Inherited from EventEmitter.off

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

<ParameterList title="Parameters">
<Parameter name="event" type="string" required>

指定事件的名称。

</Parameter>
<Parameter name="listener" type="Function" required>

监听事件时传入的回调函数。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="on"></a>

### on [#on]

#### on [1/3] [#on-13]

<ApiSignature>

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

</ApiSignature>

Overrides EventEmitter.on

<ParameterList title="Parameters">
<Parameter name="event" type="&quot;track-updated&quot;" required>

事件名称。

</Parameter>
<Parameter name="listener" type="typeof event_track_updated" required>

详见 [track-updated](/zh-CN/api-reference/rtc/react-sdk/web-sdk/globals#event_track_updated)。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

#### on [2/3] [#on-23]

<ApiSignature>

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

</ApiSignature>

Overrides EventEmitter.on

<ParameterList title="Parameters">
<Parameter name="event" type="&quot;track-ended&quot;" required>

事件名称。

</Parameter>
<Parameter name="listener" type="typeof event_track_ended" required>

详见 [track-ended](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#event_track_ended)。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

#### on [3/3] [#on-33]

<ApiSignature>

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

</ApiSignature>

Overrides EventEmitter.on

添加事件监听器。

<ParameterList title="Parameters">
<Parameter name="event" type="&quot;transceiver-updated&quot;" required>

事件名称。

</Parameter>
<Parameter name="listener" type="typeof event_transceiver_updated" required>

详见 [ILocalTrack.transceiver-updated](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#event_transceiver_updated)。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="once"></a>

### once [#once]

<ApiSignature>

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

</ApiSignature>

Inherited from EventEmitter.once

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

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

<ParameterList title="Parameters">
<Parameter name="event" type="string" required>

指定事件的名称。

</Parameter>
<Parameter name="listener" type="Function" required>

传入的回调函数。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="play"></a>

### play [#play]

<ApiSignature>

play(element?: string | HTMLElement): void

</ApiSignature>

Inherited from [ILocalTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack).[play](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#play)

在页面上播放媒体轨道。

<ParameterList title="Parameters">
<Parameter name="element" type="string | HTMLElement" optional>

指定一个 DOM 元素，SDK 将在这个元素下创建 `<video>` 元素播放视频轨道，支持 2 种类型：

- `string`: 指定该 DOM 元素的 ID 值。
- `HTMLElement`: 直接传入一个 DOM 元素对象。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="removealllisteners"></a>

### removeAllListeners [#removealllisteners]

<ApiSignature>

removeAllListeners(event?: string): void

</ApiSignature>

Inherited from EventEmitter.removeAllListeners

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

<ParameterList title="Parameters">
<Parameter name="event" type="string" optional>

指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>

<a id="setenabled"></a>

### setEnabled [#setenabled]

<ApiSignature>

setEnabled(enabled: boolean): Promise&lt;void&gt;

</ApiSignature>

:::info[自从]
*4.0.0*

启用/禁用该轨道。

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

> - 禁用轨道不会触发 [LocalTrack.on("track-ended")](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#event_track_ended) 事件。
> - 如果该轨道已发布，禁用轨道后，远端会触发 [user-unpublished](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#event_user_unpublished) 事件。重新启用后，远端会触发 [user-published](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#event_user_published) 事件。
> - `setEnabled` 和 `setMuted` 不能同时调用。
:::

<ParameterList title="Parameters">
<Parameter name="enabled" type="boolean" required>

是否启用该轨道:

- `true`: 启用该轨道。
- `false`: 禁用该轨道。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

Promise&lt;void&gt;

</ApiReturnType>

</ApiReturns>

<a id="setmuted"></a>

### setMuted [#setmuted]

<ApiSignature>

setMuted(muted: boolean): Promise&lt;void&gt;

</ApiSignature>

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

:::info[自从]
*4.6.0*

如果该轨道已发布，调用 `setMuted(true)` 后，远端会触发 [user-unpublished](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#event_user_unpublished) 事件。再调用 `setMuted(false)` 后，远端会触发 [user-published](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/iagorartcclient#event_user_published) 事件。

> - 与 [setEnabled](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ilocaltrack#setenabled) 相比，调用该方法响应速度更快且不影响视频采集状态，详见 [setEnabled 和 setMuted 有什么区别？](/zh-CN/reference/faq/integration/set_enabled_set_muted)。
> - `setEnabled` 和 `setMuted` 不能同时调用。
:::

<ParameterList title="Parameters">
<Parameter name="muted" type="boolean" required>

是否发送该轨道的媒体数据:

- `true`: 暂停发送该轨道的媒体数据。
- `false`: 恢复发送该轨道的媒体数据。

</Parameter>
</ParameterList>

<ApiReturns>

<ApiReturnType>

Promise&lt;void&gt;

</ApiReturnType>

</ApiReturns>

<a id="stop"></a>

### stop [#stop]

<ApiSignature>

stop(): void

</ApiSignature>

Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack).[stop](/zh-CN/api-reference/rtc/react-sdk/web-sdk/interfaces/ibuffersourceaudiotrack#stop)

停止播放。

<ApiReturns>

<ApiReturnType>

void

</ApiReturnType>

</ApiReturns>