Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICallPlusEventListener

callPlus 对外事件定义

Hierarchy

  • ICallPlusEventListener

Index

Methods

Methods

onReceivedCall

  • 被呼叫通知 被呼叫或被邀请时，收到的通知 收到被呼叫时，可选择接听或挂断通话

    Parameters

    • session: RCCallPlusSession

      通话实例

    • Optional extra: string

      透传呼叫方发起呼叫时携带的附加信息

    Returns void

onRemoteUserInvited

  • onRemoteUserInvited(inviteeUserList: string[], inviterUserId: string, callId: string): void

  • 群组通话中，远端人员被邀请通知，如 A 与 B 通话中，A 邀请 C，则 B 会收到此回调

    Parameters

    • inviteeUserList: string[]

      被邀请用户 ID 列表

    • inviterUserId: string

      发起邀请者的用户 ID

    • callId: string

      所属通话；群聊中，己方已不在通话中的情况下，也会收到服务侧的事件通知

    Returns void

onCallConnected

  • 通话建立成功通知 通话建立后，sdk 内部会发布音视频资源

    Parameters

    Returns void

onUserMediaAvailable

  • 收到某个人的音频或视频可播放 业务层可调 playMedia(userId, mediaType) 播放

    Parameters

    Returns void

onCallEnded

  • 通话结束通知

    description

    群组通话，收到此通知时，仅代表本人退出通话，不代表通话结束，因为其他人可能仍在通话中

    Parameters

    Returns void

Optional onCallTypeChanged

  • 通话类型变更通知

    Parameters

    • type: RCCallPlusType

      通话类型，单呼或群呼

    • callId: string

      通话 id

    Returns void

Optional onRemoteUserStateChanged

  • 远端人员状态变更通知

    Parameters

    Returns void

Optional onRemoteCameraStateChanged

  • onRemoteCameraStateChanged(callId: string, userId: string, disabled: boolean): void

  • 远端用户摄像头开、关状态通知

    Parameters

    • callId: string

      通话 id

    • userId: string

      远端用户 id

    • disabled: boolean

      摄像头是否关闭，true 为关闭状态，false 为打开状态

    Returns void

Optional onRemoteMicrophoneStateChanged

  • onRemoteMicrophoneStateChanged(callId: string, userId: string, disabled: boolean): void

  • 远端用户麦克风开、关状态通知

    Parameters

    • callId: string

      通话 id

    • userId: string

      远端用户 id

    • disabled: boolean

      麦克风是否关闭，true 为关闭状态，false 为打开状态

    Returns void

Optional onReceivedCallRecord

  • 单呼或群呼结束后，服务器下发通话记录通知

    Parameters

    • record: IRCCallPlusCallRecord

      数据接口定义为：IRCCallPlusCallRecord，可通过 apiDoc 查看具体包含字段

    Returns void

Optional onReceivedChangeMediaTypeRequest

  • onReceivedChangeMediaTypeRequest(userId: string, transactionId: string, mediaType: RCCallPlusMediaType): void

  • 通话中，收到远端用户请求切换媒体类型通知（仅单聊）

    Parameters

    • userId: string

      远端用户 id，即请求发起人

    • transactionId: string

      事物 id，本次请求和应答的唯一标识

    • mediaType: RCCallPlusMediaType

      请求切换的媒体类型，音频或音视频

    Returns void

Optional onReceivedChangeMediaTypeResult

Optional onReceivedCallStartTime

  • onReceivedCallStartTime(info: { callId: string; callType: RCCallPlusType; callStartTime: number }): void

  • 通话开始时间通知

    description

    通话开始时间戳，为通话对应的房间首次被加入时的时间

    Parameters

    • info: { callId: string; callType: RCCallPlusType; callStartTime: number }
      • callId: string

        通话 id

      • callType: RCCallPlusType

        通话类型，单聊或群聊

      • callStartTime: number

        通话开始时间戳(ms)

    Returns void

Optional onReceivedCallFirstFrameTime

  • onReceivedCallFirstFrameTime(callId: string, callFirstFrameTime: number): void

  • 收到首帧时间通知 通话从首帧时间开始计费

    description

    首帧时间戳，为通话中所有用户最早收到首帧的时间

    Parameters

    • callId: string

      通话 id

    • callFirstFrameTime: number

      通话首帧到达时间

    Returns void

Optional onFetchRemoteMediaError

  • onFetchRemoteMediaError(userId: string, code: number): void

  • 获取远端媒体资源失败

    Parameters

    • userId: string

      远端人员 id

    • code: number

      失败原因

    Returns void

Optional onUserAudioLevelChanged

  • onUserAudioLevelChanged(userId: string, audioLevel: number): void

  • 通话中人员音量通知

    description

    默认每秒上报一次

    Parameters

    • userId: string

      本端或远端人员 id

    • audioLevel: number

      音量值（0-100）

    Returns void

Optional onReceivedCallPlusSummaryMessage

  • 收到通话结束的消息记录通知

    description

    仅单聊可收到，可用于在 IM 聊天界面插入通话结束消息 触发时机: 1.单聊在线通话结束后 2.离线时收到单聊呼叫，通话结束后，重新连接 IM 在线时

    Parameters

    Returns void

Optional onReceivedGroupCallStatusMessage

  • 收到群组通话开始和结束的消息，可用于在 IM 聊天界面插入通话开始和结束消息 触发条件: 1.仅在同一个群组中的人员可收到 2.需在发起呼叫时设置 targtId 参数，targtId 为群组 id 触发时机: 1.群组通话开始或结束后 2.离线时群组里产生新通话，重新连接 IM 在线时

    Parameters

    Returns void