UI Scene SDK

static launch(
  dom: HTMLElement,
  option: LaunchOptions,
  callbackSuccess?: () => void,
  callbackFailure?: (err: Error) => void,
  callbackDestroy?: (type: number) => void
): () => void

export type LaunchOptions = {
  appId: string;
  region: EduRegion;
  language: Language;
  userUuid: string;
  userName: string;
  roleType: EduRoleTypeEnum;
  token: string;
  roomUuid: string;
  roomName: string;
  roomType: EduRoomTypeEnum;
  startTime?: number;
  duration: number;
  devicePretest: boolean;
  coursewareList?: CoursewareList;
  userFlexProperties?: { [key: string]: unknown };
  latencyLevel?: AgoraLatencyLevel;
  recordUrl?: string;
  recordRetryTimeout?: number;
  virtualBackgroundImages?: string[];
  webrtcExtensionBaseUrl?: string;
  mediaOptions?: LaunchMediaOptions;
  shareUrl?: string;
  widgets?: Record<string, typeof FcrUISceneWidget>;
  rtcCloudProxyType?: AgoraCloudProxyType;
  rtmCloudProxyEnabled?: boolean;
};

export type LaunchMediaOptions = {
  cameraEncoderConfiguration?: EduVideoEncoderConfiguration;
  screenShareEncoderConfiguration?: EduVideoEncoderConfiguration;
  encryptionConfig?: MediaEncryptionConfig;
  web?: {
    codec: SDK_CODEC;
    mode: SDK_MODE;
  };
};

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

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