加入房间参数

Hierarchy

  • JRTCBeanBase
    • JRTCRoomJoinParam

Constructors

Accessors

  • set protocol(protocol): void
  • 设置接入协议

    Parameters

    • protocol: "WEBRTC" | "RTMP"

    Returns void

  • set server(server): void
  • 设置接入服务器地址

    Parameters

    • server: string

    Returns void

  • set extraInfo(extraInfo): void
  • 设置随路参数

    Parameters

    • extraInfo: string

    Returns void

  • set securityType(securityType): void
  • 设置加密方式

    Parameters

    Returns void

  • set enableRemoteRecord(enableRemoteRecord): void
  • 设置是否需要服务器录制

    Parameters

    • enableRemoteRecord: boolean

      true: 开启

      • false: 不开启

    Returns void

  • set password(password): void
  • 设置密码,默认为 “123456”

    Parameters

    • password: string

    Returns void

  • set video(video): void
  • 设置房间是否支持视频

    Parameters

    • video: boolean

      true: 支持

      • false: 不支持

    Returns void

  • set smoothMode(smoothMode): void
  • 设置是否开启平滑模式,默认关闭

    Parameters

    • smoothMode: boolean

      true: 开启

      • false: 不开启

    Returns void

  • set wholeRatio(wholeRatio): void
  • 设置全局宽高比,默认为 16 : 9

    Parameters

    • wholeRatio: number

    Returns void

  • set maxFrameRate(maxFrameRate): void
  • 最大帧率 1- 30,默认为 24

    Parameters

    • maxFrameRate: number

    Returns void

  • set svcResolution(svcResolution): void
  • svc分辨率,默认为 "1 180 250 360 600 720 1400"

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

    格式: 高度公约数 第一层高倍数 第一层码率 第二层高倍数 第二层码率 第三层高倍数 第三层码率 第四层高倍数 第四层码率
    说明
    1)默认宽高比16:9,即 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

    Parameters

    • svcResolution: string

    Returns void

  • set heartbeatTime(heartbeatTime): void
  • 心跳间隔,默认为 20 秒

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

    Parameters

    • heartbeatTime: number

    Returns void

  • set heartbeatTimeout(heartbeatTimeout): void
  • 心跳超时时间,默认为 60 秒

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

    Parameters

    • heartbeatTimeout: number

    Returns void

  • set capacity(capacity): void
  • 房间最大人数,默认值为 6

    Parameters

    • capacity: number

    Returns void

  • set uploadLocalAudio(uploadLocalAudio): void
  • 设置是否上传本地音频

    Parameters

    • uploadLocalAudio: boolean

    Returns void

  • set uploadLocalVideo(uploadLocalVideo): void
  • 设置是否上传本地视频

    Parameters

    • uploadLocalVideo: boolean

    Returns void

  • set multiStream(multiStream): void
  • 设置分流合流,默认为true,true表示分流

    Parameters

    • multiStream: boolean

    Returns void

  • set traceId(value): void
  • 设置日志跟踪ID

    Parameters

    • value: undefined | string

    Returns void

Generated using TypeDoc