Class NECall

Hierarchy

EventEmitter<NECallEvents>
- NECall

Constructors

constructor

new NECall(params: NECallConfig): NECall
Parameters
- params: NECallConfig
Returns NECall

Overrides EventEmitter<NECallEvents>.constructor

Properties

costTimeEventTracking

costTimeEventTracking: { callId: string; isCaller: boolean; needPush: boolean; rtcAudio: number; rtcCid: string; rtcJoin: number; rtcUid: string; rtcVideo: number; signalTimestamp: number; token: number; userAccId: string; userAction: number; wait: number } = ...

Type declaration

callId: string
isCaller: boolean
needPush: boolean
rtcAudio: number
rtcCid: string
rtcJoin: number
rtcUid: string
rtcVideo: number
signalTimestamp: number
token: number
userAccId: string
userAction: number
wait: number

rtcController

rtcController: RTCController

signalController

signalController: SignalController

`Static` prefixed

prefixed: string | boolean

Methods

accept

accept(params?: { callId?: string; enableOffline?: boolean }): Promise<{ callId: string; uid: string }>
接收呼叫
Parameters
- Optional params: { callId?: string; enableOffline?: boolean }
  - Optional callId?: string
    
    呼叫id，非必填
  - Optional enableOffline?: boolean
    
    是否接收离线消息;
