Class NEGroupCall

Hierarchy

EventEmitter<NEGroupCallEvents>
- NEGroupCall

Index

Constructors

constructor

new NEGroupCall(param: NEGroupCallConfig): NEGroupCall
Parameters
- param: NEGroupCallConfig
Returns NEGroupCall

Overrides EventEmitter<NEGroupCallEvents>.constructor

Properties

callStatus

callStatus: number = 0

rtcController

rtcController: RTCController

`Static` prefixed

prefixed: string | boolean

Methods

addListener

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

Inherited from EventEmitter.addListener

destroy

destroy(): void
销毁实例

Returns void

emit

emit<T>(event: T, ...args: ArgumentMap<NEGroupCallEvents>[Extract<T, keyof NEGroupCallEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof NEGroupCallEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<NEGroupCallEvents>[Extract<T, keyof NEGroupCallEvents>]
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 NEGroupCallEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof NEGroupCallEvents)[]

Inherited from EventEmitter.eventNames

gorupInvite

gorupInvite(opt: NEGroupCallInviteFnParams): Promise<void>
邀请参加群组呼叫
Parameters
- opt: NEGroupCallInviteFnParams
Returns Promise<void>

groupAccept

groupAccept(): Promise<NEGroupCallAcceptRes>
接收群组呼叫

Returns Promise<NEGroupCallAcceptRes>

groupCall

groupCall(opt: NEGroupCallCallFnParams): Promise<NEGroupCallCallRes>
发起群组呼叫

Returns
Parameters
- opt: NEGroupCallCallFnParams
Returns Promise<NEGroupCallCallRes>

groupHangup

groupHangup(): Promise<void>
挂断群组通话

Returns Promise<void>

groupJoin

groupJoin(params: { callId: string; rtcUid?: number }): Promise<NEGroupCallCallRes>
加入群组通话
Parameters
- params: { callId: string; rtcUid?: number }
  - callId: string
    
    群组呼叫id
  - Optional rtcUid?: number
    
    加入群组通话的用户uid
Returns Promise<NEGroupCallCallRes>

groupQueryCallInfo

groupQueryCallInfo(params?: { callId: string }): Promise<NEGroupCallQueryInfo>
查询通话信息
Parameters
- Optional params: { callId: string }
  - callId: string
    
    通话id
Returns Promise<NEGroupCallQueryInfo>

jionRtc

jionRtc(opt?: { video?: boolean }): Promise<void>
本端加入rtc房间，需要
Parameters
- Optional opt: { video?: boolean }
  
  video: 加入时是否开启视频
  - Optional video?: boolean
Returns Promise<void>

listenerCount

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

Inherited from EventEmitter.listenerCount

listeners

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

Inherited from EventEmitter.listeners

off

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

Inherited from EventEmitter.off

on

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

Inherited from EventEmitter.on

once

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

Inherited from EventEmitter.once

receiveNimMsg

receiveNimMsg(msg: string): boolean
用于接收im自定义消息
Parameters
- msg: string
  
  im onmsg 事件参数
Returns boolean

removeAllListeners

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

Inherited from EventEmitter.removeAllListeners

removeListener

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

Inherited from EventEmitter.removeListener

setRtcView

setRtcView(view: HTMLElement, accId: string): void
设置用户视图
Parameters
- view: HTMLElement
  
  视频渲染容器
- accId: string
  
  im id
Returns void

Class NEGroupCall

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

param: NEGroupCallConfig

Returns NEGroupCall

Properties

callStatus

rtcController

Static prefixed

Methods

addListener

Type Parameters

T extends keyof NEGroupCallEvents

Parameters

event: T

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

Parameters

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

Returns void

Optional context: any

Returns NEGroupCall

destroy

Returns void

emit

Type Parameters

T extends keyof NEGroupCallEvents

Parameters

event: T

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

Returns boolean

enableLocalAudio

Parameters

enabled: boolean

Returns Promise<void>

enableLocalVideo

Parameters

enabled: boolean

Returns Promise<void>

eventNames

Returns (keyof NEGroupCallEvents)[]

gorupInvite

Parameters

opt: NEGroupCallInviteFnParams

Returns Promise<void>

groupAccept

Returns Promise<NEGroupCallAcceptRes>

groupCall

Returns

Parameters

opt: NEGroupCallCallFnParams

Returns Promise<NEGroupCallCallRes>

groupHangup

Returns Promise<void>

groupJoin

Parameters

params: { callId: string; rtcUid?: number }

callId: string

Optional rtcUid?: number

Returns Promise<NEGroupCallCallRes>

groupQueryCallInfo

Parameters

Optional params: { callId: string }

callId: string

Returns Promise<NEGroupCallQueryInfo>

jionRtc

Parameters

Optional opt: { video?: boolean }

Optional video?: boolean

Returns Promise<void>

listenerCount

Parameters

event: keyof NEGroupCallEvents

Returns number

listeners

`Static` prefixed

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

`Optional` context: any

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

`Optional` rtcUid?: number

`Optional` params: { callId: string }

`Optional` opt: { video?: boolean }

`Optional` video?: boolean

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

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

`Optional` context: any

`Optional` once: boolean

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

`Optional` context: any

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

`Optional` context: any

`Optional` event: keyof NEGroupCallEvents

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

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

`Optional` context: any

`Optional` once: boolean