全部产品
阿里云办公

查询布局列表

更新时间:2018-06-27 15:30:44

描述

查询布局列表。

请求参数

参数 类型 是否必选 描述
Action String 操作接口名,系统规定参数,取值:DescribeCasterLayouts
CasterId String 导播台Id
LayoutId String 布局Id,若未指定,则查询导播台下所有布局列表

返回参数

参数 类型 描述
RequestId String 该条任务请求Id
Layouts []Layout 布局列表

Layout

参数 类型 描述
LayoutId String 布局Id
VideoLayers []VideoLayer videolayer配置列表,采用数组默认序列
AudioLayers []AudioLayer Audiolayer配置列表
BlendList []String 位置关联列表,与VideoLayers顺序保持一致
MixList []String 位置关联列表,与AudioLayers顺序保持一致

videoLayer

参数 类型 描述
FillMode String 元素填充方式
不填充:”none”
自适应:”fit”
默认:不填充。
若采用不填充模式,则以画面作为配置目标进行Layer设置。
若采用自适应模式,则以填充区(框)作为配置目标进行Layer设置,此时画面会按照原始的宽高比缩放,长边对齐的自适应方式在填充区(框)内居中填充,若填充区宽高比和画面不一致,则短边两侧无填充(显示为下层Layer画面,若下层未配置Layer,默认为底图黑色)。
HeightNormalized Float 设置该layer元素的高度归一化比例值。
若采用不填充模式,元素的宽度会按照该高度来进行等比缩放,默认值:0,表示按照画面的原始尺寸进行显示。
若采用自适应方式,该字段必输且大于0,表示填充区(框)高度归一化比例值。
WidthNormalized Float 设置该layer元素的宽度归一化比例值。
若采用不填充模式,元素的高度会按照该宽度来进行等比缩放,默认值:0,表示按照画面的原始尺寸进行显示。
若采用自适应方式,该字段必输且大于0,表示填充区(框)宽度归一化比例值。
PositionNormalized []Float 设置该layer 元素的位置归一化值[x,y]
默认为[0,0]。
注意:x,y需要进行归一化计算。
PositionRefer String 设置元素的position 参考坐标值。
取值范围:”topLeft”、”topRight”、”bottomLeft”、”bottomRight”以及”center”、”topCenter”、”bottomCenter”、”leftCenter”、”rightCenter”
默认值:”topLeft”
FixedDelayDuration Integer 该字段对视频进行固定延迟设置,可用于字幕同步。
单位:ms
默认值:0
取值范围:[0-5000]

AudioLayer

参数 类型 描述
VolumeRate Float 设置该layer元素的高度归一化比例值,其中元素的宽度会按照该高度来进行等比缩放。
默认值:0,表示按照元素的原始尺寸进行显示。
ValidChannel String 确定哪些声道可以作为音量输入
取值范围:”leftChannel”、”rightChannel”、”all”
默认值:”all”
FixedDelayDuration Integer 该字段对视频进行固定延迟设置,可用于字幕同步。
单位:ms
默认值:0
取值范围:[0-5000]

特殊错误码

错误代码 描述 Http 状态码 语义
IllegalOperation Permission Denied 401 无权访问导播台
InvalidCaster.NotFound Caster is not found. 404
InternalError The request processing has failed due to some unknown error, exception or failure. 500 内部错误

示例

请求示例

  1. https://live.aliyuncs.com?Action=DescribeCasterLayouts&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e1a49&<公共请求参数>
  2. }

返回示例

  1. {
  2. "RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
  3. "Layouts": [
  4. {
  5. "MixList": [
  6. "RV01"
  7. ],
  8. "AudioLayers": [
  9. {
  10. "ValidChannel": "all",
  11. "VolumeRate": 1
  12. }
  13. ],
  14. "VideoLayers": [
  15. {
  16. "HeightNormalized": 0.5,
  17. "PositionRefer": "topLeft",
  18. "WidthNormalized": 0.5,
  19. "PositionNormalized": [
  20. 0,
  21. 0.3
  22. ]
  23. },
  24. {
  25. "HeightNormalized": 0.5,
  26. "PositionRefer": "topLeft",
  27. "WidthNormalized": 0.5,
  28. "PositionNormalized": [
  29. 0.5,
  30. 0.3
  31. ]
  32. }
  33. ],
  34. "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947f053",
  35. "BlendList": [
  36. "RV01",
  37. "RV02"
  38. ]
  39. },
  40. {
  41. "MixList": [
  42. "RV01"
  43. ],
  44. "AudioLayers": [
  45. {
  46. "ValidChannel": "all",
  47. "VolumeRate": 0.5
  48. }
  49. ],
  50. "VideoLayers": [
  51. {
  52. "HeightNormalized": 1,
  53. "PositionRefer": "topLeft",
  54. "WidthNormalized": 1,
  55. "PositionNormalized": [
  56. 0,
  57. 0
  58. ]
  59. },
  60. {
  61. "HeightNormalized": 0.4,
  62. "PositionRefer": "topLeft",
  63. "WidthNormalized": 0.4,
  64. "PositionNormalized": [
  65. 0.1,
  66. 0.1
  67. ]
  68. }
  69. ],
  70. "LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e52d8",
  71. "BlendList": [
  72. "RV01",
  73. "RV02"
  74. ]
  75. }
  76. ]
  77. }
本文导读目录