API Reference for web - Class: LocalTrack

更新时间: 2023-10-23 16:45:52

# Class: LocalTrack

track/LocalTrack.LocalTrack

# Hierarchy

Track

↳ LocalTrack

↳↳ LocalVideoTrack

↳↳ LocalAudioTrack

# Properties

# defaultMaxListeners

Static defaultMaxListeners: number

# Inherited from

Track.defaultMaxListeners

# errorMonitor

Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

# Inherited from

Track.errorMonitor

# Accessors

# enabled

get enabled(): boolean

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

# Returns

boolean

# Inherited from

Track.enabled

# muted

get muted(): boolean

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

# Returns

boolean

# Methods

# addListener

addListener(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.addListener

# close

close(): void

关闭本地轨道，并释放相关采集设备。一旦本地轨道被关闭，就无法再次使用。如需再次使用本地轨道，需要重新创建。

# Returns

void

# Overrides

Track.close

# emit

emit(event, ...args): boolean

# Parameters

Name	Type
`event`	`string` \| `symbol`
`...args`	`any`[]

# Returns

boolean

# Inherited from

Track.emit

# eventNames

eventNames(): (string | symbol)[]

# Returns

(string | symbol)[]

# Inherited from

Track.eventNames

# getListeners

getListeners(event): Function[]

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

# Parameters

Name	Type	Description
`event`	`string`	事件名称。

# Returns

Function[]

# Inherited from

Track.getListeners

# getMaxListeners

getMaxListeners(): number

# Returns

number

# Inherited from

Track.getMaxListeners

# getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

获取浏览器原生的 MediaStreamTrack (opens new window) 对象。

# Returns

MediaStreamTrack

# Inherited from

Track.getMediaStreamTrack

# getTrackId

getTrackId(): string

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

# Returns

string

媒体轨道 ID。

# Inherited from

Track.getTrackId

# getTrackLabel

getTrackLabel(): undefined | string

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

# Returns

undefined | string

可能返回以下值：

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

# Inherited from

Track.getTrackLabel

# listenerCount

listenerCount(event): number

# Parameters

Name	Type
`event`	`string` \| `symbol`

# Returns

number

# Inherited from

Track.listenerCount

# listeners

listeners(event): Function[]

# Parameters

Name	Type
`event`	`string` \| `symbol`

# Returns

Function[]

# Inherited from

Track.listeners

# off

off(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.off

# once

once(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.once

# prependListener

prependListener(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.prependListener

# prependOnceListener

prependOnceListener(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.prependOnceListener

# rawListeners

rawListeners(event): Function[]

# Parameters

Name	Type
`event`	`string` \| `symbol`

# Returns

Function[]

# Inherited from

Track.rawListeners

# removeAllListeners

removeAllListeners(event?): LocalTrack

# Parameters

Name	Type
`event?`	`string` \| `symbol`

# Returns

LocalTrack

# Inherited from

Track.removeAllListeners

# removeListener

removeListener(event, listener): LocalTrack

# Parameters

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

# Returns

LocalTrack

# Inherited from

Track.removeListener

# safeEmit

safeEmit(event, ...args): boolean

# Parameters

Name	Type
`event`	`string`
`...args`	`any`[]

# Returns

boolean

# Inherited from

Track.safeEmit

# safeEmitAsPromise

safeEmitAsPromise(event, ...args): Promise<any>

# Parameters

Name	Type
`event`	`string`
`...args`	`any`[]

# Returns

Promise<any>

# Inherited from

Track.safeEmitAsPromise

# setMaxListeners

setMaxListeners(n): LocalTrack

# Parameters

Name	Type
`n`	`number`

# Returns

LocalTrack

# Inherited from

Track.setMaxListeners

# listenerCount

Static listenerCount(emitter, event): number

deprecated since v4.0.0

# Parameters

Name	Type
`emitter`	`EventEmitter`
`event`	`string` \| `symbol`

# Returns

number

# Inherited from

Track.listenerCount