@rongcloud/react-native-calllib

Index

Enumerations

Interfaces

Variables

RCReactNativeCallVideoView

Functions

Variables

RCReactNativeCallVideoView

RCReactNativeCallVideoView: HostComponent<unknown> = ...

Functions

accept

accept(): void

- Defined in index.ts:125
接听

Returns void

changeMediaType

changeMediaType(type: RCCallIWMediaType): void

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

Parameters
- type: RCCallIWMediaType
Returns void

currentCamera

currentCamera(): Promise<RCCallIWCamera>

- Defined in index.ts:186
获取当前摄像头

Returns Promise<RCCallIWCamera>

enableCamera

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

- Defined in index.ts:169
摄像头控制

Parameters
- enable: boolean
  
  true 开启摄像头，false 关闭摄像头
- camera: RCCallIWCamera
  
  指定摄像头
Returns void

enableMicrophone

enableMicrophone(enable: boolean): void

- Defined in index.ts:142
麦克风控制,开启、关闭麦克风

Parameters
- enable: boolean
  
  true开启 false关闭
Returns void

enableSpeaker

enableSpeaker(enable: boolean): void

- Defined in index.ts:151
扬声器控制开启、关闭扬声器

Parameters
- enable: boolean
  
  true开启 false关闭
Returns void

getCurrentCallSession

getCurrentCallSession(): Promise<IRCCallIWCallSession>

- Defined in index.ts:117
获取当前call session

Returns Promise<IRCCallIWCallSession>

hangup

hangup(): void

- Defined in index.ts:133
挂断

Returns void

init

init(): void

- Defined in index.ts:37
初始化

Returns void

inviteUsers

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

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

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

isEnableCamera

isEnableCamera(): Promise<boolean>

- Defined in index.ts:178
获取当前摄像头状态, 是否已开启摄像头

Returns Promise<boolean>

isEnableSpeaker

isEnableSpeaker(): Promise<boolean>

- Defined in index.ts:159
获取当前扬声器状态,当前扬声器是否开启

Returns Promise<boolean>

onAudioVolume

onAudioVolume(listener: (user: IRCCallIWUserProfile, volume: number) => void): void

- Defined in index.ts:427
当前通话某用户声音音量回调

discussion
声音级别: 0~9, 0为无声, 依次变大如果user是本端用户, volume代表发送音量如果user是远端用户, volume代表接收音量

Parameters
- listener: (user: IRCCallIWUserProfile, volume: number) => void
  - - (user: IRCCallIWUserProfile, volume: number): void
    - Parameters
      - user: IRCCallIWUserProfile
      - volume: number
      Returns void
Returns void

onCallConnected

onCallConnected(listener: () => void): void

- Defined in index.ts:268
通话已接通

Parameters
- listener: () => void
  - - (): void
    - Returns void
Returns void

onCallDisconnected

onCallDisconnected(listener: (reason: RCCallIWCallDisconnectedReason) => void): void

- Defined in index.ts:279
通话已结束

Parameters
- listener: (reason: RCCallIWCallDisconnectedReason) => void
  - - (reason: RCCallIWCallDisconnectedReason): void
    - Parameters
      - reason: RCCallIWCallDisconnectedReason
      Returns void
Returns void

onCallOutgoing

onCallOutgoing(listener: () => void): void

- Defined in index.ts:346
开始呼叫通话的回调

Parameters
- listener: () => void
  - - (): void
    - Returns void
Returns void

onCallReceived

onCallReceived(listener: (session: IRCCallIWCallSession) => void): void

- Defined in index.ts:257
接收到通话呼入

Parameters
- listener: (session: IRCCallIWCallSession) => void
  - - (session: IRCCallIWCallSession): void
    - Parameters
      - session: IRCCallIWCallSession
      Returns void
Returns void

onEnableCamera

onEnableCamera(listener: (camera: RCCallIWCamera, enable: boolean) => void): void

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

Parameters
- listener: (camera: RCCallIWCamera, enable: boolean) => void
  - - (camera: RCCallIWCamera, enable: boolean): void
    - Parameters
      - camera: RCCallIWCamera
      - enable: boolean
      Returns void
Returns void

onError

onError(listener: (code: RCRNCallErrorCode) => void): void

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

Parameters
- listener: (code: RCRNCallErrorCode) => void
  - - (code: RCRNCallErrorCode): void
    - Parameters
      - code: RCRNCallErrorCode
      Returns void
Returns void

onNetworkQuality

onNetworkQuality(listener: (user: IRCCallIWUserProfile, quality: RCCallIWNetworkQuality) => void): void

