Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCCallSession

Hierarchy

  • RCCallSession

Index

Properties

Constructors

Methods

Properties

_listener

_listener: null | ISessionListener = null

用户传进来的 对session的监听 (要在RCCallClient的_onInvite里判断，要求执行完onSession必须注册session的监听，所以这里是public)

Constructors

constructor

  • new RCCallSession(_stateMachine: RCCallStateMachine, _rtcClient: RCRTCClient, _logger: ILogger, _options?: IRCCallSessionOptions): RCCallSession

  • Parameters

    • _stateMachine: RCCallStateMachine
    • _rtcClient: RCRTCClient
    • _logger: ILogger
    • _options: IRCCallSessionOptions = {}

    Returns RCCallSession

Methods

registerSessionListener

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

    Parameters

    Returns void

registerCallASRListener

  • registerCallASRListener(listener: IRCCallASRListener): void

  • Parameters

    • listener: IRCCallASRListener

    Returns void

changeAudioDevice

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

  • 通话中更换音频设备

    Parameters

    • Optional audioConstraints: IMicphoneAudioProfile

    Returns Promise<{ code: RCCallErrorCode }>

changeVideoDevice

  • changeVideoDevice(videoConstraints?: ICameraVideoProfile): Promise<{ code: RCCallErrorCode }>

  • 通话中切换视频设备

    Parameters

    • Optional videoConstraints: ICameraVideoProfile

    Returns Promise<{ code: RCCallErrorCode }>

invite

  • invite(userIds: string[], options?: IInviteOptions): Promise<{ code: RCCallErrorCode }>

  • 群呼叫中继续邀请

    Parameters

    • userIds: string[]

      被邀请用户 ID 列表

    • options: IInviteOptions = {}

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

    Returns Promise<{ code: RCCallErrorCode }>

accept

hungup

  • 挂断

    Returns Promise<{ code: RCCallErrorCode }>

_changeMediaType

  • 通话媒体变更

    Parameters

    • mediaType: RCCallMediaType

      RCCallMediaType.AUDIO 改为音频通话 | RCCallMediaType.AUDIO_VIDEO 改为音视频通话

    Returns Promise<{ code: RCCallErrorCode }>

descendAbility

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

    Returns Promise<{ code: RCCallErrorCode }>

disableVideoTrack

  • 禁用视频track

    Returns Promise<{ code: RCCallErrorCode }>

enableVideoTrack

  • 启用视频track

    Returns Promise<{ code: RCCallErrorCode }>

disableAudioTrack

  • 禁用音频track

    Returns Promise<{ code: RCCallErrorCode }>

enableAudioTrack

  • 启用音频track

    Returns Promise<{ code: RCCallErrorCode }>

getSessionId

  • getSessionId(): string

  • 通话唯一标识

    Returns string

getRTCSessionId

  • getRTCSessionId(): null | string

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

    Returns null | string

getTargetId

  • getTargetId(): string

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

    Returns string

getConversationType

  • getConversationType(): ConversationType

  • 获取会话类型

    Returns ConversationType

getChannelId

  • getChannelId(): string

  • 组织 ID

    Returns string

getRemoteUsers

  • getRemoteUsers(): IUserData[]

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

    Returns IUserData[]

getUsers

  • getUsers(): IUserData[]

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

    Returns IUserData[]

getUserState

  • 获取人员状态

    Parameters

    • userId: string

    Returns RCCallUserState

getState

getCallerId

  • getCallerId(): string

  • 获得会话发起者id

    Returns string

getMediaType

  • 获得mediaType

    Returns RCCallMediaType

setSrcLanguageCode

  • setSrcLanguageCode(languageCode: string): Promise<{ code: RCCallErrorCode }>

  • 设置输入语言代码，用于语音识别精准识别

    description

    需要在取得 session 时立马调用

    Parameters

    • languageCode: string

    Returns Promise<{ code: RCCallErrorCode }>

startASR

  • 开启语音识别服务

    description

    语音识别功能依赖会话的音频流， 语音识别服务开启后且会话中有音频流时，sdk 会通过 onReceiveStartASR 通知业务层，代表真正开启成功

    Returns Promise<{ code: RCCallErrorCode }>

asrIsAvailable

  • asrIsAvailable(): boolean

  • 是否有语音识别资源

    Returns boolean

stopASR

  • 关闭语音识别服务

    Returns Promise<{ code: RCCallErrorCode }>

setEnableASR

  • 设置是否接收语音识别资源

    description

    Parameters

    • enable: boolean

      为 ture 时，sdk 会获取语音识别资源并解析，通过监听事件 onReceiveASRContent 事件，抛出语音识别内容

    Returns Promise<{ code: RCCallErrorCode }>

startRealtimeTranslation

  • startRealtimeTranslation(destLangCode: string): Promise<{ code: RCCallErrorCode }>

  • 开启语音实时翻译

    description

    执行时机：需在监听事件 onReceiveStartASR 中执行。

    description

    执行条件：语音识别资源被设置为接收状态

    Parameters

    • destLangCode: string

      翻译的目标语言

    Returns Promise<{ code: RCCallErrorCode }>

stopRealtimeTranslation

  • 关闭语音实时翻译

    Returns Promise<{ code: RCCallErrorCode }>

startSummarization

  • 开始智能总结任务

    description

    执行时机：需在监听事件 onReceiveStartASR 中执行。

    discussion
    1. 智能总结任务依赖语音识别服务
    2. 通话中其他人通过 onReceiveStartSummarization 收到通知
    3. 智能总结任务开始后，可通过 stopSummarization 接口关闭

    Returns Promise<{ code: RCCallErrorCode; taskId?: string }>

    taskId 智能总结任务 Id

stopSummarization

  • 关闭智能总结

    discussion

    通话中关闭智能总结任务，其他人员通过 onReceiveStopSummarization 收到通知

    Returns Promise<{ code: RCCallErrorCode }>

setNickName

  • 设置昵称

    description

    需要在取得 session 时立马调用 长度不超过 64

    Parameters

    • nickName: string

      用于智能总结，昵称强制不翻译

    Returns { code: RCCallErrorCode }