调用UpdateShareScreenLayout更新共享屏幕布局。可用于课堂场景,直播画面中共享屏幕画面叠加老师摄像头画面。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用唯一标识,由6位小写字母、数字组成。 | lq****cu |
ClassId | string | 是 | 课堂唯一标识,由调用CreateClass返回。 | AE35****T95F |
EnableOverlay | boolean | 是 | 是否开启叠加老师画面 | true |
OverlayX | number | 否 | 叠加画面X坐标,起点为左上角,归一化为1 | 0.7576 |
OverlayY | number | 否 | 叠加画面Y坐标,起点为左上角,归一化为1 | 0.7576 |
OverlayWidth | number | 否 | 叠加画面宽度,归一化为1 | 0.2361 |
OverlayHeight | number | 否 | 叠加画面高度,归一化为1 | 0.2361 |
返回参数
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateShareScreenLayout
&AppId=lq****cu
&ClassId=AE35****T95F
&EnableOverlay=true
&OverlayX=0.7576
&OverlayY=0.7576
&OverlayWidth=0.2361
&OverlayHeight=0.2361
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E"
}
XML
格式
<UpdateShareScreenLayoutResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
</UpdateShareScreenLayoutResponse>
错误码
访问错误中心查看更多错误码。