Class JRTCCallCenterCallParam

呼叫中心呼叫参数配置类

Remarks

此类用于配置呼叫中心各类呼叫的参数，包括通话质量、媒体编码、录制配置、心跳设置等。 通过合理配置这些参数，可以控制通话质量、安全性和系统稳定性。 该类继承自JRTCRecordRemoteParam，可使用其中的录制相关配置。

Hierarchy (View Summary)

Accessors

sip video autoRecord wholeRatio maxResolution maxFrameRate svcResolution videoDefinition hbTime hbTimeOut securityType videoEncodeType 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 toJSON

Accessors

sip

  • set sip(value: boolean): void

    设置是否使用SIP协议进行呼叫

    Parameters

    • value: boolean

      是否使用SIP协议，true表示使用SIP协议，false表示不使用

    Returns void

    Remarks

    目前SIP呼叫仅支持座席回呼场景。默认值为false。

video

  • set video(value: boolean): void

    设置是否进行视频呼叫

    Parameters

    • value: boolean

      是否进行视频呼叫，true表示视频呼叫，false表示音频呼叫

    Returns void

    Remarks

    此参数目前仅在SIP呼叫场景下有效。默认值为true。

autoRecord

  • set autoRecord(value: boolean): void

    设置是否由服务器自动开启录制

    Parameters

    • value: boolean

      是否自动开启录制，true表示自动开启，false表示不自动开启

    Returns void

    Remarks

    默认值为true。当需要自定义录制参数（如添加水印）时，应设置为false， 然后由座席通过调用JRTCAgent#controlRecord接口并携带自定义参数来开启录制。

wholeRatio

  • set wholeRatio(value: number): void

    设置视频画面宽高比

    Parameters

    • value: number

      宽高比值，默认为1.77777（16:9）

    Returns void

    Remarks

    此参数影响视频画面的比例，通常使用16:9（约1.77777）或4:3（约1.33333）。

maxResolution

  • set maxResolution(value: JRTCResolution): void

    设置通话视频最大分辨率

    Parameters

    Returns void

    Remarks

    此参数决定了视频通话的最大清晰度上限。较高的分辨率提供更清晰的画面，但会消耗更多带宽和处理资源。

maxFrameRate

  • set maxFrameRate(value: number): void

    设置通话视频最大帧率

    Parameters

    • value: number

      最大帧率，默认为24帧/秒

    Returns void

    Remarks

    此参数仅当videoDefinition设置为JRTCRoomVideoDefinition.CUSTOM时有效。 较高的帧率可提供更流畅的视频体验，但会消耗更多带宽和处理资源。

svcResolution

  • set svcResolution(value: string): void

    设置通话SVC（可伸缩视频编码）分辨率参数

    Parameters

    • value: string

      SVC分辨率参数字符串，默认为"1 180 250 360 600 720 1400"

    Returns void

    Remarks

    此参数用于自定义分层参数和码率。格式为： "高度公约数 第一层高倍数 第一层码率 第二层高倍数 第二层码率 ..."

    默认宽高比为16:9（由wholeRatio确定）。编码宽高最终会被裁剪为16的整数倍。

    以默认值"1 180 250 360 600 720 1400"为例：

    • 第一层：分辨率320×180，码率250kbps
    • 第二层：分辨率640×360，码率600kbps
    • 第三层：分辨率1280×720，码率1400kbps

    若需要添加第四层，可设置为"1 180 250 360 600 720 1400 1080 1600"， 这将增加第四层：分辨率1920×1080，码率1600kbps。

videoDefinition

  • set videoDefinition(value: JRTCRoomVideoDefinition): void

    设置通话视频清晰度预设

    Parameters

    Returns void

    Remarks

    此参数通过修改svcResolution和maxFrameRate参数来调整清晰度。 当设置为CUSTOM时，将使用用户自定义的参数。 当设置为其他预设值时，系统会自动设置相应的SVC分辨率和帧率。

hbTime

  • set hbTime(value: number): void

    设置通话心跳间隔时间

    Parameters

    • value: number

      心跳间隔时间，单位为秒，默认为20秒

    Returns void

    Remarks

    心跳间隔需小于心跳超时时间hbTimeOut。 终端会每隔设定的秒数向服务器发送一次心跳包，用于维持连接状态。

hbTimeOut

  • set hbTimeOut(value: number): void

    设置通话心跳超时时间

    Parameters

    • value: number

      心跳超时时间，单位为秒，默认为60秒

    Returns void

    Remarks

    当服务器在设定的时间内未收到成员的心跳包时，将自动结束该成员的通话。 此参数应大于心跳间隔时间hbTime。

securityType

  • set securityType(value: JRTCRoomSecurityType): void

    设置通话媒体数据加密方式

    Parameters

    Returns void

    Remarks

    可选的加密方式包括：

    加密可提高通话安全性，但可能会略微增加延迟和处理负担。

videoEncodeType

  • set videoEncodeType(value: JRTCVideoEncodeType): void

    设置通话视频编码类型

    Parameters

    Returns void

    Remarks

    不同的编码类型具有不同的压缩效率和兼容性特性。

audioEncodeType

  • set audioEncodeType(value: JRTCAudioEncodeType): void

    设置通话音频编码类型

    Parameters

    Returns void

    Remarks

    不同的编码类型具有不同的音质、压缩效率和兼容性特性。

