All Products
Search
Document Center

ApsaraVideo Live:DescribeCasterConfig

Last Updated:Dec 05, 2024

Queries the configurations of a production studio.

Operation description

You can call the CreateCaster operation to create a production studio and then call this operation to query the configurations 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CasterIdstringYes

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.
LIVEPRODUCER_POST-cn-0pp1czt****

Response parameters

ParameterTypeDescriptionExample
object

The configuration information about the production studio.

AutoSwitchUrgentConfigstring

The configuration for automatic switchover to the standby resource. The eofThres field specifies the duration after which the production studio automatically switches to the standby resource if a stream interruption occurs. Unit: seconds.

{"eofThres":3}
AutoSwitchUrgentOnstring

Indicates whether the production studio automatically switches to the standby resource in case of a stream interruption.

  • true
  • false
true
CallbackUrlstring

The callback URL.

http://learn.aliyundoc.com/callBackLive
CasterIdstring

The ID of the production studio.

LIVEPRODUCER_POST-cn-0pp1czt****
CasterNamestring

The name of the production studio.

coco-caster10
ChannelEnableinteger

Indicates whether channels are enabled for the production studio. Valid values:

  • 0: Channels are disabled.
  • 1: Channels are enabled.
1
Delayfloat

Indicates whether stream delay is enabled. Unit: seconds.

  • 0: Stream delay is disabled.
  • A value greater than 0: Stream delay is enabled.
0
DomainNamestring

The main streaming domain.

example.com
ProgramEffectinteger

Indicates whether the carousel playback feature is enabled. Valid values:

  • 0: The carousel playback feature is disabled.
  • 1: The carousel playback feature is enabled.
0
ProgramNamestring

The name of the playlist for carousel playback.

program_name
RecordConfigobject

The recording configuration. If this parameter is empty, the recording feature is disabled.

OnDemandinteger

On-demand recording. Values:

  • 0: Off.
  • 1: Via HTTP callback.
  • 2: Parse streaming parameters for on-demand recording.
  • 7: Default to not record.
0
OssBucketstring

The OSS bucket for storage.

liveBucket****
OssEndpointstring

The Object Storage Service (OSS) endpoint.

oss-cn-shanghai.aliyundoc.com
RecordFormatarray<object>

The recording configuration.

RecordFormatobject

The recording details.

CycleDurationinteger

The length of the recording.

3600
Formatstring

The format of the recording.

M3U8
OssObjectPrefixstring

The name of the recording.

record/{liveApp****}/{liveStream****}
SliceOssObjectPrefixstring

The name of the segment.

record/{liveApp****}/{liveStream****}/{UnixTimestamp****}
RequestIdstring

The ID of the request.

97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrlstring

The custom stream redirect URL.

rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****
SideOutputUrlListstring

The list of custom stream redirect URLs.

rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****
SyncGroupsConfigarray<object>

The storage configuration.

SyncGroupobject

The storage configuration.

HostResourceIdstring

The ID of the resource in the production studio.

28768383240243****
Modeinteger

The cache mode of the Static Page Caching policy. Valid values:

  • 0: standard mode
  • 1: force mode
  • 2: no cache
0
ResourceIdsarray

The IDs of the resources for which you want to modify the resource group. The number of resource IDs is 1 to 50.

ResourceIdstring

The ID of the resource for which you want to modify the resource group. The number of resource IDs is 1 to 50.

1
TranscodeConfigobject

The transcoding configuration.

CasterTemplatestring

The transcoding template of the production studio. Valid values:

  • lp_ld: low definition
  • lp_sd: standard definition
  • lp_hd: high definition
  • lp_ud: ultra high definition
  • lp_ld_v: low definition (portrait mode)
  • lp_sd_v: standard definition (portrait mode)
  • lp_hd_v: high definition (portrait mode)
  • lp_ud_v: ultra high definition (portrait mode)
lp_hd
LiveTemplateIdsarray

The transcoding setting for live streams.

LocationIdstring

Live streaming transcoding configuration. Values:

  • lsd: Standard Definition (SD).
  • lld: Smooth.
  • lud: Ultra High Definition (UHD).
  • lhd: High Definition (HD) adaptive transcoding template.
  • daobo-lsd: Standard Definition (SD).
  • daobo-lld: Smooth.
  • daobo-lud: Ultra High Definition (UHD).
  • daobo-lhd: High Definition (HD).
lld
UrgentImageIdstring

Prepared broadcast image media asset ID.

a089175eb5f4427684fc0715159a****
UrgentImageUrlstring

URL of the standby image material.

http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrlstring

The URL of the standby live stream.

rtmp://demo.aliyundoc.com
UrgentMaterialIdstring

The ID of the material that is used as the standby video from the media library.

98646538-bcf9-4aef-bd4a-e6bb76588****

Examples

Sample success responses

JSONformat

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}

Error codes

HTTP status codeError codeError message
400InvalidCasterId.Malformed%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-22The Error code has changed. The response structure of the API has changedView Change Details
2023-03-31The Error code has changed. The response structure of the API has changedView Change Details
2023-03-07The Error code has changed. The response structure of the API has changedView Change Details