Class BrowserRTC

rtc 基础抽象类

Hierarchy

CoreRTC
- BrowserRTC

Index

Constructors

constructor

new BrowserRTC(options: {
    autoPlayConfirm?: ((opts: {
        onConfirm: (() => void);
    }) => void);
    getVoiceSign: GetVoiceSign;
}): BrowserRTC
Parameters
- options: {
      autoPlayConfirm?: ((opts: {
          onConfirm: (() => void);
      }) => void);
      getVoiceSign: GetVoiceSign;
  }
  - Optional autoPlayConfirm?: ((opts: {
    onConfirm: (() => void);
    }) => void)
    - (opts: {
      onConfirm: (() => void);
      }): void
      
      Parameters
      
      opts: {
      onConfirm: (() => void);
      }
      
      onConfirm: (() => void)
      
      (): void
      
      Returns void
      
      Returns void
  - getVoiceSign: GetVoiceSign
Returns BrowserRTC
Overrides CoreRTC.constructor
- Defined in rtc/BrowserRTC.ts:37

Properties

`Private` $dom

$dom: HTMLDivElement = ...

`Private` _autoPlayConfirm

_autoPlayConfirm: ((opts: {
onConfirm: (() => void);
}) => undefined | void)

Type declaration

- (opts: {
  onConfirm: (() => void);
  }): undefined | void
- Parameters
  - opts: {
    onConfirm: (() => void);
    }
    - onConfirm: (() => void)
      
      (): void
      
      Returns void
  Returns undefined | void

`Private` _getVoiceSign

_getVoiceSign: GetVoiceSign = ...

`Private` _trtc

_trtc: ITrtcInstance = ...

joined

joined: boolean = false

是否已经加入房间

micro

micro: boolean = false

麦克风状态

type

type: RTCType = RTCType.RealseeBrowserRTC

rtc 实现类型

voiceId

voiceId: string = ''

语音房间ID

Methods

`Private` _handleStreamAdded

_handleStreamAdded(event: any): void
Parameters
- event: any
Returns void
- Defined in rtc/BrowserRTC.ts:184

`Private` _handleStreamSubscribed

_handleStreamSubscribed(event: any): void
Parameters
- event: any
Returns void
- Defined in rtc/BrowserRTC.ts:191

`Private` _initParentDom

_initParentDom(): void
Returns void
- Defined in rtc/BrowserRTC.ts:48

`Private` _registerRtcEvent

_registerRtcEvent(): void
Returns void
- Defined in rtc/BrowserRTC.ts:169

checkRequirement

checkRequirement(): Promise<CheckResult>
Returns Promise<CheckResult>
- Defined in rtc/BrowserRTC.ts:28

detectMicro

detectMicro(): Promise<boolean>
监测麦克风授权。

Returns

Returns Promise<boolean>
Overrides CoreRTC.detectMicro
- Defined in rtc/BrowserRTC.ts:139

emit

emit<K>(name: K, ...data: Parameters<RTCEventType[K]>): boolean
触发事件

Returns
canceled 是否被触发取消
Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<RTCEventType[K]>
  
  触发事件的数据
Returns boolean
Inherited from CoreRTC.emit
- Defined in utils/subscribe.ts:122

hasListener

hasListener(name: keyof RTCEventType): boolean
判断是否注册了事件
Parameters
- name: keyof RTCEventType
  
  事件类型
Returns boolean
Inherited from CoreRTC.hasListener
- Defined in utils/subscribe.ts:43

join

join(options: {
    roomId: string;
    type: RTCType;
    userId: string;
    voiceId: string;
}): Promise<boolean>
加入房间。

Returns
Parameters
- options: {
      roomId: string;
      type: RTCType;
      userId: string;
      voiceId: string;
  }
  - roomId: string
  - type: RTCType
  - userId: string
  - voiceId: string
Returns Promise<boolean>
Overrides CoreRTC.join
- Defined in rtc/BrowserRTC.ts:54

off

off<K>(name?: K, callback?: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): void
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      
      Rest ...args: Parameters<RTCEventType[K]>
      
      Returns ReturnType<RTCEventType[K]>
