Class JRTCCallCenterCallParam

呼叫参数

Hierarchy (View Summary)

Accessors

sip video autoRecord maxResolution maxFrameRate svcResolution videoDefinition hbTime hbTimeOut securityType audioEncodeType recordExtraInfo vipPower channelId traceId serialId extraSerialId calleeUserId calleeBusinessNumber recordVideo frameRate mergeMode intelligentMergeMode scsMergeMode videoWidth videoHeight iBitrate extraInfo watermarkTextMap layoutType layoutList fileName splitFileSize

Methods

toString

Accessors

sip

  • set sip(value: boolean): void

  • 设置是否 sip 呼叫（目前只支持座席回呼场景），默认 false

    Parameters

    • value: boolean

    Returns void

video

  • set video(value: boolean): void

  • 设置是否视频呼叫（目前只在 sip 呼叫场景下有效），默认 true

    Parameters

    • value: boolean

    Returns void

autoRecord

  • set autoRecord(value: boolean): void

  • 设置是否由服务器自动开启录制，默认开启

    例如当录制文件需要自定义水印时，此参数应设为 false，由座席手动调用 JRTCAgent#controlRecord controlRecord 接口携带水印参数开启录制。

    Parameters

    • value: boolean

    Returns void

maxResolution

maxFrameRate

  • set maxFrameRate(value: number): void

  • 设置通话视频最大帧率，默认为 24

    Parameters

    • value: number

    Returns void

    Note

    当参数 #setVideoDefinition(int) videoDefinition} 为 JRTCRoomVideoDefinition.CUSTOM 时有效

svcResolution

  • set svcResolution(value: string): void

  • 设置通话 svc 分辨率，默认为 "1 180 250 360 600 720 1400"

    用于自定义分层参数和码率

    格式: 高度公约数 第一层高倍数 第一层码率 第二层高倍数 第二层码率 第三层高倍数 第三层码率 第四层高倍数 第四层码率
    说明
    1）默认宽高比16:9，即

    Parameters

    • value: string

    Returns void

    Ref

    wholeRatio
    2）编码宽高最后被裁成16整除
    例如 "1 180 250 360 600 720 1400"
    第一层 分辨率 宽320（1801/916）高 180（1801）； 码率250kbps
    第二层 分辨率 宽640（360    1/916）高 360（3601）； 码率600kbps
    第三层 分辨率 宽1280（7201/916）高 720（7201）； 码率1400kbps
    此情况下只有三层，若需要四层，则需补充为 "1 180 250 360 600 720 1400 1080 1600"
    第四层 分辨率 宽1920（1080    1/916）高 1080（10801）； 码率1600kbps

videoDefinition

  • set videoDefinition(value: JRTCRoomVideoDefinition): void

  • 设置通话视频清晰度，主要通过修改 #setSvcResolution(string) svcResolution 参数和 #setMaxFrameRate(int) maxFrameRate 参数调整清晰度， 默认为 JRTCRoom#CUSTOM CUSTOM

    Parameters

    Returns void

hbTime

  • set hbTime(value: number): void

  • 设置通话心跳间隔时间，默认为 20 秒

    心跳间隔需比心跳超时时间小。
    例如设置了心跳间隔为 X 秒，那么终端会每隔 X 秒给服务器发送心跳包。

    Parameters

    • value: number

    Returns void

hbTimeOut

  • set hbTimeOut(value: number): void

  • 设置通话心跳超时时间，默认为 60 秒

    例如设置了心跳超时时间为 X 秒，那么服务器在 X 秒内都没有收到成员心跳时，该成员会自动结束通话。

    Parameters

    • value: number

    Returns void

securityType

  • set securityType(value: JRTCRoomSecurityType): void

  • 设置通话媒体数据加密方式，默认 JRTCRoomSecurityType#SRTP 加密

    Parameters

    Returns void

    See

    • JRTCRoomSecurityType#DISABLE 不加密
    • JRTCRoomSecurityType#SRTP SRTP 加密
    • JRTCRoomSecurityType#SM4 SM4 国密加密

audioEncodeType

  • set audioEncodeType(value: JRTCAudioEncodeType): void

  • 设置通话视频编码，默认为 JRTCVideoEncodeType#H264

    Parameters

    Returns void

recordExtraInfo

  • set recordExtraInfo(value: string): void

  • 设置通话音频编码，默认为 JRTCAudioEncodeType#OPUS

    Parameters

    • value: string

    Returns void

vipPower

  • set vipPower(value: number): void

  • 设置远程录制随路参数

    录制随路参数保存在录制的info文件中，当JCGuestCallParam#autoRecord为true时此参数有效

    Parameters

    • value: number

    Returns void

channelId

  • set channelId(value: string): void

  • 设置渠道号

    Parameters

    • value: string

    Returns void

    Note

    目前该参数只在呼叫指定业务有效

traceId

  • set traceId(value: string): void

  • 设置日志跟踪ID，可选

    Parameters

    • value: string

    Returns void

