Class Transport

网络传输控制中心。负责 RTC 连接和数据传输的建立和管理

Hierarchy (view full)

EventEmitter<ITransportEventMap>
- Transport

Constructors

constructor

new Transport(options, world): Transport
Parameters
- options: ITransportOptions
- world: World
Returns Transport
Overrides EventEmitter.constructor
- Defined in packages/core/src/network/transport/transport.ts:176

Properties

`Optional` calls

calls?: default

rtcMode

rtcMode: ERTCMode = ERTCMode.Xrtc

rtcUpdated

rtcUpdated: boolean = false

schedule

schedule: Schedule

新的调度流程

`Optional` scheduleRes

scheduleRes?: IWsUrlResponse

调度信息

signal

signal: Signal

streamingVideo

streamingVideo: HTMLVideoElement

流相关

topics

topics: Record<keyof ITransportEventMap, ITopic<any>[]> = ...

world

world: World

wt

wt: default

wtMessageChannel

wtMessageChannel: MessageChannel

wtXmitoptions

wtXmitoptions: XmitNewClientOptions

xmitAvailable

xmitAvailable: boolean = true

xrtc

xrtc: default

xrtc 链路：需要提前创建，获取信令协商用的信息 wt 链路：不需要准备协商信息，从后台拿到协商信息后直接建连 calls 链路：通话链路在业务有需求的时候再创建

xrtcMessageChannel

xrtcMessageChannel: MessageChannel

xrtcXmitOptions

xrtcXmitOptions: XmitNewClientOptions

Methods

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/network/transport/transport.ts:463

createLocalStream

createLocalStream(config): Promise<LocalStream>
Parameters
- config: CreateLocalStreamConfig
Returns Promise<LocalStream>
- Defined in packages/core/src/network/transport/transport.ts:621

destroyCalls

destroyCalls(): void
Returns void
- Defined in packages/core/src/network/transport/transport.ts:615

disconnect

disconnect(withNotify?): void
主动断开链接
Parameters
- withNotify: boolean = true
Returns void
- Defined in packages/core/src/network/transport/transport.ts:518

dispose

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

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

forcePlay

forcePlay(): void
Returns void
- Defined in packages/core/src/network/transport/transport.ts:402

getAllCallsStreamVolume

getAllCallsStreamVolume(): undefined | Record<string, number>
Returns undefined | Record<string, number>
- Defined in packages/core/src/network/transport/transport.ts:654

getScheduledUrl