Returns void
Inherited from CoreRTC.off
- Defined in utils/subscribe.ts:92

on

on<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>), once?: boolean): (() => void)
注册事件

Returns
解除事件
Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      
      Rest ...args: Parameters<RTCEventType[K]>
      
      Returns ReturnType<RTCEventType[K]>
- Optional once: boolean
  
  是否只执行一次
Returns (() => void)
- - (): void
  - 注册事件
    
    Returns
    解除事件
    
    Returns void
Inherited from CoreRTC.on
- Defined in utils/subscribe.ts:57

once

once<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): (() => void)
注册事件(是否只执行一次)

Returns
解除事件
Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      
      Rest ...args: Parameters<RTCEventType[K]>
      
      Returns ReturnType<RTCEventType[K]>
Returns (() => void)
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns
    解除事件
    
    Returns void
Inherited from CoreRTC.once
- Defined in utils/subscribe.ts:76

quit

quit(): Promise<boolean>
离开房间。

Returns

Returns Promise<boolean>
Overrides CoreRTC.quit
- Defined in rtc/BrowserRTC.ts:121

shock

shock(): void
震动。

Returns void
Overrides CoreRTC.shock
- Defined in rtc/BrowserRTC.ts:165

toggleMicro

toggleMicro(flag?: boolean): Promise<boolean>
关闭\开启本地麦克风。
Parameters
- Optional flag: boolean
Returns Promise<boolean>
Overrides CoreRTC.toggleMicro
- Defined in rtc/BrowserRTC.ts:157

Class BrowserRTC

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: { autoPlayConfirm?: ((opts: { onConfirm: (() => void); }) => void); getVoiceSign: GetVoiceSign; }

Optional autoPlayConfirm?: ((opts: { onConfirm: (() => void); }) => void)

Parameters

opts: { onConfirm: (() => void); }

onConfirm: (() => void)

Returns void

Returns void

getVoiceSign: GetVoiceSign

Returns BrowserRTC

Properties

Private $dom

Private _autoPlayConfirm

Type declaration

Parameters

opts: { onConfirm: (() => void); }

onConfirm: (() => void)

Returns void

Returns undefined | void

Private _getVoiceSign

Private _trtc

joined

micro

type

voiceId

Methods

Private _handleStreamAdded

Parameters

event: any

Returns void

Private _handleStreamSubscribed

Parameters

event: any

Returns void

Private _initParentDom

Returns void

Private _registerRtcEvent

Returns void

checkRequirement

Returns Promise<CheckResult>

detectMicro

Returns

Returns Promise<boolean>

emit

Returns

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

Rest ...data: Parameters<RTCEventType[K]>

Returns boolean

hasListener

Parameters

name: keyof RTCEventType

Returns boolean

join

Returns

Parameters

options: { roomId: string; type: RTCType; userId: string; voiceId: string; }

roomId: string

type: RTCType

userId: string

voiceId: string

Returns Promise<boolean>

off

Type Parameters

K extends keyof RTCEventType

Parameters

Optional name: K

Optional callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

Parameters

Rest ...args: Parameters<RTCEventType[K]>

options: {
autoPlayConfirm?: ((opts: {
onConfirm: (() => void);
}) => void);
getVoiceSign: GetVoiceSign;
}

`Optional` autoPlayConfirm?: ((opts: {
onConfirm: (() => void);
}) => void)

opts: {
onConfirm: (() => void);
}

`Private` $dom

`Private` _autoPlayConfirm

opts: {
onConfirm: (() => void);
}

`Private` _getVoiceSign

`Private` _trtc

`Private` _handleStreamAdded

`Private` _handleStreamSubscribed

`Private` _initParentDom

`Private` _registerRtcEvent

`Rest` ...data: Parameters<RTCEventType[K]>

options: {
roomId: string;
type: RTCType;
userId: string;
voiceId: string;
}

`Optional` name: K

`Optional` callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

`Rest` ...args: Parameters<RTCEventType[K]>

`Rest` ...args: Parameters<RTCEventType[K]>

`Optional` once: boolean

`Rest` ...args: Parameters<RTCEventType[K]>

`Optional` flag: boolean