urtc-sdk-web/types/index.d.ts

export declare type VideoCodec = 'vp8' | 'h264';
export declare type AudioCodec = 'opus';

export declare type RoomType = 'rtc' | 'live';
export declare type UserRole = 'pull' | 'push' | 'push-and-pull';
export declare type DeviceType = 'audio' | 'video';

// 业务方使用的事件类型
export declare type EventType =
  | 'user-added'
  | 'user-removed'
  | 'stream-added'
  | 'stream-removed'
  | 'stream-published'
  | 'stream-subscribed'
  | 'mute-video'
  | 'unmute-video'
  | 'mute-audio'
  | 'unmute-audio'
  | 'screenshare-stopped'
  | 'connection-state-change'
  | 'kick-off'
  | 'network-quality'
  | 'stream-reconnected'
  | 'record-notify'
  | 'relay-notify';

export declare type ConnectionState = 'OPEN' | 'CONNECTING' | 'CLOSING' | 'RECONNECTING' | 'CLOSED';

export declare type WaterMarkPosition = 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom'; // 左上，左下，右上，右下
export declare type WaterMarkType = 'time' | 'image' | 'text';
export declare type MainViewType = 'desktop' | 'screen' | 'camera'; // todo - remove desktop

export declare type NetworkQuality = '0' | '1' | '2' | '3' | '4' | '5' | '6';

export interface ClientOptions {
  type?: RoomType;
  role?: UserRole;
  codec?: VideoCodec; // 可设 vp8 或 h264，默认为 h264
}

export interface Codecs {
  audio: Array<AudioCodec>;
  video: Array<VideoCodec>;
}

declare type FacingMode = 'user' | 'environment' | 'left' | 'right';

export interface PublishOptions {
  audio: boolean; // 是否开启麦克风
  video: boolean; // 是否开启摄像头
  screen: boolean; // 是否共享屏幕
  facingMode?: FacingMode; // 指定使用的摄像头
  microphoneId?: string; // 麦克风设备ID
  cameraId?: string; // 摄像头设备ID
  extensionId?: string; // chrome插件ID
  mediaStream?: MediaStream; // 自定义的媒体流
  file?: File; // 图片流使用的图片文件
  filePath?: string; // 图片流使用的图片的地址
  previewId?: string; // 预览流ID
}

export interface PreviewStreamOptions extends PublishOptions {
  previewId: string; // 预览流ID
}

export interface DeviceOptions {
  audio: boolean; // 是否开启麦克风
  video: boolean; // 是否开启摄像头
  facingMode?: FacingMode;
  microphoneId?: string; // 麦克风设备ID
  cameraId?: string; // 摄像头设备ID
}

export interface DeviceDetectionOptions {
  audio: boolean; // 必填，指定是否检测麦克风设备
  video: boolean; // 必填，指定是否检测摄像头设备
  microphoneId?: string; // 选填，指定需要检测的麦克风设备的ID，可通过 getMicrophones 方法查询获得该ID，不填时，将检测默认的麦克风设备
  cameraId?: string; // 选填，指定需要检测的摄像头设备的ID，可以通过 getCameras 方法查询获得该ID，不填时，将检测默认的摄像头设备
}

export interface DeviceDetectionResult {
  audio: boolean;
  audioError?: string;
  video: boolean;
  videoError?: string;
}

export interface User {
  uid: string; // 用户ID
}

export interface Stream {
  previewId?: string; // 预览Id
  sid: string; // 流ID
  uid: string; // 对应的用户的ID
  type: 'publish' | 'subscribe' | 'preview'; // 流类型
  mediaType?: 'camera' | 'screen'; // 流的媒体类型，用于对发布流的区分
  video: boolean; // 是否包含音频
  audio: boolean; // 是否包含视频
  muteAudio: boolean; // 音频是否静音
  muteVideo: boolean; // 视频是否静音
  mediaStream?: MediaStream; // 业务侧自定义媒体流
}

export interface LeaveRoomOptions {
  keepRecording: boolean; // 是否保持服务端录制，默认不保持
}

export interface AudioVolumeOptions {
  streamId?: string;
  element?: HTMLMediaElement;
  volume: number;
}

export interface WaterMarkOptions {
  position?: WaterMarkPosition;
  type?: WaterMarkType; // 水印类型
  remarks?: string; // 水印备注
}

export interface MixStreamOptions {
  width?: number; // 混流后视频的宽度
  height?: number; // 混流后视频的高度
  template?: number; // 混流模板，对应不同的录制布局
  isAverage?: boolean; // 是否均匀，均分对应平铺，不均分对应垂直
}

export interface RelayOptions {
  time?: number; // 转推开启时间的时间戳，不填时，将默认使用当前时间的时间戳
  fragment: number; // 切片
}

export interface RecordOptions {
  bucket: string;
  region: string;
  uid?: string; // 指定某用户的流为主画面
  mainViewType?: MainViewType; // 主画面类型
  mixStream?: MixStreamOptions;
  waterMark?: WaterMarkOptions;
  relay?: RelayOptions;
}

export interface Record {
  FileName: string;
  RecordId: string;
}

export interface EffectOptions {
  streamId?: string;
  effectId: number;
  filePath?: string;
  loop?: boolean;
  playTime?: number;
  replace?: boolean;
}

export interface EffectVolumeOptions {
  streamId?: string;
  effectId: number;
  volume: number;
}

export interface SwitchDeviceOptions {
  streamId?: string;
  type: DeviceType;
  deviceId: string;
}

