Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCCallSession

Hierarchy

  • EventEmitter
    • RCCallSession

Index

Methods

Constructors

Methods

on

  • on(eventType: string, listener: IEventListener, target?: any): void

  • 添加事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

once

  • once(eventType: string, listener: IEventListener, target?: any): void

  • Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

off

  • off(eventType: string, listener: IEventListener, target?: any): void

  • 移除事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

emit

  • emit(eventType: string, ...attrs: any[]): void

  • 事件派发

    Parameters

    • eventType: string
    • Rest ...attrs: any[]

    Returns void

removeAll

  • removeAll(eventType: string): void

  • 清空所有指定类型的事件监听器

    Parameters

    • eventType: string

    Returns void

clear

  • clear(): void

  • 无差别清空所有事件监听器

    Returns void

registerSessionListener

  • 用户调用的，注册session上的监听

    Parameters

    Returns void

changeAudioDevice

  • changeAudioDevice(audioConstraints?: IMicphoneAudioProfile): Promise<{ code: RCCallErrorCode }>

  • 通话中更换音频设备

    Parameters

    • Optional audioConstraints: IMicphoneAudioProfile

    Returns Promise<{ code: RCCallErrorCode }>

invite

  • 群呼叫中继续邀请

    Parameters

    • userIds: string[]

      被邀请用户 ID 列表

    • options: IInviteOptions = {}

      透传配置及移动端推送配置

    Returns Promise<{ code: RCCallErrorCode }>

accept

hungup

descendAbility

  • 通话降级，目前需求只做通话降级，音视频可以降级为音频，音频不能升到音视频, 发消息成功才算降级成功

    Returns Promise<{ code: RCCallErrorCode }>

disableVideoTrack

enableVideoTrack

disableAudioTrack

enableAudioTrack

getSessionId

  • getSessionId(): string

  • 通话唯一标识

    Returns string

getRTCSessionId

  • getRTCSessionId(): null | string

  • 获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新，(用户录制资源用的)

    Returns null | string

getTargetId

  • getTargetId(): string

  • 目标 ID，单呼对方人员 Id, 群呼群组 Id

    Returns string

getChannelId

  • getChannelId(): string

  • 获取组织 ID

    Returns string

getConversationType

  • getConversationType(): ConversationType

  • 获取会话类型

    Returns ConversationType

getRemoteUsers

  • 房间人员列表，不包含本端信息

    Returns IUserData[]

getUserState

getState

getCallerId

  • getCallerId(): string

  • 获得会话发起者id

    Returns string

getMediaType

Constructors

constructor

  • new RCCallSession(_callId: string, _callPlusClient: RCCallPlusClient, _channelId: string, _targetId: string, _callType: ConversationType, _mediaType: RCCallPlusMediaType, _context: RTCPluginContext, _logger: BasicLogger, _options: { callPushConfig?: IPushConfig; hangupPushConfig?: IPushConfig }): RCCallSession

  • Parameters

    • _callId: string
    • _callPlusClient: RCCallPlusClient
    • _channelId: string
    • _targetId: string
    • _callType: ConversationType
    • _mediaType: RCCallPlusMediaType
    • _context: RTCPluginContext
    • _logger: BasicLogger
    • _options: { callPushConfig?: IPushConfig; hangupPushConfig?: IPushConfig }

    Returns RCCallSession