Options
All
  • Public
  • Public/Protected
  • All
Menu

@urtc/plugin-mix

Index

Type aliases

H264Quality

H264Quality: "B" | "CB" | "M" | "E" | "H"

输出音视频的视频质量,当输出视频编码格式为 h264 时,此项起作用,有 'B' | 'CB' | 'M' | 'E' | 'H' 几种,不指定时,默认为 'CB'。

MixAudioCodec

MixAudioCodec: "aac"

输出音视频的音频编码格式,'aac'。

MixLayoutType

MixLayoutType: "flow" | "main" | "single" | "flow2" | "main2" | "custom"

输出音视频的混流布局风格,分别有 'flow' | 'main' | 'single' | 'flow2' | 'main2' | 'custom',分别代表:

  1. 平铺风格,用户平铺在底图上,默认最大支持9个用户画面;
  2. 垂直风格,讲课模式,主讲人占大部分屏幕,其他人小屏居于右侧,最多支持9个用户画面;
  3. 单画面风格,只显示主画面,其他画面不显示,只对声音进行混音,最多支持9个用户画面;
  4. 平铺风格2,用户完全等分的平铺在底图上,最多支持9个用户画面;
  5. 垂直风格2,主讲人占大部分屏幕,其他人小屏居于底部;
  6. 自定义布局风格,可参照 RFC5707 Media Server Markup Language (MSML) 指定布局;

不指定时,默认为 'flow',更多请参考风格详细说明

MixOutputMode

MixOutputMode: "audio-video" | "audio"

输出音视频的模式,有 'audio-video' | 'audio' 两种,分别代表:输出音视频 | 只输出音频,不指定时,默认为 'audio-video'。

MixStreamAddMode

MixStreamAddMode: "automatic" | "manual"

音视频源的添加模式,有 'automatic' | 'manual' 两种可填,分别代表:自动添加(有新流时) | 手动添加,不指定时,默认为 'automatic'。

MixVideoCodec

MixVideoCodec: "h264" | "h265"

输出音视频的视频编码格式,有 'h264' | 'h265' 两种,不指定时,默认 'h264'。

MixerEventType

MixerEventType: "record-notify" | "relay-notify"

混流服务后台通知事件类型,有 'record-notify' 及 'relay-notify',可监听事件并做出相应处理(如提示用户),具体事件参见 MixerEvent

example
client
  .$mixer
  .on('record-notify', (evt) => {
    console.log('收到事件通知'evt.data);
  });

UpdateRelayOptions

UpdateRelayOptions: UpdateRecordOptions

WaterMarkPosition

WaterMarkPosition: "left-top" | "left-bottom" | "right-top" | "right-bottom"

输出音视频的水印位置,有 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom' 几种,分别对应 左上,左下,右上,右下,默认 'left-top'。

WaterMarkType

WaterMarkType: "time" | "image" | "text"

输出音视频的水印类型,有 'time' | 'image' | 'text' 几种,分别对应时间水印、图片水印、文字水印,默认不添加水印。

Variables

Const plugin

plugin: ClientPlugin = ...

@urtc/sdk-web 所使用的 Plugin

example
import { Client } from '@urtc/sdk-web';
import { plugin } from '@urtc/plugin-mix';

Client.use(plugin);

Const version

version: string = ...

版本号

Generated using TypeDoc