StartCasterScene - ApsaraVideo Live

Usage notes

You can call this operation to start a specified PVW scene.

QPS limit

You can call this operation up to 10 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 calculates 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	StartCasterScene	The operation that you want to perform. Set the value to StartCasterScene.
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 Name column.
SceneId	String	Yes	242b4e2c-c30f-4442-85ba-2e3e4e3d****	The ID of the scene. This parameter takes effect only if the scene is a PVW scene.

Response parameters

Parameter	Type	Example	Description
RequestId	String	CF60DB6A-7FD6-426E-9288-122CC1A52FA7	The request ID.
StreamUrl	String	http://live/caster/example.org	The streaming URL of the scene. It is used for playback, but not for stream relay.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=StartCasterScene
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&SceneId=242b4e2c-c30f-4442-85ba-2e3e4e3d****
&<Common request parameters>

Sample success responses

XML format

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

<StartCasterSceneResponse>
    <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
    <StreamUrl>http://live/caster/example.org</StreamUrl>
</StartCasterSceneResponse>

JSON format

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

{
  "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "StreamUrl" : "http://live/caster/example.org"
}

Error codes

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