调用DescribeCasterScenes查询导播台场景列表。
使用说明
先通过CreateCaster接口创建导播台,再调用本接口查询导播台场景列表。
QPS限制
本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCasterScenes |
系统规定参数,取值:DescribeCasterScenes。 |
CasterId | String | 是 | 80787064-1c94-4dc1-85ce-9409960a**** |
导播台ID。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
|
RegionId | String | 否 | cn-shanghai |
地域ID。 |
SceneId | String | 否 | b5f8c837-ceeb-424f-b30b-68e94e86**** |
场景ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CF60DB6A-7FD6-426E-9288-122CC1A52FA7 |
请求ID。 |
SceneList | Array of Scene |
场景信息列表。 |
|
Scene | |||
SceneId | String | b5f8c837-ceeb-424f-b30b-68e94e86**** |
场景ID。可作为更新场景音频配置、查询导播台场景音频配置、启动导播台场景和停止导播台场景的请求参数。 |
SceneName | String | scene1 |
场景名称。 |
OutputType | String | 0 |
是否正式输出。 取值:
|
LayoutId | String | 37cb2f8b-f152-4338-b928-6704f71d**** |
布局ID。 |
StreamUrl | String | rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**** |
输出流地址。 |
ComponentIds | List | ["1506396160-0-0-7de771a77102680861853af862d5****"] |
组件ID列表。 |
Status | Integer | 0 |
场景状态。 取值:
|
StreamInfos | Array of StreamInfo |
播放地址列表。 |
|
StreamInfo | |||
OutputStreamUrl | String | http://live/caster/example.net |
播放地址。 |
TranscodeConfig | String | lld |
转码配置。取值:
|
VideoFormat | String | flv |
格式。取值:
|
Total | Integer | 2 |
总记录数。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeCasterScenes
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeCasterScenesResponse>
<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
<Total>2</Total>
<SceneList>
<Scene>
<Status>0</Status>
<SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
<SceneName>scene1</SceneName>
<LayoutId>37cb2f8b-f152-4338-b928-6704f71d****</LayoutId>
<StreamUrl>rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</StreamUrl>
<OutputType>0</OutputType>
<StreamInfos>
<StreamInfo>
<OutputStreamUrl>http://live/caster/example.net</OutputStreamUrl>
<VideoFormat>flv</VideoFormat>
<TranscodeConfig>lld</TranscodeConfig>
</StreamInfo>
</StreamInfos>
<ComponentIds>
<componentId>["1506396160-0-0-7de771a77102680861853af862d5****"]</componentId>
</ComponentIds>
</Scene>
</SceneList>
</DescribeCasterScenesResponse>
JSON
格式
{
"DescribeCasterScenesResponse": {
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
"Total": 2,
"SceneList": {
"Scene": {
"Status": 0,
"SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
"SceneName": "scene1",
"LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
"StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
"OutputType": 0,
"StreamInfos": {
"StreamInfo": {
"OutputStreamUrl": "http://live/caster/example.net",
"VideoFormat": "flv",
"TranscodeConfig": "lld"
}
},
"ComponentIds": {
"componentId": "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
}
}
}
}
}
错误码
访问错误中心查看更多错误码。