Controls recording manually on demand. For example, you can start or stop recording at any time.

Note
  • If a live stream is being automatically or manually recorded, you can call this operation to manually stop recording the live stream.
  • If a live stream is interrupted after you manually record it, the recording stops. In addition, if automatic recording is not configured for the live stream, ApsaraVideo Live does not automatically record the live stream after it is resumed.

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 RealTimeRecordCommand

The operation that you want to perform. Set the value to RealTimeRecordCommand.

AppName String Yes testApp

The name of the application to which the live stream belongs.

Command String Yes start

The action to be performed. Valid values:

  • start: forcibly starts recording.
  • stop: forcibly stops recording.
  • cancel_delay: resets the latency for stream interruption and completely stops recording.
  • restart: forcibly restarts recording.
DomainName String Yes www.yourdomain.com

The main streaming domain.

StreamName String Yes testStream

The name of the live stream.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=RealTimeRecordCommand
&AppName=testApp
&Command=start
&DomainName=www.yourdomain.com
&StreamName=testStream
&<Common request parameters>

Sample success responses

XML format

<RealTimeRecordCommandResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</RealTimeRecordCommandResponse>

JSON format

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

For a list of error codes, visit the API Error Center.