agora-classroom-sdk
Version:
For publishing npm package agora-classroom-sdk (Web & Electron). Get more information from https://docs.agora.io
64 lines (63 loc) • 1.51 kB
TypeScript
import { EduRoleTypeEnum, EduStream } from 'agora-edu-core';
import { AgoraFromUser } from 'agora-rte-sdk';
export declare type VideoPlacement = 'Window' | 'Bar' | 'Setting' | 'Gallery';
/**
* 业务流 UI 对象
*/
export declare class EduStreamUI {
private _renderAt;
readonly stream: EduStream;
constructor(stream: EduStream);
get micIconType(): "microphone-disabled" | "microphone-on" | "microphone-off";
get isCameraMuted(): boolean;
get isMicMuted(): boolean;
get fromUser(): AgoraFromUser;
get isMirrorMode(): boolean;
get role(): EduRoleTypeEnum;
get renderAt(): VideoPlacement;
setRenderAt(at: VideoPlacement): void;
}
export interface StreamBounds {
readonly x: number;
readonly y: number;
readonly width: number;
readonly height: number;
readonly top: number;
readonly right: number;
readonly bottom: number;
readonly left: number;
[key: string]: number;
}
/**
* 视频流占位符类型
*/
export declare enum CameraPlaceholderType {
/**
* 摄像头打开
*/
none = "none",
/**
* 设备正在打开
*/
loading = "loading",
/**
* 摄像头关闭
*/
muted = "muted",
/**
* 摄像头损坏
*/
broken = "broken",
/**
* 摄像头禁用
*/
disabled = "disabled",
/**
* 老师不在教室
*/
notpresent = "notpresent",
/**
* 老师摄像头占位符(大小窗场景)
*/
nosetup = "nosetup"
}