public class LayoutParams extends AbstractModel
Constructor and Description |
---|
LayoutParams() |
LayoutParams(LayoutParams source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
Long |
getMainVideoRightAlign()
Get You can set the layout parameter as 1 or 0 in the screen sharing template.
|
Long |
getMainVideoStreamType()
Get Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
|
String |
getMainVideoUserId()
Get ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
|
String[] |
getMixVideoUids()
Get A user list, which takes effect for floating, grid, or screen sharing templates.
|
Long |
getPlaceHolderMode()
Get Valid in custom templates.
|
PresetLayoutConfig[] |
getPresetLayoutConfig()
Get Valid in custom template, used to specify the video image position of a user in mixed streams.
|
Long |
getPureAudioHoldPlaceMode()
Get Whether an audio-only stream occupies an image spot, which takes effect in a floating, grid, or screen sharing template.
|
SmallVideoLayoutParams |
getSmallVideoLayoutParams()
Get Layout parameter of the small image, which takes effect in a picture-in-picture template.
|
Long |
getTemplate()
Get On-cloud stream mix layout template ID.
|
void |
setMainVideoRightAlign(Long MainVideoRightAlign)
Set You can set the layout parameter as 1 or 0 in the screen sharing template.
|
void |
setMainVideoStreamType(Long MainVideoStreamType)
Set Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
|
void |
setMainVideoUserId(String MainVideoUserId)
Set ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
|
void |
setMixVideoUids(String[] MixVideoUids)
Set A user list, which takes effect for floating, grid, or screen sharing templates.
|
void |
setPlaceHolderMode(Long PlaceHolderMode)
Set Valid in custom templates.
|
void |
setPresetLayoutConfig(PresetLayoutConfig[] PresetLayoutConfig)
Set Valid in custom template, used to specify the video image position of a user in mixed streams.
|
void |
setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)
Set Whether an audio-only stream occupies an image spot, which takes effect in a floating, grid, or screen sharing template.
|
void |
setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams)
Set Layout parameter of the small image, which takes effect in a picture-in-picture template.
|
void |
setTemplate(Long Template)
Set On-cloud stream mix layout template ID.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public LayoutParams()
public LayoutParams(LayoutParams source)
public Long getTemplate()
public void setTemplate(Long Template)
Template
- On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template; 4: custom template.public String getMainVideoUserId()
public void setMainVideoUserId(String MainVideoUserId)
MainVideoUserId
- ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.public Long getMainVideoStreamType()
public void setMainVideoStreamType(Long MainVideoStreamType)
MainVideoStreamType
- Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.public SmallVideoLayoutParams getSmallVideoLayoutParams()
public void setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams)
SmallVideoLayoutParams
- Layout parameter of the small image, which takes effect in a picture-in-picture template.public Long getMainVideoRightAlign()
public void setMainVideoRightAlign(Long MainVideoRightAlign)
MainVideoRightAlign
- You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.public String[] getMixVideoUids()
public void setMixVideoUids(String[] MixVideoUids)
MixVideoUids
- A user list, which takes effect for floating, grid, or screen sharing templates. When the user list has been set, the stream mix output for users in this user list will include both audio and video; the stream mix output for users not in the list will only include audio. Up to 16 users can be set.public PresetLayoutConfig[] getPresetLayoutConfig()
public void setPresetLayoutConfig(PresetLayoutConfig[] PresetLayoutConfig)
PresetLayoutConfig
- Valid in custom template, used to specify the video image position of a user in mixed streams.public Long getPlaceHolderMode()
public void setPlaceHolderMode(Long PlaceHolderMode)
PlaceHolderMode
- Valid in custom templates. 1: the placeholding feature is enabled; 0 (default): the feature is disabled. When the feature is enabled, but a user for whom a position is reserved is not sending video data, the position will show the corresponding placeholder image.public Long getPureAudioHoldPlaceMode()
public void setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)
PureAudioHoldPlaceMode
- Whether an audio-only stream occupies an image spot, which takes effect in a floating, grid, or screen sharing template. Valid values: 0 (default): when a floating or grid template is used, users sending audio only occupy image spots; when a screen sharing template is used, users (except the user whose screen is shared) sending audio only do not occupy image spots; 1: users sending audio only occupy image spots; 2: users sending audio only do not occupy image spots.Copyright © 2021. All rights reserved.