Class NEGroupCall

Hierarchy

EventEmitter<NEGroupCallEvents>
- NEGroupCall

Constructors

constructor

new NEGroupCall(): NEGroupCall
Returns NEGroupCall

Overrides EventEmitter<NEGroupCallEvents>.constructor

Properties

callStatus

callStatus: number = 0

rtcController

rtcController: RTCController

`Static` `Optional` instance

instance?: NEGroupCall

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event, fn, context?): NEGroupCall
Type Parameters
- T extends keyof NEGroupCallEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): 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, ...args): 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): Promise<void>
开关本地音频
Parameters
- enabled: boolean
  
  true开启，false关闭
Returns Promise<void>

enableLocalVideo

enableLocalVideo(enabled): 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

groupAccept

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

Returns Promise<NEGroupCallAcceptRes>

groupCall

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

groupHangup

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

Returns Promise<void>

groupInvite

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

groupJoin

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

groupQueryCallInfo

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

joinRtc

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

listenerCount

listenerCount(event): 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): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof NEGroupCallEvents
Parameters
- event: T
Returns ((...args) => void)[]

Inherited from EventEmitter.listeners

off

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

Inherited from EventEmitter.once

receiveNimMsg

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

removeAllListeners

removeAllListeners(event?): 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, fn?, context?, once?): NEGroupCall
Remove the listeners of a given event.
Type Parameters
- T extends keyof NEGroupCallEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): 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, accId): void
设置用户视图
Parameters
- view: HTMLElement
  
  视频渲染容器
- accId: string
  
  im id
Returns void

setup

setup(params): void
Parameters
- params: NEGroupCallConfig
Returns void

`Static` getInstance

getInstance(): NEGroupCall
Returns NEGroupCall

Class NEGroupCall

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NEGroupCall

Properties

callStatus

rtcController

Static Optional instance

Static prefixed

Methods

addListener

Type Parameters

T extends keyof NEGroupCallEvents

Parameters

event: T

fn: ((...args) => 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)[]

groupAccept

Returns Promise<NEGroupCallAcceptRes>

groupCall

Parameters

opt: NEGroupCallCallFnParams

Returns Promise<NEGroupCallCallRes>

groupHangup

Returns Promise<void>

groupInvite

Parameters

opt: NEGroupCallInviteFnParams

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>

joinRtc

Parameters

Optional opt: { video?: boolean; }

Optional video?: boolean

Returns Promise<void>

listenerCount

Parameters

event: keyof NEGroupCallEvents

Returns number

listeners

Type Parameters

T extends keyof NEGroupCallEvents

`Static` `Optional` instance

`Static` prefixed

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

`Optional` context: any

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

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

`Optional` rtcUid?: number

`Optional` params: {
callId: string;
}

`Optional` opt: {
video?: boolean;
}

`Optional` video?: boolean

`Optional` fn: ((...args) => 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) => void)

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

`Optional` context: any

`Optional` once: boolean

`Static` getInstance