Class InnerWebMediaDevices

Hierarchy

Reportable
- InnerWebMediaDevices

Constructors

constructor

new InnerWebMediaDevices(): InnerWebMediaDevices

Overrides Reportable.constructor
Returns InnerWebMediaDevices

Properties

Readonly __constructorName

__constructorName: string

_state

_state: IMediaDevicesState

hasAudioInputDevice

hasAudioInputDevice: boolean

hasAudioOutputDevice

hasAudioOutputDevice: boolean

hasVideoInputDevice

hasVideoInputDevice: boolean

listenerMap

listenerMap: Record<EventTargetType, IEventListenerObject[]>

Readonly reporter

reporter: Reporter

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Static IGNORE_FUNCTION_MEMBER

IGNORE_FUNCTION_MEMBER: PropertyKey[]

Static reporterManager

reporterManager: ReporterManager

Accessors

audioInputList

get audioInputList(): IMediaDeviceInfo[]

Returns IMediaDeviceInfo[]

audioOutputList

get audioOutputList(): IMediaDeviceInfo[]

Returns IMediaDeviceInfo[]

previousStreamInfo

get previousStreamInfo(): { audio: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack }; stream?: MediaStream; video: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack } }

Returns { audio: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack }; stream?: MediaStream; video: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack } }
- audio: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack }
  - Optional constraints?: boolean | MediaTrackConstraints
  - Optional track?: MediaStreamTrack
- Optional stream?: MediaStream
- video: { constraints?: boolean | MediaTrackConstraints; track?: MediaStreamTrack }
  - Optional constraints?: boolean | MediaTrackConstraints
  - Optional track?: MediaStreamTrack

state

get state(): IMediaDevicesState
set state(state: IMediaDevicesState): void

Returns IMediaDevicesState
Parameters
- state: IMediaDevicesState
Returns void

videoInputList

get videoInputList(): IMediaDeviceInfo[]

Returns IMediaDeviceInfo[]

Methods

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from Reportable.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 添加事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

addEventListeners

addEventListeners(types: EventTargetType[], func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from Reportable.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: EventTargetType[]
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
  设置监听器参数
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 对多个事件添加同一个事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

clearListener

clearListener(): void

Inherited from Reportable.clearListener

清空所有绑定的事件

Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from Reportable.dispatchEvent

分发事件

Parameters
- event: Event
  分发的事件对象
Returns boolean
事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): boolean

Inherited from Reportable.dispatchEventLite

简化的dispatchEvent接口

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
  具体错误类型, 此时 dispatchEventLite的 type 应是一个 xxxEventType.Error 类型
Returns boolean

hasListener

hasListener(type: EventTargetType): boolean

Inherited from Reportable.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

refresh

refresh(): Promise<InnerWebMediaDevices>

Returns Promise<InnerWebMediaDevices>

releaseUserMedia

releaseUserMedia(): boolean

Returns boolean

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from Reportable.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  要移除的事件监听器类型
- func: EventListenerType
  要移除的事件监听器
Returns boolean
返回 true 表示移除成功

requestUserMedia

requestUserMedia(constraints: { audio: boolean | Partial<IMediaDevicesConstraints>; video: boolean | Partial<IMediaDevicesConstraints> }): Promise<MediaStream>

Parameters
- constraints: { audio: boolean | Partial<IMediaDevicesConstraints>; video: boolean | Partial<IMediaDevicesConstraints> }
  - audio: boolean | Partial<IMediaDevicesConstraints>
  - video: boolean | Partial<IMediaDevicesConstraints>
Returns Promise<MediaStream>

requestUserMediaLite

requestUserMediaLite(size?: SimpleCameraResolution, facingMode?: "user" | "environment"): Promise<MediaStream>

Parameters
- Optional size: SimpleCameraResolution
- Optional facingMode: "user" | "environment"
Returns Promise<MediaStream>

toString

toString(): string

Inherited from Reportable.toString
Returns string

Generated using TypeDoc