Class JRTCCallJoinParam

加入通话配置参数类，作为 join 方法 joinParam 参数的入参

Hierarchy

  • JRTCRoomJoinParam
    • JRTCCallJoinParam

Accessors

inviteCalleeUserId inviteCalleeUserType callerNumberForSip routeId viewerJoin video enableRemoteRecord cdn password smoothMode wholeRatio maxResolution maxFrameRate svcResolution videoDefinition heartbeatTime heartbeatTimeout capacity uploadLocalAudio uploadLocalVideo securityType videoEncodeType videoEncoderAutoFallback audioEncodeType traceId serialId extraSerialId jsmiOid otherParam extraInfo openAudioInput openAudioOutput role minSendBwe maxSendBwe minReceiveBwe maxReceiveBwe

Methods

toJSON

Accessors

inviteCalleeUserId

  • set inviteCalleeUserId(value: string): void

  • 设置被邀请者用户ID

    Parameters

    • value: string

    Returns void

    Note

    如果不为空，会在自身加入通话同时邀请用户加入

inviteCalleeUserType

  • set inviteCalleeUserType(value: JRTCCallUserType): void

  • 设置被邀请者用户类型，默认APP用户

    Parameters

    Returns void

    Note

    当被邀请者用户ID不为空时，该值有效

    See

    • JRTCCall#USER_TYPE_APP APP用户
    • JRTCCall#USER_TYPE_SIP SIP用户

callerNumberForSip

  • set callerNumberForSip(value: string): void

  • 设置sip外呼主叫号码

    Parameters

    • value: string

    Returns void

    Note

    当被邀请者用户类型是SIP用户的时候有效

routeId

  • set routeId(value: string): void

  • 设置sip外呼线路ID

    Parameters

    • value: string

    Returns void

    Note

    当被邀请者用户类型是SIP用户的时候有效

viewerJoin

  • set viewerJoin(value: boolean): void

  • 设置是否以观众身份加入房间（无感加入），默认 false

    Parameters

    • value: boolean

    Returns void

    Note

    如果设置 true，加入房间后，其他房间内成员不会收到该成员加入通知，该成员也不支持上传本地音视频流

video

  • set video(value: boolean): void

  • 设置房间是否支持视频，默认支持

    Parameters

    • value: boolean

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

enableRemoteRecord

  • set enableRemoteRecord(value: boolean): void

  • 设置是否需要远程录制，默认不需要远程录制

    Parameters

    • value: boolean

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

    Note

    设置 true，并没有真正开启远程录制，只是通知服务端这个房间需要远程录制，加入房间后， 需要通过接口 JRTCRoom#enableRemoteRecord(boolean, JRTCRecordRemoteParam | undefined) enableRemoteRecord 去开启远程录制

    • true: 需要远程录制
    • false: 不需要远程录制

cdn

  • set cdn(value: string): void

  • 设置推流地址，默认为 undefined

    Parameters

    • value: string

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

password

  • set password(value: string): void

  • 设置房间密码，默认为 "123456"

    Parameters

    • value: string

    Returns void

    Note

    如果是首个加入房间成员，那么就是设置房间密码，否则就是加入房间密码

smoothMode

  • set smoothMode(value: boolean): void

  • 设置房间视频是否开启平滑模式，默认不开启

    • true: 开启
    • false: 不开启

    Parameters

    • value: boolean

    Returns void

wholeRatio

  • set wholeRatio(value: number): void

  • 设置房间视频全局宽高比，默认为 16/9

    Parameters

    • value: number

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

maxResolution

  • set maxResolution(value: JRTCResolution): void

  • 设置房间视频最大分辨率，默认为 JRTCEnum#RESOLUTION_720p

    Parameters

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

    当 setSvcResolution(String) svcResolution} 有值时，此参数设置无效，建议使用 setSvcResolution(String) svcResolution}

maxFrameRate

  • set maxFrameRate(value: number): void

  • 设置房间视频最大帧率 1-30, 默认值为 24

    Parameters

    • value: number

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

    Note

    当参数 #setVideoDefinition(int) videoDefinition} 为 JRTCRoom#DEFINITION_CUSTOM DEFINITION_CUSTOM 时有效

svcResolution

  • set svcResolution(value: string): void

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

    Parameters

    • value: string

    Returns void

    Note

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

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

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

    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

    Note

    房间全局属性，第一个加入房间成员设置成效

videoDefinition

  • set videoDefinition(value: JRTCRoomVideoDefinition): void

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

    Parameters

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

heartbeatTime

  • set heartbeatTime(value: number): void

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

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

    Parameters

    • value: number

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

heartbeatTimeout

  • set heartbeatTimeout(value: number): void

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

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

    Parameters

    • value: number

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

