Class JRTCSipInviteParam

SIP邀请参数类

Remarks

用于配置SIP呼叫的相关参数，包括用户标识、显示名称、路由方式、会议类型等。 通过此类可以设置SIP呼叫的各种属性，实现与SIP终端的互通。

Accessors

userId displayName sipUri route mcu video dtmfPassword callerNum coreNetwork serialNo

Methods

toJSON toString

Accessors

userId

  • get userId(): undefined | string

    获取用户标识

    Returns undefined | string

    当前设置的用户标识

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

    设置用户标识

    Parameters

    • userId: undefined | string

      用户标识，一般为号码

    Returns void

    Remarks

    此参数为必填项

displayName

  • get displayName(): undefined | string

    获取SIP用户加入房间后的昵称

    Returns undefined | string

    当前设置的显示名称

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

    设置SIP用户加入房间后的昵称

    Parameters

    • displayName: undefined | string

      显示名称

    Returns void

sipUri

  • get sipUri(): boolean

    获取userId类型

    Returns boolean

    当前设置的userId类型

    • true: userId是SIP URI
    • false: userId是号码
  • set sipUri(sipUri: boolean): void

    设置userId类型

    Parameters

    • sipUri: boolean

      userId类型标志

    Returns void

    Remarks

    • true: userId是SIP URI
    • false: userId是号码（默认）

route

  • get route(): boolean

    获取SIP信令路由方式

    Returns boolean

    当前设置的路由标志

    • true: SIP信令路由到userId的SIP域里
    • false: 不路由到userId的SIP域里
  • set route(route: boolean): void

    设置SIP信令路由方式

    Parameters

    • route: boolean

      路由标志

    Returns void

    Remarks

    仅当sipUri设置为true时生效，决定SIP信令是否路由到userId的SIP域里

mcu

  • get mcu(): boolean

    获取是否为MCU会议

    Returns boolean

    当前设置的MCU会议标志

    • true: 是MCU会议
    • false: 不是MCU会议
  • set mcu(mcu: boolean): void

    设置是否为MCU会议

    Parameters

    • mcu: boolean

      MCU会议标志

    Returns void

video

  • get video(): boolean

    获取是否视频接入

    Returns boolean

    当前设置的视频接入标志

    • true: 启用视频接入
    • false: 不启用视频接入
  • set video(video: boolean): void

    设置是否视频接入

    Parameters

    • video: boolean

      视频接入标志

    Returns void

dtmfPassword

  • get dtmfPassword(): undefined | string

    获取DTMF密码

    Returns undefined | string

    当前设置的DTMF密码

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

    设置DTMF密码

    Parameters

    • dtmfPassword: undefined | string

      DTMF密码

    Returns void

callerNum

  • get callerNum(): undefined | string

    获取主叫号码

    Returns undefined | string

    当前设置的主叫号码

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

    设置主叫号码

    Parameters

    • callerNum: undefined | string

      主叫号码

    Returns void

coreNetwork

  • get coreNetwork(): undefined | string

    获取SIP核心网

    Returns undefined | string

    当前设置的SIP核心网标识

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

    设置SIP核心网

    Parameters

    • coreNetwork: undefined | string

      SIP核心网标识

    Returns void

serialNo

  • get serialNo(): undefined | string

    获取关联业务号

    Returns undefined | string

    当前设置的关联业务号

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

    设置关联业务号

    Parameters

    • serialNo: undefined | string

      关联业务号

    Returns void

Methods

toJSON

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

    将参数转换为JSON对象

    Returns Record<string, undefined | string | number | boolean>

    包含所有参数的JSON对象

toString

  • toString(): string

    将参数转换为JSON字符串

    Returns string

    包含所有参数的JSON字符串

设置

主题