stream 详述

APIs

on

绑定监听事件

stream.on(keyName: string, listenerFunction: () => {}): void

off

解除绑定监听事件

stream.off(keyName: string): void

setAudioOutput

切换扬声器设备

参数：

deviceId：设备 ID

stream.setAudioOutput(deviceId: string): Promise<{ deviceId: string }>

switchDevice

切换摄像头、麦克风设备

参数：

type: 设备类型
deviceId：设备 ID

stream.switchDevice(type: 'audio' | 'video', deviceId: string): Promise<boolean

close

关闭 stream 对象，销毁数据和事件

stream.close(): void

getMediaStreams

获取所有 mediaStream 数据

stream.getMediaStreams(): IGetMediaStreams;

interface IGetMediaStreams {
  previewStreams: IStreamObj[];
  streams: IStreamObj[];
  pipelineStreams: IStreamObj[];
  contentStreams: IStreamObj[];
}

interface IStreamObj {
  stream: MediaStream | null;
  domStream: TCustomStream[];
  status: IStreamStatus;
  // stream 类型
  type: 'contentStream' | 'previewStream' | 'pipelineStream' | 'remoteStream';
  // 分辨率
  resolution: string;
}

init

初始化 stream 流对象，可配置初始选择的输出/输出设备

参数：

config: 选题，默认为空

devices：可选，配置初始入会输出输出设备数据，如果没有指定则使用默认设备数据
audioInputValue：麦克风输入设备 id
videoInValue：摄像头设备 id
audioOutputValue：扬声器输出设备 id

stream.init(config?: IStreamInitConfog = { devices: {} }): Promise<IResult>;

type IStreamInitConfog = {
  devices: {
    audioInputValue?: string;
    videoInValue?: string;
    audioOutputValue?: string;
  };
};

interface IResult {
  code: number;
  msg: string;
  detail: Object;
}

getAudioLevel

获取当前音量大小

参数：

stream：选填，默认会中不用填写，在用于在实现预览麦克风设备音量大小时，配置一个 stream 对象。

stream.getAudioLevel(stream?: MediaStream): Promise<Number>

clearAudioLevel

清理音量 context 对象，下次会重新实例化音量对象

stream.clearAudioLevel(): void

createContentStream

创建分享屏幕的流对象

兼容：v2.0.5+支持配置setting设置项；

提示

因系统和浏览器限制，不同系统下浏览器屏幕共享对于音频分享支持性不一致

Mac 使用浏览器屏幕分享时，浏览器标签页支持分享音频，应用窗口和屏幕不支持分享音频。
Windows 使用浏览器屏幕分享时，浏览器标签页和屏幕支持分享音频，应用窗口不支持分享音频。

stream.createContentStream(setting?: IContentSetting): Promise<IStreamObj[]>;

interface IContentSetting {
  // 是否开启采集共享屏幕声音，默认是false，不采集声音；
  screenAudio?: boolean;
}

interface IStreamObj {
  stream: MediaStream | null;
  status: IStreamStatus;
  // stream 类型
  type: 'contentStream' | 'previewStream' | 'pipelineStream' | 'remoteStream';
  // 分辨率
  resolution: string;
}

// Stream的状态：
// NORMAL：正常
// DOMSTRING：无流状态，定义domStream，用来创建流通道
// INVALID：已失效
export type IStreamStatus = 'NORMAL' | 'DOMSTRING' | 'INVALID'

getElectronContentSources

获取 electron 平台上可分享的输入源列表：

: 输入源信息

stream.getElectronContentSources( desktopCapturer: desktopCapturer, types: any = ['window', 'screen']): Promise<ISource[]>;

interface ISource {
  appIcon: any;
  display_id: string;
  id: string;
  name: string;
  // thumbnail type is NativeImage
  thumbnail: any;
}

createElectronContentStream

创建 electron 分享流

stream.createElectronContentStream(selectedSourceId: string): Promise<IStreamObj[]>;

// IStreamObj 同getElectronContentSources方法

getPreviewStream

获取用于预览的画面

stream.getPreviewStream( isVideo: boolean, isAudio: boolean, params = { video: {}, audio: {} }): Promise<MediaStream>

事件

stream-status

创建视频流的类型

stream.on("stream-status", (e: IStreamCurrent) => {}): void;

interface IStreamCurrent {
  // NORMAL 采集正常
  // SEND_ONLY  仅发送（无权限、无设备等无流入会情况）
  // 其他异常，无法入会
  type: 'NORMAL' | 'SEND_ONLY' | 'FAILED';
  detail: string | IStreamError;
}

local-stream

本地数据流监听，自定义 custom 布局需要处理此数据。用来匹配本地 video stream 流数据

stream.on("local-stream", (e: IStreamObj[]) => {});

interface IStreamObj {
  // video stream
  stream: MediaStream;
  // 忽略
  isSupport: boolean;
  // stream 类型
  type: string;
  // 分辨率
  resolution: string;
}

start-share-content

监听是否开始屏幕共享

stream.on('start-share-content', () => {
  // 通过client对象推送contentStream屏幕共享流
  client.publish(stream, { isShareContent: true });
}): void

stop-share-content

监听是否结束屏幕共享

stream.on('stop-share-content', () => {
  // 调用client对象的stop方法，停止关闭分享content
  client.stopShareContent();
}): void

2023-07-13 15:17:36

导出PDF文档