capacity

  • set capacity(value: number): void

  • 设置房间最大人数，默认值为 6

    Parameters

    • value: number

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

uploadLocalAudio

  • set uploadLocalAudio(value: boolean): void

  • 设置是否上传本地音频，默认上传

    • true: 上传
    • false: 不上传

    Parameters

    • value: boolean

    Returns void

uploadLocalVideo

  • set uploadLocalVideo(value: boolean): void

  • 设置是否上传本地视频，默认上传

    • true: 上传
    • false: 不上传

    Parameters

    • value: boolean

    Returns void

securityType

  • set securityType(value: JRTCRoomSecurityType): void

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

    Parameters

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

    See

    • JRTCRoomSecurityType.SECURITY_TYPE_DISABLE 不加密
    • JRTCRoomSecurityType.SECURITY_TYPE_SRTP SRTP 加密
    • JRTCRoomSecurityType.SECURITY_TYPE_SM4 SM4 国密加密

videoEncodeType

  • set videoEncodeType(value: JRTCVideoEncodeType): void

  • 设置房间视频编码，默认为 JRTCEnum#VIDEO_ENCODE_TYPE_H264，

    Parameters

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

videoEncoderAutoFallback

  • set videoEncoderAutoFallback(value: boolean): void

  • 设置是否开启视频编码自动回落功能，默认开启 场景：开启后，当设置房间视频编码为 AV1 时，如果当前设备性能不足导致编码时间过长则自动回落到 H264 编码

    Parameters

    • value: boolean

    Returns void

    Note

    房间全局属性，第一个加入房间成员设置成效

audioEncodeType

  • set audioEncodeType(value: JRTCAudioEncodeType): void

  • 设置房间音频编码，默认为 JRTCEnum#AUDIO_ENCODE_TYPE_OPUS

    Parameters

    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

jsmiOid

  • set jsmiOid(value: string): void

  • 设置房间实例ID，可选

    Parameters

    • value: string

    Returns void

    Note

    使用场景举例：多中心场景，服务端没有部署 redis 服务，可通过该方式结合 #otherParam 加入指定中心创建的房间

otherParam

  • set otherParam(value: Record<string, Object>): void

  • 设置通过房间实例ID加入房间场景的其他参数，可选

    Parameters

    • value: Record<string, Object>

    Returns void

    Note

    使用场景举例：多中心场景，服务端没有部署 redis 服务，可通过该方式结合 #jsmiOid 加入指定中心创建的房间

extraInfo

  • set extraInfo(value: any): void

  • 设置随路参数

    Parameters

    • value: any

    Returns void

openAudioInput

  • set openAudioInput(openAudioInput: boolean): void

  • 设置是否主动打开音频输入

    Parameters

    • openAudioInput: boolean

    Returns void

openAudioOutput

  • set openAudioOutput(openAudioOutput: boolean): void

  • 设置是否主动打开音频输出

    Parameters

    • openAudioOutput: boolean

    Returns void

role

  • set role(value: number): void

  • 设置角色

    Parameters

    • value: number

    Returns void

minSendBwe

  • get minSendBwe(): number

  • 获取最小发送估计带宽，单位 bps，默认值 1500

    Returns number

    最小发送估计带宽

  • set minSendBwe(minSendBwe: number): void

  • 设置最小发送估计带宽，单位 bps，默认值 1500

    Parameters

    • minSendBwe: number

      最小发送估计带宽

    Returns void

maxSendBwe

  • get maxSendBwe(): number

  • 获取最大发送估计带宽，单位 bps，默认值 5000

    Returns number

    最大发送估计带宽

  • set maxSendBwe(maxSendBwe: number): void

  • 设置最大发送估计带宽，单位 bps，默认值 5000

    Parameters

    • maxSendBwe: number

      最小发送估计带宽

    Returns void

minReceiveBwe

  • get minReceiveBwe(): number

  • 获取最小接收估计带宽，单位 bps，默认值 1500

    Returns number

    最小接收估计带宽

  • set minReceiveBwe(minReceiveBwe: number): void

  • 设置最小接收估计带宽，单位 bps，默认值 1500

    Parameters

    • minReceiveBwe: number

      最小发送估计带宽

    Returns void

maxReceiveBwe

  • get maxReceiveBwe(): number

  • 获取最大接收估计带宽，单位 bps，默认值 5000

    Returns number

    最大接收估计带宽

  • set maxReceiveBwe(maxReceiveBwe: number): void

  • 设置最大接收估计带宽，单位 bps，默认值 5000

    Parameters

    • maxReceiveBwe: number

      最大接收估计带宽

    Returns void

Methods

toJSON

  • toJSON(): Record<string, Object>

  • 转换JSON

    Returns Record<string, Object>

Settings

Member Visibility

On This Page

Accessors
Methods