serialId

  • set serialId(value: string): void

  • 设置业务流水号，保证唯一，可选

    Parameters

    • value: string

    Returns void

extraSerialId

  • set extraSerialId(value: string): void

  • 设置外部自定义业务流水号，可选

    Parameters

    • value: string

    Returns void

calleeUserId

  • set calleeUserId(value: string): void

  • 设置指定呼叫座席的用户ID

    Parameters

    • value: string

    Returns void

    Note

    目前该参数只在双录点对对呼叫业务有效

calleeBusinessNumber

  • set calleeBusinessNumber(value: string): void

  • 设置指定呼叫坐席的业务号

    Parameters

    • value: string

    Returns void

    Note

    目前该参数只在双录点对对呼叫业务有效

recordVideo

  • get recordVideo(): boolean

  • 获取录制是否包含视频

    Returns boolean

  • set recordVideo(recordVideo: boolean): void

  • 设置录制是否包含视频，false的时候服务器为录音文件aac

    Parameters

    • recordVideo: boolean

    Returns void

frameRate

  • get frameRate(): number

  • 获取录制帧率

    Returns number

  • set frameRate(frameRate: number): void

  • 设置录制帧率

    Parameters

    • frameRate: number

    Returns void

mergeMode

  • get mergeMode(): JRTCVideoMergeMode

  • 获取媒体录制视频合并模式

    Returns JRTCVideoMergeMode

  • set mergeMode(mergeMode: JRTCVideoMergeMode): void

  • 设置媒体录制视频合并模式

    Parameters

    Returns void

intelligentMergeMode

  • get intelligentMergeMode(): JRTCIntelligentMergeMode

  • 获取 mergeMode 为智能分屏模式下的布局样式（无屏幕共享）

    Returns JRTCIntelligentMergeMode

  • set intelligentMergeMode(intelligentMergeMode: JRTCIntelligentMergeMode): void

  • 设置 mergeMode 为智能分屏模式下的布局样式（无屏幕共享）

    Parameters

    Returns void

scsMergeMode

  • get scsMergeMode(): JRTCScsMergeMode

  • 获取 mergeMode 为智能分屏模式下的布局样式（有屏幕共享）

    Returns JRTCScsMergeMode

  • set scsMergeMode(scsMergeMode: JRTCScsMergeMode): void

  • 设置 mergeMode 为智能分屏模式下的布局样式（有屏幕共享）

    Parameters

    Returns void

videoWidth

  • get videoWidth(): number

  • 获取录制视频的宽度

    Returns number

  • set videoWidth(videoWidth: number): void

  • 设置录制视频的宽度

    Parameters

    • videoWidth: number

    Returns void

videoHeight

  • get videoHeight(): number

  • 获取录制视频的高度

    Returns number

  • set videoHeight(videoHeight: number): void

  • 设置录制视频的高度

    Parameters

    • videoHeight: number

    Returns void

iBitrate

  • get iBitrate(): number

  • 获取录制码率

    Returns number

  • set iBitrate(iBitrate: number): void

  • 设置录制码率

    Parameters

    • iBitrate: number

    Returns void

extraInfo

  • get extraInfo(): string

  • 获取录制自定义随路参数

    Returns string

  • set extraInfo(extraInfo: string): void

  • 设置录制自定义随路参数, json格式

    Parameters

    • extraInfo: string

    Returns void

watermarkTextMap

  • get watermarkTextMap(): any

  • 获取录制视频水印串

    Returns any

  • set watermarkTextMap(watermarkTextMap: any): void

  • 设置录制视频水印串

    Parameters

    • watermarkTextMap: any

    Returns void

layoutType

  • get layoutType(): string

  • 获取录制样式

    Returns string

  • set layoutType(layoutType: string): void

  • 设置录制样式，对应业务管理平台上录制配置中的编号ID, 不传则用默认

    Parameters

    • layoutType: string

    Returns void

layoutList

  • get layoutList(): any

  • 获取录制成员布局列表

    Returns any

  • set layoutList(layoutList: any): void

  • 设置录制成员布局列表，自定义布局需要

    Parameters

    • layoutList: any

    Returns void

fileName

  • get fileName(): string

  • 获取存储文件名

    Returns string

  • set fileName(fileName: string): void

  • 设置存储文件名, ftp模式下可以带路径如：juphoon/1.mp4 视频文件录制后缀为mp4，如xx.mp4 音频文件录制后缀为aac，如xx.aac

    Parameters

    • fileName: string

    Returns void

splitFileSize

  • get splitFileSize(): number

  • 获取录制文件分割大小，单位KB

    Returns number

  • set splitFileSize(splitFileSize: number): void

  • 设置录制文件分割大小，单位KB

    Parameters

    • splitFileSize: number

    Returns void

    Note

    传 <= 0表示不分割，默认不分割

Methods

toString

  • toString(): string

  • 转换 string

    Returns string

Settings

Member Visibility

On This Page

Accessors
Methods