DescribeCasterScenes - ApsaraVideo Live

Usage notes

You can call the CreateCaster operation to create a production studio and then call this operation to query information about the scenes of the production studio.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically generates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeCasterScenes	The operation that you want to perform. Set the value to DescribeCasterScenes.
CasterId	String	Yes	80787064-1c94-4dc1-85ce-9409960a****	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance ID/Name column.
SceneId	String	No	b5f8c837-ceeb-424f-b30b-68e94e86****	The ID of the scene.

Response parameters

Parameter	Type	Example	Description
RequestId	String	CF60DB6A-7FD6-426E-9288-122CC1A52FA7	The ID of the request.
SceneList	Array of Scene		The information about the scenes that were queried.
Scene
ComponentIds	Array of String	["1506396160-0-0-7de771a77102680861853af862d5****"]	The IDs of components.
LayoutId	String	37cb2f8b-f152-4338-b928-6704f71d****	The ID of the layout.
OutputType	String	0	Indicates whether the output video is in preview mode or program mode. Valid values: 0: in preview mode. 1: in program mode.
SceneId	String	b5f8c837-ceeb-424f-b30b-68e94e86****	The ID of the scene. This response parameter can be used as a request parameter in the UpdateCasterSceneAudio, DescribeCasterSceneAudio, StartCasterScene, or StopCasterScene operation.
SceneName	String	scene1	The name of the scene.
Status	Integer	0	The status of the scene. Valid values: 0: disabled. 1: enabled.
StreamInfos	Array of StreamInfo		The information about the stream.
StreamInfo
OutputStreamUrl	String	http://live/caster/example.net	The streaming URL.
TranscodeConfig	String	lld	The transcoding configuration. Valid values: sd: standard definition. lld: low definition. lud: ultra high definition. lhd: high definition.
VideoFormat	String	flv	The format. Valid values: flv mp4 m3u8
StreamUrl	String	rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**	The URL of the output stream.
Total	Integer	2	The total number of entries.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeCasterScenes
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCasterScenesResponse>
    <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
    <SceneList>
        <ComponentIds>["1506396160-0-0-7de771a77102680861853af862d5****"]</ComponentIds>
        <LayoutId>37cb2f8b-f152-4338-b928-6704f71d****</LayoutId>
        <OutputType>0</OutputType>
        <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
        <SceneName>scene1</SceneName>
        <Status>0</Status>
        <StreamInfos>
            <OutputStreamUrl>http://live/caster/example.net</OutputStreamUrl>
            <TranscodeConfig>lld</TranscodeConfig>
            <VideoFormat>flv</VideoFormat>
        </StreamInfos>
        <StreamUrl>rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</StreamUrl>
    </SceneList>
    <Total>2</Total>
</DescribeCasterScenesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "SceneList" : [ {
    "ComponentIds" : [ "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]" ],
    "LayoutId" : "37cb2f8b-f152-4338-b928-6704f71d****",
    "OutputType" : "0",
    "SceneId" : "b5f8c837-ceeb-424f-b30b-68e94e86****",
    "SceneName" : "scene1",
    "Status" : 0,
    "StreamInfos" : [ {
      "OutputStreamUrl" : "http://live/caster/example.net",
      "TranscodeConfig" : "lld",
      "VideoFormat" : "flv"
    } ],
    "StreamUrl" : "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****"
  } ],
  "Total" : 2
}

Error codes

For a list of error codes, see Service error codes.