getScheduledUrl(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/network/transport/transport.ts:435

getServerSession

getServerSession(): string
Returns string
- Defined in packages/core/src/network/transport/transport.ts:420

getState

getState(): ITransportState
返回网络状态

Returns ITransportState
- Defined in packages/core/src/network/transport/transport.ts:431

getStreamVideo

getStreamVideo(id?, ve?): undefined | HTMLVideoElement
Parameters
- id: string = STREAM_VIDEO_ID
- Optional ve: HTMLVideoElement
Returns undefined | HTMLVideoElement
- Defined in packages/core/src/network/transport/transport.ts:683

hasReceivedFrame

hasReceivedFrame(): boolean
Returns boolean
- Defined in packages/core/src/network/transport/transport.ts:557

initCalls

initCalls(): Promise<void>
通话建连，在业务层进语音房后调用

Returns Promise<void>
- Defined in packages/core/src/network/transport/transport.ts:588

keepAliveTick

keepAliveTick(): void
Returns void
- Defined in packages/core/src/network/transport/transport.ts:659

notifyRecvdFrame

notifyRecvdFrame(): void
Returns void
- Defined in packages/core/src/network/transport/transport.ts:549

off

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

on

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

onBweInfo

onBweInfo(bweKbps): void
Parameters
- bweKbps: number
Returns void
- Defined in packages/core/src/network/transport/transport.ts:690

onFrame

onFrame(): void
enterWorld resolve的时候调用这个,表示收到第一帧了外部高频tick,不能做很多逻辑 onlyForMc

Returns void
- Defined in packages/core/src/network/transport/transport.ts:576

onNop

onNop(deSerializeFailedCnt): void
Parameters
- deSerializeFailedCnt: number
Returns void
- Defined in packages/core/src/network/transport/transport.ts:581

once

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

publishStream

publishStream(stream): Promise<void>
Parameters
- stream: LocalStream
Returns Promise<void>
- Defined in packages/core/src/network/transport/transport.ts:625

reconnect

reconnect(): Promise<void>
外部重连

Returns Promise<void>
- Defined in packages/core/src/network/transport/transport.ts:501

resetConnection

resetConnection(): void
transport 重置连接

Returns void
- Defined in packages/core/src/network/transport/transport.ts:450

send

send(data): void
Parameters
- data: string
Returns void
- Defined in packages/core/src/network/transport/transport.ts:533

sendSignal

sendSignal(signal, subSignal, data): void
Parameters
- signal: SignalType
- subSignal: Sdp | AudioTrack | Fir | CallsChannelSetup | CallsChannelStatus | DumpSourceData | ConnectionClose | ConnectionShutDown | ConnectionChannel | ConnectionStatus
- data: Uint8Array
Returns void
- Defined in packages/core/src/network/transport/transport.ts:541

setServerSession

setServerSession(sessionId): void
Parameters
- sessionId: string
Returns void
- Defined in packages/core/src/network/transport/transport.ts:424

stopKeepAliveTick

stopKeepAliveTick(): void
Returns void
- Defined in packages/core/src/network/transport/transport.ts:675

unpublishStream

unpublishStream(stream): void
Parameters
- stream: LocalStream
Returns void
- Defined in packages/core/src/network/transport/transport.ts:638

updateRoomMembers

updateRoomMembers(members): void
Parameters
- members: IRoomMember[]
Returns void
- Defined in packages/core/src/network/transport/transport.ts:650

updateRtcMode

updateRtcMode(mode): void
Parameters
- mode: ERTCMode
Returns void
- Defined in packages/core/src/network/transport/transport.ts:389

Class Transport

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ITransportOptions

world: World

Returns Transport

Properties

Optional calls

rtcMode

rtcUpdated

schedule

Optional scheduleRes

signal

streamingVideo

topics

world

wt

wtMessageChannel

wtXmitoptions

xmitAvailable

xrtc

xrtcMessageChannel

xrtcXmitOptions

Methods

connect

Returns Promise<void>

createLocalStream

Parameters

config: CreateLocalStreamConfig

Returns Promise<LocalStream>

destroyCalls

Returns void

disconnect

Parameters

withNotify: boolean = true

Returns void

dispose

Returns void

forcePlay

Returns void

getAllCallsStreamVolume

Returns undefined | Record<string, number>

getScheduledUrl

Returns Promise<void>

getServerSession

Returns string

getState

Returns ITransportState

getStreamVideo

Parameters

id: string = STREAM_VIDEO_ID

Optional ve: HTMLVideoElement

Returns undefined | HTMLVideoElement

hasReceivedFrame

Returns boolean

initCalls

Returns Promise<void>

keepAliveTick

Returns void

notifyRecvdFrame

Returns void

off

Type Parameters

K extends keyof ITransportEventMap

Parameters

topic: K

Optional listener: IListener<ITransportEventMap[K]>

Returns void

on

Type Parameters

K extends keyof ITransportEventMap

Parameters

topic: K

listener: IListener<ITransportEventMap[K]>

`Optional` calls

`Optional` scheduleRes

`Optional` ve: HTMLVideoElement

`Optional` listener: IListener<ITransportEventMap[K]>

`Optional` order: number

Returns {
unsub: (() => void);
}

`Optional` order: number

Returns {
unsub: (() => void);
}