Module src

Index

References

Functions

References

RCCallIWAudioCodecType

Re-exports RCCallIWAudioCodecType

RCCallIWAudioSource

Re-exports RCCallIWAudioSource

RCCallIWCallDisconnectedReason

Re-exports RCCallIWCallDisconnectedReason

RCCallIWCallType

Re-exports RCCallIWCallType

RCCallIWCamera

Re-exports RCCallIWCamera

RCCallIWCameraOrientation

Re-exports RCCallIWCameraOrientation

RCCallIWImportanceHW

Re-exports RCCallIWImportanceHW

RCCallIWMediaType

Re-exports RCCallIWMediaType

RCCallIWNetworkQuality

Re-exports RCCallIWNetworkQuality

RCCallIWUserType

Re-exports RCCallIWUserType

RCCallIWVideoBitrateMode

Re-exports RCCallIWVideoBitrateMode

RCCallIWVideoProfile

Re-exports RCCallIWVideoProfile

RCUNICallErrorCode

Re-exports RCUNICallErrorCode

Functions

accept

accept(): void

- Defined in index.ts:332
接收calllib

默认不传参数

Returns void

changeMediaType

changeMediaType(type: RCCallIWMediaType): void

- Defined in index.ts:444
修改通话类型

Parameters
- type: RCCallIWMediaType
Returns void

currentCamera

currentCamera(): any

- Defined in index.ts:424
获取当前摄像头方式

默认不传参数

Returns any

enableCamera

enableCamera(isOpen: boolean, camera: RCCallIWCamera): void

- Defined in index.ts:436
开启摄像头摄像头

Parameters
- isOpen: boolean
  
  是否开启
- camera: RCCallIWCamera
Returns void

enableMicrophone

enableMicrophone(isOpen: boolean): void

- Defined in index.ts:404
设置callib是否开启麦克风

Parameters
- isOpen: boolean
Returns void

enableSpeaker

enableSpeaker(isOpen: boolean): void

- Defined in index.ts:393
设置callib是否开启扬声器

Parameters
- isOpen: boolean
  
  默认开启
Returns void

getCurrentCallSession

getCurrentCallSession(): RCCallIWCallSession

- Defined in index.ts:312
获取当前calllib本地存储信息

默认不传参数

Returns RCCallIWCallSession

hangup

hangup(): void

- Defined in index.ts:322
挂断calllib

默认不传参数

Returns void

init

init(): void

- Defined in index.ts:35
初始化 SDK，只需要调用一次

calllib初始化默认不传参数

Returns void

inviteUsers

inviteUsers(userIds: string[], observerUserIds: string[]): void

- Defined in index.ts:370
邀请用户

Parameters
- userIds: string[]
  
  被邀请用户id列表
- observerUserIds: string[]
  
  被邀请观察者id列表 (只能听或看，不能推流的用户)
Returns void

onCallConnected

onCallConnected(listener: (result: UniListenerResult<ListenerNullData>) => void): void

- Defined in index.ts:73
添加连接监听函数

Parameters
- listener: (result: UniListenerResult<ListenerNullData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerNullData>): void
    - Parameters
      - result: UniListenerResult<ListenerNullData>
      Returns void
Returns void

onCallDisconnected

onCallDisconnected(listener: (result: UniListenerResult<ListenerOnCallDisconnectedData>) => void): void

- Defined in index.ts:91
添加挂断监听函数