Returns Promise<{ callId: string; uid: string }>

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void), context?: any): NECall
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)
  - - (...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
      
      Returns void
- Optional context: any
Returns NECall

Inherited from EventEmitter.addListener

call

call(params: SignalControllerCallParams): Promise<{ callId: string; uid: string }>
发起呼叫

Returns
Parameters
- params: SignalControllerCallParams
Returns Promise<{ callId: string; uid: string }>

destroy

destroy(): void
销毁

Returns void

emit

emit<T>(event: T, ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
Returns boolean

Inherited from EventEmitter.emit

enableLocalAudio

enableLocalAudio(enabled: boolean): Promise<void>
开关本地音频
Parameters
- enabled: boolean
  
  true: 开启； false: 关闭
Returns Promise<void>

enableLocalVideo

enableLocalVideo(enabled: boolean): Promise<void>
开关本地视频
Parameters
- enabled: boolean
  
  true: 开启； false: 关闭
Returns Promise<void>

eventNames

eventNames(): (keyof NECallEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof NECallEvents)[]

Inherited from EventEmitter.eventNames

getUidByAccId

getUidByAccId(accId: string): undefined | string
根据accId获取rtc uid
Parameters
- accId: string
  
  用户 im 的 accId
Returns undefined | string

hangup

hangup(params?: { callId?: string; enableOffline?: boolean; reason?: number }): Promise<void>
拒绝呼叫，包含主叫取消，被叫拒绝（reason: 3，主叫接受到繁忙），通话中挂断。
Parameters
- Optional params: { callId?: string; enableOffline?: boolean; reason?: number }
  - Optional callId?: string
    
    呼叫id
  - Optional enableOffline?: boolean
    
    是否接收离线消息
  - Optional reason?: number
    
    拒绝原因
Returns Promise<void>

initAndPlayLocalSteam

initAndPlayLocalSteam(view?: HTMLElement): Promise<void>
初始并播放本地视频
Parameters
- Optional view: HTMLElement
  
  视图dom
Returns Promise<void>

listenerCount

listenerCount(event: keyof NECallEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof NECallEvents
Returns number

Inherited from EventEmitter.listenerCount

listeners

listeners<T>(event: T): ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)[]

Inherited from EventEmitter.listeners

off

off<T>(event: T, fn?: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void), context?: any, once?: boolean): NECall
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)
  - - (...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns NECall

Inherited from EventEmitter.off

on

on<T>(event: T, fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void), context?: any): NECall
Add a listener for a given event.
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)
  - - (...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
      
      Returns void
- Optional context: any
Returns NECall

Inherited from EventEmitter.on

once

once<T>(event: T, fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void), context?: any): NECall
Add a one-time listener for a given event.
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)
  - - (...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
      
      Returns void
- Optional context: any
Returns NECall

Inherited from EventEmitter.once

reconnect

reconnect(): void
重连，im 重连成功后调用

Returns void

removeAllListeners

removeAllListeners(event?: keyof NECallEvents): NECall
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof NECallEvents
Returns NECall

Inherited from EventEmitter.removeAllListeners

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void), context?: any, once?: boolean): NECall
Remove the listeners of a given event.
Type Parameters
- T extends keyof NECallEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)
  - - (...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns NECall

Inherited from EventEmitter.removeListener

setEnableJoinRTCChannelWhenCall

setEnableJoinRTCChannelWhenCall(enabled: boolean): void
设置提前加入RTC房间
Parameters
- enabled: boolean
  
  true: 开启； false: 关闭
Returns void

setEnableSwitchCallTypeConfirm

setEnableSwitchCallTypeConfirm(params: { audio?: boolean; video?: boolean }): void
设置切换音视频的确认开关
Parameters
- params: { audio?: boolean; video?: boolean }
  - Optional audio?: boolean
    
    true: 需要； false: 不需要
  - Optional video?: boolean
    
    true: 需要； false: 不需要
Returns void

setLocalView

setLocalView(view: HTMLElement): void
设置本地视图
Parameters
- view: HTMLElement
  
  视图dom
Returns void

setRemoteView

setRemoteView(view: HTMLElement, accId: string): void
设置远端视图
Parameters
- view: HTMLElement
  
  视图dom
- accId: string
Returns void

setTimeout

setTimeout(params: { callTimeout?: number; rejectTimeout?: number }): void
设置超时时间
Parameters
- params: { callTimeout?: number; rejectTimeout?: number }
  - Optional callTimeout?: number
    
    超时取消，单位：毫秒
  - Optional rejectTimeout?: number
    
    超时挂断时间，单位：毫秒
Returns void

switchCallType

switchCallType(params: { callId?: string; callType: SignalControllerCallType; state: number }): Promise<void>
切换呼叫类型
Parameters
- params: { callId?: string; callType: SignalControllerCallType; state: number }
  - Optional callId?: string
    
    呼叫id
  - callType: SignalControllerCallType
    
    呼叫类型
  - state: number
    
    1: 邀请； 2：同意； 3：拒绝
Returns Promise<void>

Class NECall

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: NECallConfig

Returns NECall

Properties

costTimeEventTracking

Type declaration

callId: string

isCaller: boolean

needPush: boolean

rtcAudio: number

rtcCid: string

rtcJoin: number

rtcUid: string

rtcVideo: number

signalTimestamp: number

token: number

userAccId: string

userAction: number

wait: number

rtcController

signalController

Static prefixed

Methods

accept

Parameters

Optional params: { callId?: string; enableOffline?: boolean }

Optional callId?: string

Optional enableOffline?: boolean

Returns Promise<{ callId: string; uid: string }>

addListener

Type Parameters

T extends keyof NECallEvents

Parameters

event: T

fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

Returns void

Optional context: any

Returns NECall

call

Returns

Parameters

params: SignalControllerCallParams

Returns Promise<{ callId: string; uid: string }>

destroy

Returns void

emit

Type Parameters

T extends keyof NECallEvents

Parameters

event: T

Rest ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

Returns boolean

enableLocalAudio

Parameters

enabled: boolean

Returns Promise<void>

enableLocalVideo

Parameters

enabled: boolean

Returns Promise<void>

eventNames

Returns (keyof NECallEvents)[]

getUidByAccId

Parameters

accId: string

Returns undefined | string

hangup

Parameters

Optional params: { callId?: string; enableOffline?: boolean; reason?: number }

Optional callId?: string

`Static` prefixed

`Optional` params: { callId?: string; enableOffline?: boolean }

`Optional` callId?: string

`Optional` enableOffline?: boolean

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` params: { callId?: string; enableOffline?: boolean; reason?: number }

`Optional` callId?: string

`Optional` enableOffline?: boolean

`Optional` reason?: number

`Optional` view: HTMLElement

`Optional` fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` context: any

`Optional` event: keyof NECallEvents

`Optional` fn: ((...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]) => void)

`Rest` ...args: ArgumentMap<NECallEvents>[Extract<T, keyof NECallEvents>]

`Optional` context: any

`Optional` once: boolean