Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EduClassroomConfig

Hierarchy

  • EduClassroomConfig

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new EduClassroomConfig(appId: string, sessionInfo: EduSessionInfo, recordUrl: string, rteOpts?: AgoraRteOptions, platform?: Platform, options?: { openCameraDeviceAfterLaunch?: boolean; openRecordingDeviceAfterLaunch?: boolean; recordRetryTimeout?: number }): EduClassroomConfig

  • Parameters

    • appId: string
    • sessionInfo: EduSessionInfo
    • recordUrl: string
    • Optional rteOpts: AgoraRteOptions
    • Optional platform: Platform
    • Optional options: { openCameraDeviceAfterLaunch?: boolean; openRecordingDeviceAfterLaunch?: boolean; recordRetryTimeout?: number }
      • Optional openCameraDeviceAfterLaunch?: boolean
      • Optional openRecordingDeviceAfterLaunch?: boolean
      • Optional recordRetryTimeout?: number

    Returns EduClassroomConfig

Properties

Readonly appId

appId: string

boardDefaults

boardDefaults: WhiteboardDefaults

Readonly platform

platform: Platform

Readonly recordUrl

recordUrl: string

Accessors

headers

  • get headers(): Record<string, string | number>

  • Returns Record<string, string | number>

host

  • get host(): undefined | string
  • set host(host: undefined | string): void

  • Returns undefined | string

  • Parameters

    • host: undefined | string

    Returns void

ignoreUrlRegionPrefix

  • get ignoreUrlRegionPrefix(): boolean
  • set ignoreUrlRegionPrefix(ignoreUrlRegionPrefix: boolean): void

  • Returns boolean

  • Parameters

    • ignoreUrlRegionPrefix: boolean

    Returns void

isLowAPIVersionCompatibleRequired

  • get isLowAPIVersionCompatibleRequired(): boolean

  • Returns boolean

openCameraDeviceAfterLaunch

  • get openCameraDeviceAfterLaunch(): boolean

  • Returns boolean

openRecordingDeviceAfterLaunch

  • get openRecordingDeviceAfterLaunch(): boolean

  • Returns boolean

recordRetryTimeout

  • get recordRetryTimeout(): number

  • Returns number

rteEngineConfig

sessionInfo

Static shared

Methods

setCompatibleVersions

  • setCompatibleVersions(compatibleVersions: string[]): void

  • Parameters

    • compatibleVersions: string[]

    Returns void

Static defaultLowStreamParameter

  • defaultLowStreamParameter(): { bitrate: number; frameRate: number; height: number; width: number }

  • Returns { bitrate: number; frameRate: number; height: number; width: number }

    • bitrate: number
    • frameRate: number
    • height: number
    • width: number

Static defaultMediaOptions

  • Parameters

    Returns { bitrate: number; frameRate: number; height: number; width: number }

    • bitrate: number
    • frameRate: number
    • height: number
    • width: number

Static getRtcVersion

  • getRtcVersion(): string

  • Returns string

Static getVersion

  • getVersion(): string

  • Returns string

Static setConfig