Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MixLayoutOptions

输出音视频的混流布局设置。

Hierarchy

  • MixLayoutOptions

Index

Properties

Optional custom

custom: Record<string, unknown>[]

选择自定义布局风格时,需要由此参数指定布局,格式参照RFC5707 Media Server Markup Language (MSML)。

Optional mainViewType

mainViewType: MediaType

主画面流类型,指定用户某类型的流为主画面,默认 'camera'。

Optional mainViewUId

mainViewUId: string

主画面用户,指定某用户的流为输入音视频的主画面,如当 type 为 'main' 或 'main2' 时,指定某用户的流将占据大部分画面,不指定时,默认为当前用户。

Optional standbyTypes

standbyTypes: MixLayoutType[]

指定待切换的布局风格,针对直播中有切换布局的需求,可在启动时指定待切换的布局,未指定的无法切换,且最多可指定两种可切换的类型(不包含 type 中指定的,即一次转推任务最多有三种布局可相互切换),多余的将被忽略。

example
{
  type: 'flow',
  standbyTypes: ['main', 'main2'],
  ...
}

特别地,由于 'custom' 布局风格的特殊性,待切换的布局中不可包含该类型的布局,若填写,则会被忽略。

type

布局风格,参见MixLayoutType,默认 'flow'。

Generated using TypeDoc