- Defined in index.ts:411
当前通话网络状态的回调，该回调方法每秒触发一次

discussion
如果user是本端用户, quality代表上行网络质量如果user是远端用户, quality代表下行网络质量

Parameters
- listener: (user: IRCCallIWUserProfile, quality: RCCallIWNetworkQuality) => void
  - - (user: IRCCallIWUserProfile, quality: RCCallIWNetworkQuality): void
    - Parameters
      - user: IRCCallIWUserProfile
      - quality: RCCallIWNetworkQuality
      Returns void
Returns void

onRemoteUserCameraStateChanged

onRemoteUserCameraStateChanged(listener: (user: IRCCallIWUserProfile, enable: boolean) => void): void

- Defined in index.ts:396
对端用户开启或关闭了摄像头的状态

Parameters
- listener: (user: IRCCallIWUserProfile, enable: boolean) => void
  - - (user: IRCCallIWUserProfile, enable: boolean): void
    - Parameters
      - user: IRCCallIWUserProfile
      - enable: boolean
      Returns void
Returns void

onRemoteUserInvited

onRemoteUserInvited(listener: (userId: string, mediaType: RCCallIWMediaType) => void): void

- Defined in index.ts:366
有用户被邀请加入通话顺序：Engine:OnRemoteUserInvited -> Engine:OnRemoteUserRinging

Parameters
- listener: (userId: string, mediaType: RCCallIWMediaType) => void
  - - (userId: string, mediaType: RCCallIWMediaType): void
    - Parameters
      - userId: string
      - mediaType: RCCallIWMediaType
      Returns void
Returns void

onRemoteUserJoined

onRemoteUserJoined(listener: (user: IRCCallIWUserProfile) => void): void

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

Parameters
- listener: (user: IRCCallIWUserProfile) => void
  - - (user: IRCCallIWUserProfile): void
    - Parameters
      - user: IRCCallIWUserProfile
      Returns void
Returns void

onRemoteUserLeft

onRemoteUserLeft(listener: (user: string, reason: RCCallIWCallDisconnectedReason) => void): void

- Defined in index.ts:303
对端用户挂断 (实际测试，只在群聊时用触发)

Parameters
- listener: (user: string, reason: RCCallIWCallDisconnectedReason) => void
  - - (user: string, reason: RCCallIWCallDisconnectedReason): void
    - Parameters
      - user: string
      - reason: RCCallIWCallDisconnectedReason
      Returns void
Returns void

onRemoteUserMediaTypeChanged

onRemoteUserMediaTypeChanged(listener: (user: IRCCallIWUserProfile, mediaType: RCCallIWMediaType) => void): void

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

Parameters
- listener: (user: IRCCallIWUserProfile, mediaType: RCCallIWMediaType) => void
  - - (user: IRCCallIWUserProfile, mediaType: RCCallIWMediaType): void
    - Parameters
      - user: IRCCallIWUserProfile
      - mediaType: RCCallIWMediaType
      Returns void
Returns void

onRemoteUserMicrophoneStateChanged

onRemoteUserMicrophoneStateChanged(listener: (user: IRCCallIWUserProfile, enable: boolean) => void): void

- Defined in index.ts:386
对端用户开启或关闭了麦克风的状态

Parameters
- listener: (user: IRCCallIWUserProfile, enable: boolean) => void
  - - (user: IRCCallIWUserProfile, enable: boolean): void
    - Parameters
      - user: IRCCallIWUserProfile
      - enable: boolean
      Returns void
Returns void

onRemoteUserRinging

onRemoteUserRinging(listener: (userId: string) => void): void

- Defined in index.ts:356
对端用户正在振铃

Parameters
- listener: (userId: string) => void
  - - (userId: string): void
    - Parameters
      - userId: string
      Returns void
Returns void

onSwitchCamera

onSwitchCamera(listener: (camera: RCCallIWCamera) => void): void

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

Parameters
- listener: (camera: RCCallIWCamera) => void
  - - (camera: RCCallIWCamera): void
    - Parameters
      - camera: RCCallIWCamera
      Returns void
Returns void

removeAudioVolumeListener

removeAudioVolumeListener(): void

- Defined in index.ts:558
移除监听-当前通话某用户声音音量回调

Returns void

removeCallConnectedListener

removeCallConnectedListener(): void

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

Returns void

removeCallDisconnectedListener

removeCallDisconnectedListener(): void

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

Returns void

removeCallOutgoingListener

removeCallOutgoingListener(): void

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

Returns void

removeCallReceivedListener

removeCallReceivedListener(): void

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

