Class LocalStream

Hierarchy

Stream
- LocalStream

Index

Constructors

constructor

new LocalStream(): LocalStream
Returns LocalStream
Overrides Stream.constructor
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:18

Properties

hasAudio

hasAudio: boolean = false

hasVideo

hasVideo: boolean = false

id

id: string

topics

topics: Record<"trackChanged", ITopic<any>[]> = ...

Methods

closeAudio

closeAudio(): void
Returns void
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:150

closeVideo

closeVideo(): void
Returns void
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:122

create

create(config): Promise<void>
Parameters
- config: CreateLocalStreamConfig
Returns Promise<void>
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:22

dispose

dispose(): void
移除所有的监听事件

Returns void
Inherited from Stream.dispose
- Defined in packages/core/src/misc/emitter.ts:142

getMediaStream

getMediaStream(): MediaStream
Returns MediaStream
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:167

getTrack

getTrack(kind): MediaStreamTrack
Parameters
- kind: "audio" | "video"
Returns MediaStreamTrack
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:171

getTracks

getTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:184

isAudioPaused

isAudioPaused(): boolean
Returns boolean
Inherited from Stream.isAudioPaused
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:20

isVideoPaused

isVideoPaused(): boolean
Returns boolean
Inherited from Stream.isVideoPaused
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:16

mute

mute(): void
Returns void
Inherited from Stream.mute
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:34

muteAudio

muteAudio(): void
Returns void
Inherited from Stream.muteAudio
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:82

muteVideo

muteVideo(): void
Returns void
Inherited from Stream.muteVideo
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:74

off

off<K>(topic, listener?): void
移除监听事件
Type Parameters
- K extends "trackChanged"
Parameters
- topic: K
- Optional listener: IListener<IStreamEvent[K]>
Returns void
Inherited from Stream.off
- Defined in packages/core/src/misc/emitter.ts:84

on

on<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器
Type Parameters
- K extends "trackChanged"
Parameters
- topic: K
- listener: IListener<IStreamEvent[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from Stream.on
- Defined in packages/core/src/misc/emitter.ts:35

once

once<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器，单个 listener 只执行1次
Type Parameters
- K extends "trackChanged"
Parameters
- topic: K
- listener: IListener<IStreamEvent[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from Stream.once
- Defined in packages/core/src/misc/emitter.ts:46

openAudio

openAudio(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:133

openVideo

openVideo(videoConstraints?): Promise<void>
Parameters
- Optional videoConstraints: MediaTrackConstraints
Returns Promise<void>
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:105

pause

pause(): void
Returns void
Inherited from Stream.pause
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:24

pauseAudio

pauseAudio(): void
Returns void
Inherited from Stream.pauseAudio
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:58

pauseVideo

pauseVideo(): void
Returns void
Inherited from Stream.pauseVideo
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:42

resume

resume(): void
Returns void
Inherited from Stream.resume
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:29

resumeAudio

resumeAudio(): void
Returns void
Inherited from Stream.resumeAudio
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:66

resumeVideo

resumeVideo(): void
Returns void
Inherited from Stream.resumeVideo
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:50

stop

stop(): void
Returns void
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:160

switchToCamera

switchToCamera(targetCamera): Promise<void>
Parameters
- targetCamera: MediaDeviceInfo | "front" | "back"
Returns Promise<void>
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/local-stream.ts:188

unmute

unmute(): void
Returns void
Inherited from Stream.unmute
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:38

unmuteAudio

unmuteAudio(): void
Returns void
Inherited from Stream.unmuteAudio
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:86

unmuteVideo

unmuteVideo(): void
Returns void
Inherited from Stream.unmuteVideo
- Defined in packages/core/src/network/transport/xrtc/webrtc/calls/stream.ts:78

Generated using TypeDoc