BrowserRTC4Chime | 如视 Live SDK

amazon-chime-sdk-js 适配的rtc实现

Hierarchy

CoreRTC
- BrowserRTC4Chime

Index

Constructors

constructor

new BrowserRTC4Chime(options: { getVoiceSign: GetVoiceSign; logLevel?: LogLevel }): BrowserRTC4Chime

Overrides CoreRTC.constructor
- Defined in rtc/BrowserRTC4Chime.ts:45
Parameters
- options: { getVoiceSign: GetVoiceSign; logLevel?: LogLevel }
  - getVoiceSign: GetVoiceSign
  - Optional logLevel?: LogLevel
Returns BrowserRTC4Chime

Properties

Private $audio

$audio: HTMLAudioElement = ...

Private $dom

$dom: HTMLDivElement = ...

Private _getVoiceSign

_getVoiceSign: GetVoiceSign = ...

audioInput

audioInput: undefined | MediaDeviceInfo

audioOutput

audioOutput: undefined | MediaDeviceInfo

audioVideoObserver

audioVideoObserver: default = {}

deviceChangeObserver

deviceChangeObserver: default = {}

deviceController

deviceController: default

joined

joined: boolean = false

是否已经加入房间

logger

logger: default

meetingSession

meetingSession: undefined | default

micro

micro: boolean = false

麦克风状态

type

type: RTCType = RTCType.RealseeBrowserChimeRTC

rtc 实现类型

userId

userId: string = ''

voiceId

voiceId: string = ''

语音房间ID

Methods

_initDom

_initDom(): void

- Defined in rtc/BrowserRTC4Chime.ts:61
对audio标签初始化

Returns void

_registerRtcEvent

_registerRtcEvent(): void

- Defined in rtc/BrowserRTC4Chime.ts:225
注册rtc事件

Returns void

detectMicro

detectMicro(): Promise<boolean>

Overrides CoreRTC.detectMicro
- Defined in rtc/BrowserRTC4Chime.ts:332
监测麦克风授权。

Returns Promise<boolean>

emit

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

Inherited from CoreRTC.emit
- Defined in utils/subscribe.ts:122
触发事件

Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<RTCEventType[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

hasListener

hasListener(name: keyof RTCEventType): boolean

Inherited from CoreRTC.hasListener
- Defined in utils/subscribe.ts:43
判断是否注册了事件

Parameters
- name: keyof RTCEventType
  
  事件类型
Returns boolean

initObservers

initObservers(): void

- Defined in rtc/BrowserRTC4Chime.ts:71
初始化事件监听器

Returns void

join

join(options: { roomId: undefined | string | number; type: RTCType; userId: string; voiceId: string }): Promise<boolean>

Overrides CoreRTC.join
- Defined in rtc/BrowserRTC4Chime.ts:127
加入语音会议

Parameters
- options: { roomId: undefined | string | number; type: RTCType; userId: string; voiceId: string }
  - roomId: undefined | string | number
  - type: RTCType
  - userId: string
  - voiceId: string
Returns Promise<boolean>

off

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

Inherited from CoreRTC.off
- Defined in utils/subscribe.ts:92
解除事件

如果 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

on

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

Inherited from CoreRTC.on
- Defined in utils/subscribe.ts:57
注册事件

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 void
    解除事件

once

once<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): (() => void)

Inherited from CoreRTC.once
- Defined in utils/subscribe.ts:76
注册事件(是否只执行一次)

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 void
    解除事件

quit

quit(): Promise<boolean>

Overrides CoreRTC.quit
- Defined in rtc/BrowserRTC4Chime.ts:305
离开房间。

Returns Promise<boolean>

shock

shock(): void

Overrides CoreRTC.shock
- Defined in rtc/BrowserRTC4Chime.ts:361
震动。

Returns void

toggleMicro

toggleMicro(flag?: boolean): Promise<boolean>

Overrides CoreRTC.toggleMicro
- Defined in rtc/BrowserRTC4Chime.ts:347
关闭\开启本地麦克风。

Parameters
- Optional flag: boolean
Returns Promise<boolean>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: { getVoiceSign: GetVoiceSign; logLevel?: LogLevel }

getVoiceSign: GetVoiceSign

Optional logLevel?: LogLevel

Returns BrowserRTC4Chime

Properties

Private $audio

Private $dom

Private _getVoiceSign

audioInput

audioOutput

audioVideoObserver

deviceChangeObserver

deviceController

joined

logger

meetingSession

micro

type

userId

voiceId

Methods

_initDom

Returns void

_registerRtcEvent

Returns void

detectMicro

Returns Promise<boolean>

emit

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

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

Returns boolean

hasListener

Parameters

name: keyof RTCEventType

Returns boolean

initObservers

Returns void

join

Parameters

options: { roomId: undefined | string | number; type: RTCType; userId: string; voiceId: string }

roomId: undefined | string | number

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]>

Returns ReturnType<RTCEventType[K]>

Returns void

on

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

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

Parameters

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

Returns ReturnType<RTCEventType[K]>

Optional once: boolean

Returns (() => void)

Returns void

once

Type Parameters