Returns void

removeEnableCameraListener

removeEnableCameraListener(): void

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

Returns void

removeErrorListener

removeErrorListener(): void

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

Returns void

removeNetworkQualityListener

removeNetworkQualityListener(): void

- Defined in index.ts:550
移除监听-当前通话网络状态的回调，该回调方法每秒触发一次

Returns void

removeRemoteUserCameraStateChangedListener

removeRemoteUserCameraStateChangedListener(): void

- Defined in index.ts:542
对端用户开启或关闭了摄像头的状态

Returns void

removeRemoteUserDidChangeMicrophoneStateListener

removeRemoteUserDidChangeMicrophoneStateListener(): void

- Defined in index.ts:534
对端用户开启或关闭了麦克风的状态

Returns void

removeRemoteUserInvited

removeRemoteUserInvited(): void

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

Returns void

removeRemoteUserJoinedListener

removeRemoteUserJoinedListener(): void

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

Returns void

removeRemoteUserLeftListener

removeRemoteUserLeftListener(): void

- Defined in index.ts:470
移除监听-对端用户挂断

Returns void

removeRemoteUserMediaTypeChangedListener

removeRemoteUserMediaTypeChangedListener(): void

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

Returns void

removeRemoteUserRingingListener

removeRemoteUserRingingListener(): void

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

Returns void

removeSwitchCameraListener

removeSwitchCameraListener(): void

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

Returns void

setAudioConfig

setAudioConfig(config?: IRCCallIWAudioConfig): void

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

Parameters
- config: IRCCallIWAudioConfig = {}
Returns void

setEngineConfig

setEngineConfig(config: IRCCallIWEngineConfig): void

- Defined in index.ts:54
引擎配置 android平台的参数根据 https://www.rongcloud.cn/docs/api/android/calllib_v5/io/rong/calllib/RongCallClient.html#getInstance-- 的setRTCConfig(cn.rongcloud.rtc.api.RCRTCConfig.Builder builder) 转https://www.rongcloud.cn/docs/api/android/rtclib_v5/

Parameters
- config: IRCCallIWEngineConfig
Returns void

setPushConfig

setPushConfig(callPushConfig?: IRCCallIWPushConfig, hangupPushConfig?: IRCCallIWPushConfig, enableApplePushKit?: boolean): void

- Defined in index.ts:65
推送配置

Parameters
- callPushConfig: IRCCallIWPushConfig = {}
- hangupPushConfig: IRCCallIWPushConfig = {}
- enableApplePushKit: boolean = false
  
  设置是否使用苹果 PushKit 推送， true 使用, false 不使用 , 默认关闭
Returns void

setVideoConfig

setVideoConfig(config?: IRCCallIWVideoConfig): void

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

Parameters
- config: IRCCallIWVideoConfig = {}
Returns void

setVideoView

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

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

Parameters
- userId: string
  
  用户Id
- viewId: number
  
  videoView的容器的引用
- type: RCCallIWViewFitType
  
  视频显示模式
- isZOrderOnTop: boolean = false
Returns void

startGroupCall

startGroupCall(groupId: string, userIds: string[], observerUserIds: null | string[], mediaType: RCCallIWMediaType, extra?: string): Promise<IRCCallIWCallSession>

- Defined in index.ts:109
拨打电话-群聊, 如果type为音视频，直接打开默认（前置）摄像头

Parameters
- groupId: string
  
  群组Id
- userIds: string[]
  
  被叫端的用户ID列表, 数组中仅填写被叫端UserId, 请不要填写主叫端UserId, 否则无法发起呼叫
- observerUserIds: null | string[]
  
  主叫端指定需要以观察者身份加入房间的用户ID列表, 如果主叫端需要以观察者身份加入房间也需要填写主叫端UserId
- mediaType: RCCallIWMediaType
  
  发起的通话媒体类型
- extra: string = ''
  
  附加信息
Returns Promise<IRCCallIWCallSession>

startSingleCall

startSingleCall(userId: string, mediaType: RCCallIWMediaType, extra?: string): Promise<IRCCallIWCallSession>

- Defined in index.ts:96
拨打电话-单聊, 如果type为音视频，直接打开默认（前置）摄像头。

Parameters
- userId: string
  
  被叫端UserId
- mediaType: RCCallIWMediaType
  
  发起的通话媒体类型
- extra: string = ''
  
  附加信息
Returns Promise<IRCCallIWCallSession>

switchCamera

switchCamera(): void

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

Returns void

unInit

unInit(): void

- Defined in index.ts:45
反初始化

Returns void

Generated using TypeDoc