Classroom SDK TypeScript API Reference

本页提供 Agora Classroom SDK for Web/Electron 的 TypeScript API 参考。

AgoraEduSDK

AgoraEduSDK 是 Agora Classroom SDK 的基础接口类，包含供 App 调用的主要接口。

config

static config(params: ConfigParams):void

配置 SDK。

launch

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

启动课堂。

参数

类型定义

ConfigParams

SDK 全局配置。用于 AgoraEduSDK.config 方法。

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

LaunchOption

课堂启动配置。用于 AgoraEduSDK.launch 方法。

export type LaunchOption = {
    userUuid: string;
    userName: string;
    roomUuid: string;
    roleType: EduRoleTypeEnum;
    roomType: EduRoomTypeEnum;
    roomSubtype?: EduRoomSubtypeEnum;
    roomServiceType?: EduRoomServiceTypeEnum;
    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;
    channelProfile?: ChannelProfile;
    web?: {
        codec: SDK_CODEC;
        mode: SDK_MODE;
    };
};

媒体流相关设置。

EduVideoEncoderConfiguration

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

视频编码参数配置。

• 在小班课中，视频编码参数的默认值为 120p（160×120），200 Kbps，15 fps。
• 在一对一和大班课中，视频编码参数的默认值为 240p（320×240），65 Kbps，15 fps。

MediaEncryptionConfig

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

媒体流加密配置，用于 MediaOptions。

ChannelProfile

export enum ChannelProfile {
  Communication = 0,
  LiveBroadcasting = 1,
}

频道配置，用于 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,
}

媒体流加密模式，用于 MediaEncryptionConfig。

CourseWareList

课件预加载配置。用于 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 为 CourseWareItem 对象组成的数组。

courseWareList:
[
    {
            resourceName: "机械能",
            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: '',
        },
    },
],

CourseWareItem 包含以下参数：

EduRoleTypeEnum

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

用户在课堂中的角色。在 LaunchOption 中设置。

EduRoomTypeEnum

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

课堂类型。在 LaunchOption 中设置。

EduRoomSubtypeEnum

export enum EduRoomSubtypeEnum {
    Standard = 0,
    Vocational = 1,
}

课堂子类型。在 LaunchOption 中设置。

EduRoomServiceTypeEnum

export enum EduRoomServiceTypeEnum {
  LivePremium = 0,
  LiveStandard = 1,
  CDN = 2,
  Fusion = 3,
  MixStreamCDN = 4,
  HostingScene = 5,
}

职业教育大班课使用的服务类型。在 LaunchOption 中设置。

注意：EduRoomServiceTypeEnum 仅在 EduRoomTypeEnum 为 RoomBigClass(2) 且 EduRoomSubtypeEnum 为 Vocational(1) 的情况下有效。

LanguageEnum

export type LanguageEnum = "en" | "zh";

界面语言。在 LaunchOption 中设置。