recordExtraInfo

  • set recordExtraInfo(value: undefined | string): void

    设置远程录制随路参数

    Parameters

    • value: undefined | string

      录制随路参数字符串

    Returns void

    Remarks

    录制随路参数将保存在录制的info文件中，仅当autoRecord为true时有效。 可用于添加自定义信息到录制文件中，便于后期查询和管理。

vipPower

  • set vipPower(value: number): void

    设置VIP权限等级

    Parameters

    • value: number

      VIP权限等级值，默认为0

    Returns void

    Remarks

    权限等级用于控制用户在通话中的特殊权限。

channelId

  • set channelId(value: undefined | string): void

    设置渠道号

    Parameters

    • value: undefined | string

      渠道号字符串

    Returns void

    Remarks

    目前该参数仅在呼叫指定业务时有效。用于标识呼叫来源的渠道。

traceId

  • set traceId(value: undefined | string): void

    设置日志跟踪ID

    Parameters

    • value: undefined | string

      日志跟踪ID字符串

    Returns void

    Remarks

    可用于在多个系统间跟踪同一会话的日志，便于问题排查。此参数为可选项。

serialId

  • set serialId(value: undefined | string): void

    设置业务流水号

    Parameters

    • value: undefined | string

      业务流水号字符串，需保证唯一性

    Returns void

    Remarks

    用于唯一标识一次业务操作，可用于后续查询和关联。此参数为可选项。

extraSerialId

  • set extraSerialId(value: undefined | string): void

    设置外部自定义业务流水号

    Parameters

    • value: undefined | string

      外部自定义业务流水号字符串

    Returns void

    Remarks

    可用于与外部系统的业务关联。此参数为可选项。

calleeUserId

  • set calleeUserId(value: undefined | string): void

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

    Parameters

    • value: undefined | string

      座席用户ID字符串

    Returns void

    Remarks

    目前该参数仅在双录点对点呼叫业务中有效。用于指定要呼叫的特定座席。

calleeBusinessNumber

  • set calleeBusinessNumber(value: undefined | string): void

    设置指定呼叫座席的业务号

    Parameters

    • value: undefined | string

      座席业务号字符串

    Returns void

    Remarks

    目前该参数仅在双录点对点呼叫业务中有效。用于指定要呼叫的特定业务线路。

recordVideo

  • get recordVideo(): boolean

    获取录制是否包含视频

    Returns boolean

    是否包含视频

  • set recordVideo(recordVideo: boolean): void

    设置录制是否包含视频

    Parameters

    • recordVideo: boolean

      是否包含视频

    Returns void

    Remarks

    当设置为false时，服务器将只录制音频文件(aac格式)

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

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

    Returns JRTCIntelligentMergeMode

    智能分屏布局模式

  • set intelligentMergeMode(intelligentMergeMode: JRTCIntelligentMergeMode): void

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

    Parameters

    Returns void

scsMergeMode

  • get scsMergeMode(): JRTCScsMergeMode

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

    Returns JRTCScsMergeMode

    屏幕共享时的布局模式

  • set scsMergeMode(scsMergeMode: JRTCScsMergeMode): void

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

    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

    视频码率（kbps）

  • set iBitrate(iBitrate: number): void

    设置录制码率

    Parameters

    • iBitrate: number

      视频码率（kbps）

    Returns void

extraInfo

  • get extraInfo(): undefined | string

    获取录制自定义随路参数

    Returns undefined | string

    JSON格式的自定义参数

  • set extraInfo(extraInfo: undefined | string): void

    设置录制自定义随路参数

    Parameters

    • extraInfo: undefined | string

      JSON格式的自定义参数

    Returns void

watermarkTextMap

  • get watermarkTextMap(): any

    获取录制视频水印串

    Returns any

    水印文本映射

  • set watermarkTextMap(watermarkTextMap: any): void

    设置录制视频水印串

    Parameters

    • watermarkTextMap: any

      水印文本映射

    Returns void

layoutType

  • get layoutType(): undefined | string

    获取录制样式

    Returns undefined | string

    录制样式ID

  • set layoutType(layoutType: undefined | string): void

    设置录制样式

    Parameters

    • layoutType: undefined | string

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

    Returns void

layoutList

  • get layoutList(): any

    获取录制成员布局列表

    Returns any

    自定义布局列表

  • set layoutList(layoutList: any): void

    设置录制成员布局列表

    Parameters

    • layoutList: any

      自定义布局列表

    Returns void

    Remarks

    仅在自定义布局模式下需要设置

fileName

  • get fileName(): undefined | string

    获取存储文件名

    Returns undefined | string

    存储文件名

  • set fileName(fileName: undefined | string): void

    设置存储文件名

    Parameters

    • fileName: undefined | string

      存储文件名

    Returns void

    Remarks

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

splitFileSize

  • get splitFileSize(): number

    获取录制文件分割大小

    Returns number

    文件分割大小，单位KB

  • set splitFileSize(splitFileSize: number): void

    设置录制文件分割大小

    Parameters

    • splitFileSize: number

      文件分割大小，单位KB

    Returns void

    Remarks

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

Methods

toString

  • toString(): string

    将参数转换为字符串

    Returns string

    所有参数的JSON字符串表示

    Remarks

    此方法将所有参数转换为JSON字符串格式，便于日志记录和调试。

toJSON

  • toJSON(): Record<string, undefined | Object>

    将参数转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有参数的JSON对象

    Remarks

    此方法用于将参数序列化，便于传输或存储。 返回的对象包含当前类的所有参数及父类JRTCRecordRemoteParam的参数。

设置

主题