Parameters
- listener: (result: UniListenerResult<ListenerOnCallDisconnectedData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnCallDisconnectedData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnCallDisconnectedData>
      Returns void
Returns void

onCallOutgoing

onCallOutgoing(listener: (result: UniListenerResult<ListenerNullData>) => void): void

- Defined in index.ts:162
电话已拨出主叫端拨出电话后，通过回调 onCallOutgoing 通知当前 call 的详细信息

Parameters
- listener: (result: UniListenerResult<ListenerNullData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerNullData>): void
    - Parameters
      - result: UniListenerResult<ListenerNullData>
      Returns void
Returns void

onCallReceived

onCallReceived(listener: (result: UniListenerResult<RCCallIWCallSession>) => void): void

- Defined in index.ts:54
添加通话呼入监听函数

Parameters
- listener: (result: UniListenerResult<RCCallIWCallSession>) => void
  
  回调函数
  - - (result: UniListenerResult<RCCallIWCallSession>): void
    - Parameters
      - result: UniListenerResult<RCCallIWCallSession>
      Returns void
Returns void

onEnableCamera

onEnableCamera(listener: (result: UniListenerResult<ListenerOnEnableCameraData>) => void): void

- Defined in index.ts:278
开启或关闭摄像头的回调

Parameters
- listener: (result: UniListenerResult<ListenerOnEnableCameraData>) => void
  - - (result: UniListenerResult<ListenerOnEnableCameraData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnEnableCameraData>
      Returns void
Returns void

onError

onError(listener: (result: UniListenerResult<ListenerResultError>) => void): void

- Defined in index.ts:196
通话出现错误的回调

Parameters
- listener: (result: UniListenerResult<ListenerResultError>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerResultError>): void
    - Parameters
      - result: UniListenerResult<ListenerResultError>
      Returns void
Returns void

onNetworkQuality

onNetworkQuality(listener: (result: UniListenerResult<ListenerNetworkQualityData>) => void): void

- Defined in index.ts:264
网络状态监测，通话建立成功后才会有回调

Parameters
- listener: (result: UniListenerResult<ListenerNetworkQualityData>) => void
  - - (result: UniListenerResult<ListenerNetworkQualityData>): void
    - Parameters
      - result: UniListenerResult<ListenerNetworkQualityData>
      Returns void
Returns void

onRemoteUserCameraStateChanged

onRemoteUserCameraStateChanged(listener: (result: UniListenerResult<ListenerOnRemoteUserCameraStateChangedData>) => void): void

- Defined in index.ts:230
对端用户开关摄像头

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserCameraStateChangedData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserCameraStateChangedData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserCameraStateChangedData>
      Returns void
Returns void

onRemoteUserInvited

onRemoteUserInvited(listener: (result: UniListenerResult<ListenerOnRemoteUserInvitedData>) => void): void

- Defined in index.ts:111
通话中的某一个参与者，邀请好友加入通话

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserInvitedData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserInvitedData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserInvitedData>
      Returns void
Returns void

onRemoteUserJoined

onRemoteUserJoined(listener: (result: UniListenerResult<RCCallIWUserProfile>) => void): void

- Defined in index.ts:128
对端用户加入了通话

Parameters
- listener: (result: UniListenerResult<RCCallIWUserProfile>) => void
  
  回调函数
  - - (result: UniListenerResult<RCCallIWUserProfile>): void
    - Parameters
      - result: UniListenerResult<RCCallIWUserProfile>
      Returns void
Returns void

onRemoteUserLeft

onRemoteUserLeft(listener: (result: UniListenerResult<ListenerOnRemoteUserLeftData>) => void): void

- Defined in index.ts:145
远端用户离开 (只在群聊时用触发)

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserLeftData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserLeftData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserLeftData>
      Returns void
Returns void

onRemoteUserMediaTypeChanged

onRemoteUserMediaTypeChanged(listener: (result: UniListenerResult<ListenerOnRemoteUserMediaTypeChangedData>) => void): void

- Defined in index.ts:213
对端用户切换了媒体类型

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserMediaTypeChangedData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserMediaTypeChangedData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserMediaTypeChangedData>
      Returns void
Returns void

onRemoteUserMicrophoneStateChanged

onRemoteUserMicrophoneStateChanged(listener: (result: UniListenerResult<ListenerOnRemoteUserMicrophoneStateChangedData>) => void): void

- Defined in index.ts:247
对端用户开关麦克风

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserMicrophoneStateChangedData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserMicrophoneStateChangedData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserMicrophoneStateChangedData>
      Returns void
Returns void

onRemoteUserRinging

onRemoteUserRinging(listener: (result: UniListenerResult<ListenerOnRemoteUserRingingData>) => void): void

- Defined in index.ts:179
被叫端正在振铃，主叫端拨出电话，被叫端收到请求，发出振铃响应时监听

Parameters
- listener: (result: UniListenerResult<ListenerOnRemoteUserRingingData>) => void
  
  回调函数
  - - (result: UniListenerResult<ListenerOnRemoteUserRingingData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnRemoteUserRingingData>
      Returns void
Returns void

onSwitchCamera

onSwitchCamera(listener: (result: UniListenerResult<ListenerOnSwitchCameraData>) => void): void

- Defined in index.ts:294
切换摄像头回调

Parameters
- listener: (result: UniListenerResult<ListenerOnSwitchCameraData>) => void
  - - (result: UniListenerResult<ListenerOnSwitchCameraData>): void
    - Parameters
      - result: UniListenerResult<ListenerOnSwitchCameraData>
      Returns void
Returns void

removeCallConnectedListener

removeCallConnectedListener(): void

- Defined in index.ts:81
移除监听-通话已接通

Returns void

removeCallDisconnectedListener

removeCallDisconnectedListener(): void

- Defined in index.ts:100
移除监听-通话已结束

Returns void

removeCallOutgoingListener

removeCallOutgoingListener(): void

- Defined in index.ts:170
移除监听-开始呼叫通话的回调

Returns void

removeCallReceivedListener

removeCallReceivedListener(): void

- Defined in index.ts:63
移除监听-接收到通话呼入

Returns void

removeEnableCameraListener

removeEnableCameraListener(): void

- Defined in index.ts:286
移除监听-开启或关闭摄像头的回调

Returns void

removeErrorListener

removeErrorListener(): void

- Defined in index.ts:204
移除监听-通话出现错误的回调

Returns void

removeNetworkQualityListener

removeNetworkQualityListener(): void

- Defined in index.ts:271
移除监听 - 网络状态监测

Returns void

removeRemoteUserCameraStateChangedListener

removeRemoteUserCameraStateChangedListener(): void

- Defined in index.ts:238
移除监听- 远端摄像头状态变更

Returns void

removeRemoteUserInvited

removeRemoteUserInvited(): void

- Defined in index.ts:119
移除监听-有用户被邀请加入通话

Returns void

removeRemoteUserJoinedListener

removeRemoteUserJoinedListener(): void

- Defined in index.ts:136
移除监听-对端用户加入了通话

Returns void

removeRemoteUserLeftListener

removeRemoteUserLeftListener(): void

- Defined in index.ts:153
移除监听-远端用户离开

Returns void

removeRemoteUserMediaTypeChangedListener

removeRemoteUserMediaTypeChangedListener(): void

- Defined in index.ts:221
移除监听-对端用户切换了媒体类型

Returns void

removeRemoteUserMicrophoneStateChangedListener

removeRemoteUserMicrophoneStateChangedListener(): void

- Defined in index.ts:255
移除监听- 远端麦克风状态变更

Returns void

removeRemoteUserRingingListener

removeRemoteUserRingingListener(): void

- Defined in index.ts:187
移除监听-对端用户正在振铃

Returns void

removeSwitchCameraListener

removeSwitchCameraListener(): void

- Defined in index.ts:302
移除监听-切换摄像头回调

Returns void

setAudioConfig

setAudioConfig(config: RCCallIWAudioConfig): void

- Defined in index.ts:453
音频配置

Parameters
- config: RCCallIWAudioConfig
Returns void

setPushConfig

setPushConfig(config: RCCallIWPushConfig, hangupPushConfig: RCCallIWPushConfig): void

- Defined in index.ts:472
通话提醒消息推送配置（可在拨打电话前设置）

Parameters
- config: RCCallIWPushConfig
  
  呼叫推送配置
- hangupPushConfig: RCCallIWPushConfig
  
  挂断推送配置
Returns void

setVideoConfig

setVideoConfig(config: RCCallIWVideoConfig): void

- Defined in index.ts:462
视频配置

Parameters
- config: RCCallIWVideoConfig
Returns void

setVideoView

setVideoView(userId: string, ref: string, type: number, isZOrderOnTop?: boolean): void

- Defined in index.ts:383
设置预览窗口，此方法需要在视图更新渲染完成后执行

Parameters
- userId: string
  
  用户id
- ref: string
  
  ref ID 对应组件的标识
- type: number
  
  视频显示模式 0 铺满 1 自适应
- isZOrderOnTop: boolean = false
  
  android only 是否置顶
Returns void

startGroupCall

startGroupCall(groupId: string, userIds: string[], observerUserIds: string[], type: number, extra: string): void

- Defined in index.ts:360
发起组呼呼叫

Parameters
- groupId: string
  
  组ID
- userIds: string[]
  
  群组成员
- observerUserIds: string[]
  
  观察者ID默认为空数组
- type: number
  
  呼叫类型（0:音频 1:音视频）
- extra: string
  
  默认传''
Returns void

startSingleCall

startSingleCall(targetId: string, type: number, extra: null): void

- Defined in index.ts:345
发起单聊呼叫

Parameters
- targetId: string
  
  目标ID
- type: number
  
  呼叫类型（0:音频 1:音视频）
- extra: null
  
  默认传''
Returns void

switchCamera

switchCamera(): void

- Defined in index.ts:415
切换摄像头

默认不传参数

Returns void

unInit

unInit(): void

- Defined in index.ts:44
注销calllib

注销calllib默认不传参数

Returns void

Generated using TypeDoc