class TencentCloud::Trtc::V20190722::LayoutParams

MCU混流布局参数

Attributes

MainVideoRightAlign[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

MainVideoStreamType[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

MainVideoUserId[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

MixVideoUids[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

PlaceHolderMode[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

PresetLayoutConfig[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

PureAudioHoldPlaceMode[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

SmallVideoLayoutParams[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

Template[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

WaterMarkParams[RW]

@param Template: 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 @type Template: Integer @param MainVideoUserId: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 @type MainVideoUserId: String @param MainVideoStreamType: 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 @type MainVideoStreamType: Integer @param SmallVideoLayoutParams: 画中画模板中有效,代表小画面的布局参数。 @type SmallVideoLayoutParams: :class:`Tencentcloud::Trtc.v20190722.models.SmallVideoLayoutParams` @param MainVideoRightAlign: 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 @type MainVideoRightAlign: Integer @param MixVideoUids: 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 @type MixVideoUids: Array @param PresetLayoutConfig: 自定义模板中有效,指定用户视频在混合画面中的位置。 @type PresetLayoutConfig: Array @param PlaceHolderMode: 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 @type PlaceHolderMode: Integer @param PureAudioHoldPlaceMode: 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 @type PureAudioHoldPlaceMode: Integer @param WaterMarkParams: 水印参数。 @type WaterMarkParams: :class:`Tencentcloud::Trtc.v20190722.models.WaterMarkParams`

Public Class Methods

new(template=nil, mainvideouserid=nil, mainvideostreamtype=nil, smallvideolayoutparams=nil, mainvideorightalign=nil, mixvideouids=nil, presetlayoutconfig=nil, placeholdermode=nil, pureaudioholdplacemode=nil, watermarkparams=nil) click to toggle source
# File lib/v20190722/models.rb, line 1269
def initialize(template=nil, mainvideouserid=nil, mainvideostreamtype=nil, smallvideolayoutparams=nil, mainvideorightalign=nil, mixvideouids=nil, presetlayoutconfig=nil, placeholdermode=nil, pureaudioholdplacemode=nil, watermarkparams=nil)
  @Template = template
  @MainVideoUserId = mainvideouserid
  @MainVideoStreamType = mainvideostreamtype
  @SmallVideoLayoutParams = smallvideolayoutparams
  @MainVideoRightAlign = mainvideorightalign
  @MixVideoUids = mixvideouids
  @PresetLayoutConfig = presetlayoutconfig
  @PlaceHolderMode = placeholdermode
  @PureAudioHoldPlaceMode = pureaudioholdplacemode
  @WaterMarkParams = watermarkparams
end

Public Instance Methods

deserialize(params) click to toggle source
# File lib/v20190722/models.rb, line 1282
def deserialize(params)
  @Template = params['Template']
  @MainVideoUserId = params['MainVideoUserId']
  @MainVideoStreamType = params['MainVideoStreamType']
  unless params['SmallVideoLayoutParams'].nil?
    @SmallVideoLayoutParams = SmallVideoLayoutParams.new
    @SmallVideoLayoutParams.deserialize(params['SmallVideoLayoutParams'])
  end
  @MainVideoRightAlign = params['MainVideoRightAlign']
  @MixVideoUids = params['MixVideoUids']
  unless params['PresetLayoutConfig'].nil?
    @PresetLayoutConfig = []
    params['PresetLayoutConfig'].each do |i|
      presetlayoutconfig_tmp = PresetLayoutConfig.new
      presetlayoutconfig_tmp.deserialize(i)
      @PresetLayoutConfig << presetlayoutconfig_tmp
    end
  end
  @PlaceHolderMode = params['PlaceHolderMode']
  @PureAudioHoldPlaceMode = params['PureAudioHoldPlaceMode']
  unless params['WaterMarkParams'].nil?
    @WaterMarkParams = WaterMarkParams.new
    @WaterMarkParams.deserialize(params['WaterMarkParams'])
  end
end