Flexible Classroom Web API Reference

This page provides the TypeScript API reference of the Agora Classroom SDK for Web/Electron.

AgoraEduSDK

AgoraEduSDK is the basic interface of the Agora Classroom SDK and provides the main methods that can be invoked by your app.

config

static config(params: ConfigParams):void

Configure the SDK.

Sample code

AgoraEduSDK.config({
  // Agora App ID
  appId: "<YOUR AGORA APPID>",
  // Region
  region: "NA"
})

Parameter

launch

static launch(dom: Element, option: LaunchOption):Promise<void>

Launch a classroom.

Sample code

// Configure courseware
let resourceUuid = "xxxxx"
let resourceName = "my ppt slide"
let sceneInfos = []
let sceneInfo = {
    name: "1",
    ppt: {
        src: "pptx://....",
        width: 480,
        height: 360
    }
}
sceneInfos.push(sceneInfo)

let courseWareList = [{
    resourceUuid,
    resourceName,
    size: 10000,
    updateTime: new Date().getTime(),
    ext: "pptx",
    url:null,
    scenes: sceneInfos,
    taskUuid: "xxxx",
    taskToken: "xxx",
    taskProgress: NetlessTaskProgress
}]

// Launch a classroom
AgoraEduSDK.launch(document.querySelector(`#${this.elem.id}`), {
    rtmToken: "<your rtm token>",
    userUuid: "test",
    userName: "teacher",
    roomUuid: "4321",
    roleType: 1,
    roomType: 4,
    roomName: "demo-class",
    pretest: false,
    language: "en",
    startTime: new Date().getTime(),
    duration: 60 * 30,
    courseWareList: [],
    listener: (evt) => {
        console.log("evt", evt)
    }
})

Parameter

Type definition

ConfigParams

The SDK global configuration. Used when calling AgoraEduSDK.config.

export type ConfigParams = {
    appId: string;
    region?: string;
};

LaunchOption

The classroom launching configuration. Used when calling AgoraEduSDK.launch.

export type LaunchOption = {
    userUuid: string;
    userName: string;
    roomUuid: string;
    roleType: EduRoleTypeEnum;
    roomType: EduRoomTypeEnum;
    roomName: string;
    listener: ListenerCallback;
    pretest: boolean;
    rtmToken: string;
    language: LanguageEnum;
    startTime?: number;
    duration: number;
    courseWareList: CourseWareList;
    personalCourseWareList?: CourseWareList;
    recordUrl?: string;
    extApps?: IAgoraExtApp[];
    region?: AgoraRegion;
    widgets?: {[key: string]: IAgoraWidget};
    userFlexProperties?: {[key: string]: any};
    mediaOptions?: MediaOptions;
    latencyLevel?: 1 | 2;
    platform?: Platform;
};

MediaOptions

export type MediaOptions = {
  cameraEncoderConfiguration?: EduVideoEncoderConfiguration;
  screenShareEncoderConfiguration?: EduVideoEncoderConfiguration;
  encryptionConfig?: MediaEncryptionConfig;
};

Media options.

EduVideoEncoderConfiguration

export interface EduVideoEncoderConfiguration {
  width: number;
  height: number;
  frameRate: number;
  bitrate: number;
}

Video encoder configurations.

MediaEncryptionConfig

export declare interface MediaEncryptionConfig {
  mode: MediaEncryptionMode,
  key: string
}

The media stream encryption configuration. Used in MediaOptions.

MediaEncryptionMode

export enum MediaEncryptionMode {
  AES_128_XTS = 1,
  AES_128_ECB = 2,
  AES_256_XTS = 3,
  AES_128_GCM = 5,
  AES_256_GCM = 6
}

Encryption modes. Used in MediaEncryptionConfig.

CourseWareList

The courseware pre-download configuration. Used when calling AgoraEduSDK.launch.

export type CloudDriveResourceConvertProgress = {
    totalPageSize: number;
    convertedPageSize: number;
    convertedPercentage: number;
    convertedFileList: {
        name: string;
        ppt: {
            width: number;
            height: number;
            preview?: string;
            src: string;
        };
    }[];
    currentStep: string;
};

export type CourseWareItem = {
    resourceName: string;
    resourceUuid: string;
    ext: string;
    url?: string;
    size: number;
    updateTime: number;
    taskUuid: string;
    conversion: {
        type: string;
        preview: boolean;
        scale: number;
        outputFormat: string;
    };
    taskProgress?: CloudDriveResourceConvertProgress;
};

export type CourseWareList = CourseWareItem[];

CourseWareList is an array that consists of CourseWareItem objects.

courseWareList:
[
    {
            resourceName: "mechanicalEnerg",
            resourceUuid: "c06fed32d06268431601b0e0a804e70a",
            ext: "mp4",
            url: "https://gymoo-project-cdn.oss-cn-shenzhen.aliyuncs.com/hld_education/upload/9f4d3c149e6b3acfef378aca012780b3.mp4",
            size: 4560284
    }
],

courseWareList:
[
    {
      resourceName: xxxxxxx,
      resourceUuid: xxxxxxxxx,
      ext: 'pptx',
      url: 'https://xxxxxxxxxxxxxx',
      size: 0,
      updateTime: xxxxxxxx
      taskUuid: 'xxxxxxxxx',
      conversion: {
            type: 'dynamic',
            preview: true,
            scale: 2,
            outputFormat: 'png',
            },
      taskProgress: {
        totalPageSize: 3,
        convertedPageSize: 3,
        convertedPercentage: 100,
        convertedFileList: [
            {
                name: '1',
                ppt: {
                    src: 'pptx://convertcdn.netless.link/dynamicConvert/3bxxxxxxx/1.slide',
                    width: 1280,
                    height: 720,
                    preview:'dddddddddddddddurl'
                },
            },
            ...
        ] as any,
        currentStep: '',
        },
    },
],

EduRoleTypeEnum

export enum EduRoleTypeEnum {
  audience = 0,
  teacher = 1,
  student = 2,
  assistant = 3
}

The role of the user in the classroom. Set in LaunchOption.

EduRoomTypeEnum

export enum EduRoomTypeEnum {
  Room1v1Class = 0,
  RoomBigClass = 2,
  RoomSmallClass = 4
}

The classroom type. Set in LaunchOption.

LanguageEnum

export type LanguageEnum = "en" | "zh"

The language of the user interface. Set in LaunchOption.