export interface SwitchImageOptions {
  streamId?: string;
  file?: File;
  filePath?: string;
}

export interface SnapshotOptions {
  streamId?: string;
  download?: string | boolean;
}

export interface AudioStats {
  br: number;
  lostpre: number;
  vol: number;
  mime: string;
}

export interface VideoStats {
  br: number;
  lostpre: number;
  frt: number;
  w: number;
  h: number;
  mime: string;
}

export interface NetworkStats {
  rtt: number;
}

export interface ReplaceTrackOptions {
  streamId?: string;
  track: MediaStreamTrack;
  retain?: boolean;
}

export declare type MixType = 'relay' | 'record' | 'relay-and-record' | 'update-config';
export declare type MixLayoutType = 'flow' | 'main' | 'custom' | 'customMain' | 'customFlow' | 'single';
export declare type MixAudioCodec = 'aac';
export declare type MixVideoCodec = 'h264' | 'h265';
export declare type H264Quality = 'B' | 'CB' | 'M' | 'E' | 'H';
export declare type MixOutputMode = 'audio-video' | 'audio'; // 默认为 audio-video
export declare type MixStreamAddMode = 'automatic' | 'manual'; // 默认为 'automatic 自动的

export interface MixLayoutOptions {
  type: MixLayoutType; // layout 类型
  standbyTypes?: MixLayoutType[]; // 待切换的 layout 类型
  custom?: Array<object>; // layout 为 'custom'，自定义布局填在custom里，格式参照RFC5707 Media Server Markup Language (MSML)
  mainViewUId?: string; // 指定某用户的流为主画面
  mainViewType?: MainViewType; // 主画面类型
}

export interface MixAudioOptions {
  codec: MixAudioCodec;
}

export interface MixVideoOptions {
  codec: MixVideoCodec;
  quality?: H264Quality; // 当 codec 为 h264 时，此项起作用
  frameRate?: number;
  bitRate?: number;
}

export interface BackgroundColorOptions {
  r: number;
  g: number;
  b: number;
}

export interface MixOptions {
  type?: MixType; // 默认为 record
  bucket?: string;
  region?: string;

  pushURL?: string[]; // type 是 转推，转推和录制时，需指定
  layout?: MixLayoutOptions;
  audio?: MixAudioOptions;
  video?: MixVideoOptions;
  outputMode?: MixOutputMode;

  width?: number;
  height?: number;
  backgroundColor?: BackgroundColorOptions;

  waterMark?: WaterMarkOptions;

  streams?: MixStream[];
  streamAddMode?: MixStreamAddMode;

  timeoutPeriod?: number; // 超时周期，任务检测到没有（指定）流后超过此时间，将自动停止，单位是s，最长24小时
}

export interface StopMixOptions {
  type?: MixType; // 默认为 record
  pushURL?: string[]; // 如果 type 为 relay 或 relay-and-record，需要指定停止对哪个 url 的转推，如果留空会停止对所有 url 的转推
}

export interface MixResult {
  MixId?: string;
  FileName?: string;
  Type?: MixType;
  PushURL?: string[];
}

export interface MixStream {
  uid: string; // 用户 ID
  mediaType: 'camera' | 'screen'; // 流的媒体类型
}

export interface AddMixStreamsOptions {
  streams: MixStream[];
}

export interface RemoveMixStreamsOptions {
  streams: MixStream[];
}

// 录制
export interface StartRecordOptions {
  bucket: string;
  region: string;

  layout?: MixLayoutOptions;

  width?: number;
  height?: number;
  backgroundColor?: BackgroundColorOptions;

  waterMark?: WaterMarkOptions;

  streams?: MixStream[]; // 如果列表为空，会自动添加房间内所有用户的流，如果指定了用户，则只添加该用户的指定流
}

export interface RecordResult {
  Id: string;
  FileName?: string;
}

declare type UpdateMixStreamsType = 'add' | 'remove' | 'replace';

export interface UpdateMixStreamsOptions {
  type: UpdateMixStreamsType;
  streams: MixStream[];
}

export interface StartRelayOptions {
  pushURL?: string[];
  layout?: MixLayoutOptions;
  audio?: MixAudioOptions;
  video?: MixVideoOptions;
  outputMode?: MixOutputMode;

  width?: number;
  height?: number;
  backgroundColor?: BackgroundColorOptions;

  waterMark?: WaterMarkOptions;

  streams?: MixStream[];
  streamAddMode?: MixStreamAddMode;
}

export interface RelayResult {
  Id: string;
  PushURL?: string[];
}

declare type UpdateRelayPushURLType = 'add' | 'remove' | 'replace';

export interface UpdateRelayPushURLOptions {
  type: UpdateRelayPushURLType;
  pushURL: string[];
}

export interface UpdateRelayLayoutOptions {
  layout: MixLayoutOptions;
}

export interface UpdateRelayWaterMarkOptions {
  waterMark: WaterMarkOptions;
}

declare type VideoFitType = 'cover' | 'contain'; // cover 模式：优先保证视窗被填满。contain 模式：优先保证视频内容全部显示。

declare type PlayControlsOption = 'show' | 'hide' | 'auto'; // 默认 auto，正常播放时隐藏，未播放时显示

export interface PlayOptions {
  streamId: string;
  container: HTMLElement | string;
  mute?: boolean;
  mirror?: boolean;
  fit?: VideoFitType;
  controls?: PlayControlsOption;
}

export interface VideoProfileOptions {
  previewId?: string;
  profile: string;
}