# Interface ILocalTrack (/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## Events [#events]
### track-ended [#track-ended]
track-ended(): void
音频或视频轨道被终止,终止的原因可能是:
- 摄像头被拔出
- 麦克风被拔出
- 用户主动停止了屏幕共享
- 用户主动关闭了底层的 `MediaStreamTrack`
- 媒体设备故障
- 正在使用中的媒体设备的权限被收回
void
### transceiver-updated [#transceiver-updated]
transceiver-updated(transceiver: RTCRtpTransceiver, type?: [StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)): void
当前轨道的 `RTCRtpTransceiver` 实例更新回调。
新的 `RTCRtpTransceiver` 实例。
[StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)
当前轨道所属视频流的类型。详见 [StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)。
void
## Properties [#properties]
### enabled [#enabled]
enabled: boolean
本地轨道当前的启用状态。
### isPlaying [#isplaying]
isPlaying: boolean
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[isPlaying](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack#isplaying)
媒体轨道是否正在页面上播放。
- `true`: 媒体轨道正在页面上播放。
- `false`: 媒体轨道没有在页面上播放。
### muted [#muted]
muted: boolean
本地媒体轨道当前的静音状态。
### trackMediaType [#trackmediatype]
trackMediaType: "audio"|"video"
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[trackMediaType](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack#trackmediatype)
媒体轨道的类型:
- `"audio"`: 音频轨道。
- `"video"`: 视频轨道。
## Methods [#methods]
### close [#close]
close(): void
关闭本地轨道,并释放相关采集设备。
一旦本地轨道被关闭,就无法再次使用。如需再次使用本地轨道,需要重新创建。
void
### getListeners [#getlisteners]
getListeners(event: string): Function[]
Inherited from EventEmitter.getListeners
指定一个事件名,获取当前所有监听这个事件的回调函数。
事件名称。
Function[]
### getMediaStreamTrack [#getmediastreamtrack]
getMediaStreamTrack(): MediaStreamTrack
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[getMediaStreamTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack#getmediastreamtrack)
获取浏览器原生的 [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) 对象。
MediaStreamTrack
一个 [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) 对象。
### getRTCRtpTransceiver [#getrtcrtptransceiver]
getRTCRtpTransceiver(type?: [StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)): RTCRtpTransceiver | undefined
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[getRTCRtpTransceiver](/zh-CN/api-reference/rtc/web/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)。
:::caution[注意]
如果 SDK 发生断线重连,当前轨道对应的 `RTCRtpTransceiver` 实例可能会发生变化。你可以通过以下回调来获取新的 `RTCRtpTransceiver` 实例:
- 本地轨道:[ILocalTrack.transceiver-updated](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#event_transceiver_updated)
- 远端轨道:[IRemoteTrack.transceiver-updated](/zh-CN/api-reference/rtc/web/interfaces/iremotetrack#event_transceiver_updated_2)
:::
[StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)
视频流的类型。详见 [StreamType](/zh-CN/api-reference/rtc/web/enums/streamtype)。
RTCRtpTransceiver | undefined
当前轨道的 `RTCRtpTransceiver` 实例。
### getStats [#getstats]
getStats(): [LocalVideoTrackStats](/zh-CN/api-reference/rtc/web/interfaces/localvideotrackstats) | [LocalAudioTrackStats](/zh-CN/api-reference/rtc/web/interfaces/localaudiotrackstats)
:::warning[deprecated]
自 v4.1.0 起废弃,请使用 [AgoraRTCClient.getLocalVideoStats](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#getlocalvideostats) 和 [AgoraRTCClient.getLocalAudioStats](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#getlocalaudiostats)。
获取本地轨道相关信息。
**注意事项**
获取本地视频轨道数据时,iOS 上无法获取到 `encodeDelay` 字段。
:::
[LocalVideoTrackStats](/zh-CN/api-reference/rtc/web/interfaces/localvideotrackstats) | [LocalAudioTrackStats](/zh-CN/api-reference/rtc/web/interfaces/localaudiotrackstats)
### getTrackId [#gettrackid]
getTrackId(): string
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[getTrackId](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack#gettrackid)
获取由 SDK 生成的对于媒体轨道来说的唯一 ID。
string
媒体轨道 ID。
### getTrackLabel [#gettracklabel]
getTrackLabel(): string
获取本地轨道的来源描述。
string
可能返回以下值:
- 如果是通过 `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) 字段。
### off [#off]
off(event: string, listener: Function): void
Inherited from EventEmitter.off
取消一个指定事件的监听。
指定事件的名称。
监听事件时传入的回调函数。
void
### on [#on]
#### on [1/3] [#on-13]
on(event: "track-updated", listener: typeof event_track_updated): void
Overrides EventEmitter.on
事件名称。
详见 [track-updated](/zh-CN/api-reference/rtc/web/globals#event_track_updated)。
void
#### on [2/3] [#on-23]
on(event: "track-ended", listener: typeof event_track_ended): void
Overrides EventEmitter.on
事件名称。
详见 [track-ended](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#event_track_ended)。
void
#### on [3/3] [#on-33]
on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void
Overrides EventEmitter.on
添加事件监听器。
事件名称。
详见 [ILocalTrack.transceiver-updated](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#event_transceiver_updated)。
void
### once [#once]
once(event: string, listener: Function): void
Inherited from EventEmitter.once
监听一个指定的事件,当事件触发时会调用传入的回调函数。
当监听后事件第一次触发时,该监听和回调函数就会被立刻移除,也就是只监听一次指定事件。
指定事件的名称。
传入的回调函数。
void
### play [#play]
play(element?: string | HTMLElement): void
Inherited from [ILocalTrack](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack).[play](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#play)
在页面上播放媒体轨道。
指定一个 DOM 元素,SDK 将在这个元素下创建 `
void
### removeAllListeners [#removealllisteners]
removeAllListeners(event?: string): void
Inherited from EventEmitter.removeAllListeners
指定一个事件,取消其所有的监听。
指定事件的名称,如果没有指定事件,则取消所有事件的所有监听。
void
### setEnabled [#setenabled]
setEnabled(enabled: boolean): Promise<void>
:::info[自从]
*4.0.0*
:::
启用/禁用该轨道。
轨道禁用后,播放和发布都将被停止。
:::caution[注意]
- 禁用轨道不会触发 [LocalTrack.on("track-ended")](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#event_track_ended) 事件。
- 如果该轨道已发布,禁用轨道后,远端会触发 [user-unpublished](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#event_user_unpublished) 事件。重新启用后,远端会触发 [user-published](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#event_user_published) 事件。
- `setEnabled` 和 `setMuted` 不能同时调用。
:::
是否启用该轨道:
- `true`: 启用该轨道。
- `false`: 禁用该轨道。
Promise<void>
### setMuted [#setmuted]
setMuted(muted: boolean): Promise<void>
发送或暂停发送该轨道的媒体数据。
:::info[自从]
*4.0.0*
:::
如果该轨道已发布,调用 `setMuted(true)` 后,远端会触发 [user-unpublished](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#event_user_unpublished) 事件。再调用 `setMuted(false)` 后,远端会触发 [user-published](/zh-CN/api-reference/rtc/web/interfaces/iagorartcclient#event_user_published) 事件。
:::caution[注意]
- 与 [setEnabled](/zh-CN/api-reference/rtc/web/interfaces/ilocaltrack#setenabled) 相比,调用该方法响应速度更快且不影响视频采集状态,详见 [setEnabled 和 setMuted 有什么区别?](/zh-CN/reference/faq/integration/set_enabled_set_muted)。
- `setEnabled` 和 `setMuted` 不能同时调用。
:::
是否发送该轨道的媒体数据:
- `true`: 暂停发送该轨道的媒体数据。
- `false`: 恢复发送该轨道的媒体数据。
Promise<void>
### stop [#stop]
stop(): void
Inherited from [IBufferSourceAudioTrack](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack).[stop](/zh-CN/api-reference/rtc/web/interfaces/ibuffersourceaudiotrack#stop)
停止播放。
void