This document lists all API operations available in ApsaraVideo Live (live/2016-11-01). Use this page to find the operation you need, organized by feature area.
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (live/2016-11-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
API Standard and SDKs
The ApsaraVideo Live API follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages that handle low-level details such as request signing. You can call API operations using language-specific syntax without working with HTTP directly.
Custom Signature
If the pre-built SDKs do not meet your requirements, such as a custom signature implementation, you can manually sign requests using the signature mechanism. Manual signing typically requires about 5 business days of development effort. For support, join our DingTalk group (ID: 147535001692).
Before You Begin
An Alibaba Cloud account has full administrative privileges. If an AccessKey pair is compromised, all associated resources are exposed to unauthorized access. To call APIs securely:
Create a Resource Access Management (RAM) user with API access only, and configure its AccessKey pairs.
Implement the principle of least privilege (PoLP) through RAM policies.
Use the Alibaba Cloud account only when its permissions are explicitly required.
Key Concepts
Before working with the ApsaraVideo Live API, familiarize yourself with these core concepts:
Ingest domain -- The domain through which broadcasters push live streams to the platform.
Streaming domain -- The domain through which viewers pull and play live streams.
Application (AppName) -- A logical grouping of streams under a domain. Each domain can have multiple applications.
Stream ingest -- The process of sending a live video stream from a broadcaster to the ApsaraVideo Live platform.
Transcoding -- Converting an ingested stream from one codec, bitrate, or resolution to another for compatibility and optimized delivery.
Production studio -- A cloud-based video switching and mixing console for compositing multiple sources into a single output stream.
Time shifting -- The ability for viewers to seek backward within a live stream to replay earlier content.
Stream delay -- An intentional, configurable delay applied to a live stream before it reaches viewers, typically used for content review.
Domain Management
| API | Description |
|---|---|
| AddLiveDomain | Adds a domain name to ApsaraVideo Live. You can add only one domain name per request. |
| AddLiveDomainPlayMapping | Maps a sub-streaming domain to a main streaming domain. |
| DeleteLiveDomainPlayMapping | Deletes the mapping between a main streaming domain and a sub-streaming domain. |
| AddLiveDomainMapping | Creates the mapping between a streaming domain and an ingest domain. |
| DeleteLiveDomain | Deletes all records for a specified live streaming domain. |
| DeleteLiveDomainMapping | Deletes the mapping between a streaming domain and an ingest domain. |
| DescribeLiveDomainMapping | Queries the mappings between ingest domains, main streaming domains, and sub-streaming domains. |
| DescribeLiveDomainDetail | Queries the basic configuration of a specified ingest domain or streaming domain. |
| StartLiveDomain | Enables a disabled live streaming domain. Changes the DomainStatus to online. |
| StopLiveDomain | Disables a live streaming domain. Changes the DomainStatus to offline. |
| DescribeLiveCertificateDetail | Queries the details of a certificate. |
| DescribeLiveDomainCertificateInfo | Queries the certificate information for a specified domain name. |
| DescribeLiveCertificateList | Queries certificates for one or more specified domain names, or all certificates in your Alibaba Cloud account. |
| SetLiveDomainCertificate | Enables or disables the certificate for a domain name and modifies its information. |
| BatchDeleteLiveDomainConfigs | Deletes the configurations of multiple domain names at a time. |
| BatchSetLiveDomainConfigs | Configures multiple domain names at a time. |
| DescribeLiveDomainConfigs | Queries one or more configurations of a domain name. |
| DescribeLiveDomainByCertificate | Queries accelerated domain names based on certificate information. |
| DescribeLiveHttpsDomainList | Queries information about all certificates configured in Certificate Service. |
| ModifyLiveDomainSchdmByProperty | Modifies the acceleration region of a domain name. |
| DescribeLiveUserTags | Queries user tags. |
| VerifyLiveDomainOwner | Verifies the ownership of a domain name. |
| DescribeLiveVerifyContent | Queries the ownership verification content for a specified domain name. |
| ChangeLiveDomainResourceGroup | Moves a domain name in ApsaraVideo Live to a specified resource group. |
| DescribeLiveUserDomains | Queries domain names of ApsaraVideo Live in your Alibaba Cloud account. |
| DescribeDomainWithIntegrity | Queries the integrity of a domain name. |
Stream Management
| API | Description |
|---|---|
| DescribeLiveStreamsBlockList | Queries the live streams that are blocked under a streaming domain. |
| DescribeLiveStreamsControlHistory | Queries the operations performed on live streams for a specified domain name or application. |
| DescribeLiveStreamBitRateData | Queries the frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) live stream within a specified time range. This operation retrieves historical data. |
| DescribeLiveStreamsOnlineList | Queries all active streams for a specified domain name or application. |
| DescribeLiveStreamsPublishList | Queries the ingest records of a specified domain name, application, or stream. |
| ForbidLiveStream | Disables a live stream. You can schedule when the stream is resumed. |
| ResumeLiveStream | Resumes the ingest of a live stream. |
| DescribeLiveDomainOnlineUserNum | Queries the number of online viewers for all live streams on a specified domain. |
| DescribeLiveDomainFrameRateAndBitRateData | Queries the frame rate and bitrate data of streams for an ingest domain. |
| DescribeLiveDomainLimit | Queries the maximum numbers of ingested and transcoded streams for a streaming domain. |
| DescribeLiveStreamState | Queries the real-time status of a single stream. |
| DescribeLiveStreamCount | Queries the real-time count of active original and transcoded streams for a specified streaming domain. |
Stream Ingest Callbacks
| API | Description |
|---|---|
| SetLiveStreamsNotifyUrlConfig | Sets the callback configuration for stream ingest. |
| DescribeLiveStreamsNotifyUrlConfig | Queries the callback configuration for stream ingest. |
| DeleteLiveStreamsNotifyUrlConfig | Deletes the callback configuration for stream ingest on an ingest domain. |
| DescribeLiveStreamsNotifyRecords | Queries the callback records of streams. |
Stream Security
| API | Description |
|---|---|
| SetLiveStreamBlock | Applies regional blocking to a specific live stream. |
| DescribeStreamLocationBlock | Queries the regional blocking configurations of a specific live stream. |
| DeleteLiveStreamBlock | Deletes blocking configurations for a specific live stream. |
Stream Pulling
| API | Description |
|---|---|
| AddLivePullStreamInfoConfig | Creates a scheduled stream pulling configuration, including the origin URL, start time, and end time. |
| DescribeLivePullStreamConfig | Queries the scheduled stream pulling configurations for a domain name. |
| DeleteLivePullStreamInfoConfig | Deletes a scheduled stream pulling configuration. |
| SetLiveLazyPullStreamInfoConfig | Configures triggered stream pulling. |
| DescribeLiveLazyPullStreamConfig | Queries the triggered stream pulling configurations for a streaming domain. |
| DeleteLiveLazyPullStreamInfoConfig | Deletes a triggered stream pulling configuration. |
| UpdateLivePullStreamInfoConfig | Updates a scheduled stream pulling configuration, including the origin URL, start time, and end time. |
Stream Prefetch
| API | Description |
|---|---|
| SetLiveStreamPreloadTasks | Creates tasks to prefetch live streams in batches. |
| DescribeLiveStreamPreloadTasks | Queries prefetch tasks from the last three days. |
| HotLiveRtcStream | Prefetches Real-Time Communication (RTC) streams. |
Primary/Standby Stream Merging
| API | Description |
|---|---|
| DeleteLiveStreamMerge | Deletes an active merged stream. |
| AddLiveStreamMerge | Adds a primary/standby stream merge configuration. |
| DescribeLiveStreamMerge | Queries primary/standby stream merge configurations. |
Stream Delay
| API | Description |
|---|---|
| CreateLiveDelayConfig | Creates a stream delay configuration. |
| UpdateLiveDelayConfig | Updates a stream delay configuration. |
| DescribeLiveDelayConfig | Queries a stream delay configuration. |
| ListLiveDelayConfig | Queries stream delay configurations. |
| DeleteLiveDelayConfig | Deletes a stream delay configuration. |
Streaming Latency
| API | Description |
|---|---|
| DescribeLiveStreamDelayConfig | Queries the live streaming latency configuration. |
| SetLiveStreamDelayConfig | Configures live streaming latency. |
Transcoding
| API | Description |
|---|---|
| AddLiveStreamTranscode | Adds a transcoding configuration for a streaming domain. |
| AddCustomLiveStreamTranscode | Adds a custom transcoding configuration. |
| AddRtsLiveStreamTranscode | Adds a custom transcoding configuration for a streaming domain with Real-Time Streaming (RTS) enabled. |
| UpdateCustomLiveStreamTranscode | Updates a custom transcoding configuration. |
| UpdateLiveStreamTranscode | Updates a default transcoding configuration. |
| UpdateRtsLiveStreamTranscode | Updates the configuration of a custom RTS transcoding template. |
| DeleteLiveStreamTranscode | Deletes a transcoding configuration. |
| DescribeLiveStreamTranscodeInfo | Queries transcoding configurations. |
| AddTrancodeSEI | Inserts Supplemental Enhancement Information (SEI) data into transcoded streams. |
Edge Transcoding
| API | Description |
|---|---|
| CreateEdgeTranscodeJob | Creates an edge transcoding job. |
| UpdateEdgeTranscodeJob | Updates an edge transcoding job. |
| DeleteEdgeTranscodeJob | Deletes an edge transcoding job. |
| GetEdgeTranscodeJob | Queries the details of an edge transcoding job. |
| ListEdgeTranscodeJob | Queries edge transcoding jobs. |
| StartEdgeTranscodeJob | Starts an edge transcoding job. |
| StopEdgeTranscodeJob | Stops an edge transcoding job. |
| ListEdgeTranscodeTemplate | Queries edge transcoding templates. |
| GetEdgeTranscodeTemplate | Queries the details of an edge transcoding template. |
Recording to ApsaraVideo VOD
| API | Description |
|---|---|
| AddLiveRecordVodConfig | Adds a live-to-VOD configuration to store recordings in ApsaraVideo VOD. |
| UpdateLiveRecordVodConfig | Updates a live-to-VOD configuration. |
| DeleteLiveRecordVodConfig | Deletes a live-to-VOD configuration. |
| DescribeLiveRecordVodConfigs | Queries live-to-VOD configurations. |
Recording to OSS
| API | Description |
|---|---|
| AddLiveAppRecordConfig | Configures live recording settings and saves the output to Object Storage Service (OSS). |
| UpdateLiveAppRecordConfig | Updates a live stream recording configuration that saves the output to OSS. |
| DeleteLiveAppRecordConfig | Deletes a recording configuration at the AppName level. |
| RealTimeRecordCommand | Starts or stops recording on demand. |
| DescribeLiveRecordConfig | Queries all recording configurations of an AppName for a streaming domain. |
| DescribeLiveStreamRecordContent | Queries the recordings of a live stream. |
| CreateLiveStreamRecordIndexFiles | Creates an M3U8 manifest for a specified time range. |
| DescribeLiveStreamRecordIndexFile | Queries a single recording manifest. |
| DescribeLiveStreamRecordIndexFiles | Queries all recording manifests within a specified time range. |
| DeleteLiveStreamRecordIndexFiles | Deletes the index files of live stream recordings. |
| AddLiveRecordNotifyConfig | Adds a recording callback configuration for a specific domain. |
| DescribeLiveRecordNotifyConfig | Queries the recording callback configuration for a domain name. |
| UpdateLiveRecordNotifyConfig | Updates the recording callback configuration for a domain name. |
| DeleteLiveRecordNotifyConfig | Deletes the recording callback configuration for a domain name. |
| DescribeLiveRecordNotifyRecords | Queries the callback records of live stream recordings stored in OSS. |
Snapshots
| API | Description |
|---|---|
| AddLiveAppSnapshotConfig | Configures snapshots for a streaming domain. Snapshots are stored in OSS. Takes effect after you restart stream ingest. |
| UpdateLiveAppSnapshotConfig | Updates a snapshot configuration. Takes effect after you restart stream ingest. |
| DeleteLiveAppSnapshotConfig | Deletes the snapshot configuration for live streams in an application. Takes effect after you restart stream ingest. |
| DeleteSnapshotFiles | Deletes specified snapshot files. |
| DescribeLiveSnapshotConfig | Queries the snapshot configurations of a streaming domain. |
| DescribeLiveStreamSnapshotInfo | Queries snapshots captured within a specific time period. |
| AddLiveSnapshotNotifyConfig | Configures snapshot callbacks. |
| DescribeLiveSnapshotNotifyConfig | Queries the snapshot callback configuration. |
| UpdateLiveSnapshotNotifyConfig | Updates the snapshot callback configuration. |
| DeleteLiveSnapshotNotifyConfig | Deletes the snapshot callback configuration. |
| SetSnapshotCallbackAuth | Configures authentication for snapshot callbacks. |
| QuerySnapshotCallbackAuth | Queries the authentication configuration for snapshot callbacks. |
| DeleteSnapshotCallbackAuth | Deletes the authentication configuration for snapshot callbacks. |
Encapsulation
| API | Description |
|---|---|
| AddLivePackageConfig | Adds a live stream encapsulation configuration. |
| UpdateLivePackageConfig | Updates a live stream encapsulation configuration. |
| DescribeLivePackageConfig | Queries the live stream encapsulation configurations for a specified streaming domain. |
| DeleteLivePackageConfig | Deletes a live stream encapsulation configuration. |
Watermarks
| API | Description |
|---|---|
| AddLiveStreamWatermark | Adds a watermark template. |
| UpdateLiveStreamWatermark | Updates a watermark template. |
| DeleteLiveStreamWatermark | Deletes a watermark template. |
| DescribeLiveStreamWatermarks | Queries watermark templates. |
| AddLiveStreamWatermarkRule | Adds a watermark rule. |
| UpdateLiveStreamWatermarkRule | Updates a watermark rule. |
| DeleteLiveStreamWatermarkRule | Deletes a watermark rule. |
| DescribeLiveStreamWatermarkRules | Queries watermark rules. |
| DynamicUpdateWaterMarkStreamRule | Dynamically updates a watermark on a live stream. |
Content Moderation
| API | Description |
|---|---|
| AddLiveSnapshotDetectPornConfig | Adds a video moderation configuration for live streams in an application under a domain name. |
| AddLiveDetectNotifyConfig | Configures the callback URL for video moderation results. |
| DescribeLiveSnapshotDetectPornConfig | Queries video moderation configurations. |
| DescribeLiveDetectNotifyConfig | Queries the callback configuration for video moderation results. |
| UpdateLiveSnapshotDetectPornConfig | Updates a video moderation configuration. |
| UpdateLiveDetectNotifyConfig | Updates the callback URL for video moderation results. |
| DeleteLiveSnapshotDetectPornConfig | Deletes a video moderation configuration. |
| DeleteLiveDetectNotifyConfig | Deletes the callback configuration for video moderation results. |
| AddLiveAudioAuditConfig | Adds an audio moderation configuration. |
| AddLiveAudioAuditNotifyConfig | Adds a callback configuration for audio moderation. |
| DescribeLiveAudioAuditConfig | Queries audio moderation configurations. |
| DescribeLiveAudioAuditNotifyConfig | Queries the callback configuration for audio moderation. |
| UpdateLiveAudioAuditConfig | Updates an audio moderation configuration. |
| UpdateLiveAudioAuditNotifyConfig | Updates the callback configuration for audio moderation. |
| DeleteLiveAudioAuditConfig | Deletes an audio moderation configuration. |
| DeleteLiveAudioAuditNotifyConfig | Deletes the callback configuration for audio moderation from a streaming domain. |
Time Shifting
| API | Description |
|---|---|
| OpenLiveShift | Enables time shifting for a specified domain name, application, or stream. |
| DescribeLiveShiftConfigs | Queries the time shifting configurations for a specified domain name. |
| CloseLiveShift | Disables time shifting for a domain name, application, or stream. |
Real-Time Captions
| API | Description |
|---|---|
| AddLiveAIProduceRules | Adds a caption rule. |
| UpdateLiveAIProduceRules | Updates a caption rule. |
| DescribeLiveAIProduceRules | Queries caption rules. |
| DeleteLiveAIProduceRules | Deletes caption rules. |
| AddLiveAISubtitle | Adds a caption template. |
| UpdateLiveAISubtitle | Updates a caption template. |
| DescribeLiveAISubtitle | Queries caption templates. |
| DeleteLiveAISubtitle | Deletes a caption template. |
Virtual Background
| API | Description |
|---|---|
| CreateLiveAIStudio | Creates a lightweight virtual studio template. |
| ModifyLiveAIStudio | Modifies a virtual studio template. |
| DescribeLiveAIStudio | Queries the virtual studio templates in your account. |
| DeleteLiveAIStudio | Deletes a virtual studio template. |
Monitoring and Statistics
| API | Description |
|---|---|
| DescribeLiveDomainBpsData | Queries the network bandwidth monitoring data for one or more streaming domains. |
| DescribeLiveDomainTrafficData | Queries network traffic monitoring data for live streaming domains. |
| DescribeLiveDomainBpsDataByLayer | Queries bandwidth and traffic data for domain names by protocol. |
| DescribeLiveDomainRealTimeBpsData | Queries bandwidth data for a domain name at 1-minute granularity. |
| DescribeLiveDomainRealTimeTrafficData | Queries real-time traffic monitoring data for live streaming domains. |
| DescribeLiveDomainRealTimeHttpCodeData | Queries the distribution of HTTP status codes for an accelerated domain name at 1-minute granularity. |
| DescribeLiveDomainPushBpsData | Queries network bandwidth monitoring data for ingest domains. |
| DescribeLiveDomainPushTrafficData | Queries stream ingest traffic monitoring data for ingest domains. |
| DescribeLiveDomainPublishErrorCode | Queries the HTTP status codes returned within a specified period for an ingest domain. |
| DescribeLiveStreamTranscodeMetricData | Queries transcoding metrics for a specified domain name at the application and stream levels. |
| DescribeLiveCenterStreamRateData | Queries the audio and video frame rates and bitrates of a stream in a live center. |
| DescribeLiveStreamPushMetricDetailData | Queries stream ingest metrics for a specified domain name at the application and stream levels. |
| DescribeLiveUpVideoAudioInfo | Queries the audio and video parameters of an upstream ingest stream within a specified time range. |
| DescribeLiveStreamHistoryUserNum | Queries the number of historical online users for a live stream. |
| DescribeLiveStreamTranscodeStreamNum | Queries the number of transcoded streams in real time. |
| DescribeLiveDomainPvUvData | Queries the page view (PV) and unique visitor (UV) data for a specified streaming domain. |
| DescribeLiveTopDomainsByFlow | Queries a list of domain names ranked by traffic. |
| DescribeLiveStreamsTotalCount | Queries the cumulative daily count of live streams. |
| DescribeLiveStreamMetricDetailData | Queries streaming metrics in batches for a specified domain name. Returns a maximum of 5,000 rows per request. |
| DescribeLiveStreamDetailFrameRateAndBitRateData | Queries the detailed audio and video frame rates and bitrates of an RTMP live stream. |
| DescribeLiveUserStreamMetricData | Queries streaming metrics at the stream level for a specified accelerated domain name. Supports multiple protocols. |
| DescribeLiveInteractionMetricData | Queries the metric data of Alibaba Real-Time Communication (ARTC). |
Usage Data
| API | Description |
|---|---|
| DescribeDomainUsageData | Queries usage data for one or more domain names in a specific billing region. |
| DescribeLiveDomainRecordUsageData | Queries the number of concurrent recordings and container format conversion usage. |
| DescribeLiveDomainSnapshotData | Queries the number of snapshots for a live streaming domain. |
| DescribeLiveDetectPornData | Queries usage data for live stream content moderation. |
| DescribeLivePushProxyUsageData | Queries usage data for the stream ingest proxy feature of the live center. |
| DescribeLiveRealtimeDeliveryAcc | Queries the number of real-time log deliveries. |
| DescribeLiveDomainTimeShiftData | Queries usage data for time shifting. |
| DescribeLiveDomainStreamTranscodeData | Queries transcoding usage data for a domain name. |
| DescribeLiveProducerUsageData | Queries usage data for a production studio. |
| DescribeLiveDomainMonitoringUsageData | Queries monitoring usage data for a domain name. |
| DescribeLiveDelayedStreamingUsage | Queries usage data for delayed streaming. |
| DescribeLiveGrtnDuration | Queries usage data for co-streaming duration. |
| DescribeLiveDrmUsageData | Queries Digital Rights Management (DRM) usage data within a specified time range. |
| DescribeLiveRtcRecordUsageData | Queries usage data for cloud recording. |
| DescribeLiveUserBillPrediction | Queries the bill prediction for a live streaming user. |
| DescribeUpBpsPeakData | Queries the daily peak upstream bandwidth for a user. |
| DescribeUpBpsPeakOfLine | Queries the daily peak upstream bandwidth on a specific leased line for a user. |
| DescribeUpPeakPublishStreamData | Queries the daily peak number of concurrent upstream ingest streams for a user. |
| DescribeMeterLiveBypassDuration | Queries live bypass duration metrics. |
Stream Monitoring
| API | Description |
|---|---|
| CreateLiveStreamMonitor | Creates a monitoring session. |
| UpdateLiveStreamMonitor | Updates the configurations of a monitoring session. |
| DescribeLiveStreamMonitorList | Queries monitoring sessions. |
| StartLiveStreamMonitor | Starts a monitoring session. |
| StopLiveStreamMonitor | Stops a monitoring session. |
| DeleteLiveStreamMonitor | Deletes a monitoring session. |
Global Accelerator
| API | Description |
|---|---|
| CreateLivePrivateLine | Creates a Global Accelerator (GA) instance and binds it to an acceleration circuit. |
| DeleteLivePrivateLine | Detaches a GA instance from a live stream link. |
| DescribeLivePrivateLineAreas | Queries the available origin points for GA links. |
| DescribeLivePrivateLineAvailGA | Queries the binding information between a GA instance and a live channel. |
Dual-Stream Disaster Recovery
| API | Description |
|---|---|
| SetLiveDomainMultiStreamConfig | Configures dual-stream disaster recovery for a streaming domain. |
| SetLiveDomainMultiStreamOptimalMode | Configures the automatic mode of dual-stream disaster recovery. |
| SetLiveDomainMultiStreamMaster | Manually switches between the active stream and standby stream. |
| DescribeLiveDomainMultiStreamConfig | Queries the configuration status of dual-stream disaster recovery. |
| QueryLiveDomainMultiStreamList | Queries the online records of dual-stream disaster recovery. |
Stream Relay (Pull-to-Push)
| API | Description |
|---|---|
| CreateLivePullToPush | Creates a stream relay task. |
| UpdateLivePullToPush | Updates a stream relay task. |
| DeleteLivePullToPush | Deletes a stream relay task. |
| DescribeLivePullToPush | Queries stream relay tasks. |
| DescribeLivePullToPushList | Queries stream relay tasks using a fuzzy search. |
| StopLivePullToPush | Stops a stream relay task. |
| RestartLivePullToPush | Restarts a stream relay task. |
Stream Transfer
| API | Description |
|---|---|
| AddLiveCenterTransfer | Adds a live center stream relay configuration. |
| DescribeLiveCenterTransfer | Queries live center stream relay configurations. |
| UpdateLiveCenterTransfer | Updates a live center stream relay configuration. |
| DeleteLiveCenterTransfer | Deletes a live center stream relay configuration. |
| SetLiveEdgeTransfer | Configures live stream edge transfer settings. |
| DescribeLiveEdgeTransfer | Queries edge stream relay configurations. |
| DeleteLiveEdgeTransfer | Deletes a live stream edge transfer configuration. |
Production Studio
Studio management
| API | Description |
|---|---|
| CreateCaster | Creates a production studio. |
| SetCasterConfig | Configures a production studio, including the name, transcoding settings, recording settings, and other parameters. |
| DescribeCasterConfig | Queries the configuration of a production studio. |
| DescribeCasters | Queries a list of production studios. |
| DescribeCasterStreamUrl | Queries the stream URL of a production studio. |
| CopyCaster | Duplicates a production studio and creates a new instance. |
| StartCaster | Starts a production studio. Creates the Preview (PVW) and Program (PGM) scenes if they do not exist, then starts the scenes and audio/video processing tasks. |
| StopCaster | Stops a production studio. Stops the PVW and PGM scenes. |
| DeleteCaster | Deletes a production studio. |
| RestartCaster | Restarts a production studio. |
| UpdateCasterResourceGroup | Updates the resource group of a production studio. |
Source media management
| API | Description |
|---|---|
| AddCasterVideoResource | Adds a video source to a production studio. The number of video sources is limited by the number of ingest endpoints in the studio. |
| DeleteCasterVideoResource | Removes an input source from a production studio. |
| ModifyCasterVideoResource | Modifies the video resources of a production studio. |
| DescribeCasterVideoResources | Queries the video sources of a production studio. |
Layout management
| API | Description |
|---|---|
| AddCasterLayout | Adds a layout to a production studio. |
| DeleteCasterLayout | Deletes a layout from a production studio. |
| ModifyCasterLayout | Modifies a layout configuration. You only need to pass the parameters you want to change. |
| DescribeCasterLayouts | Queries the layouts of a production studio. |
Component management
| API | Description |
|---|---|
| AddCasterComponent | Adds a component to a production studio. |
| DeleteCasterComponent | Deletes a component from a production studio. |
| ModifyCasterComponent | Modifies a component of a production studio. |
| DescribeCasterComponents | Queries the components of a production studio. |
Scene and audio management
| API | Description |
|---|---|
| SetCasterSceneConfig | Replaces all settings of a scene with new settings, including the layout. |
| UpdateCasterSceneConfig | Updates a scene configuration without clearing previous settings. More efficient than SetCasterSceneConfig. |
| CopyCasterSceneConfig | Applies the configuration of a PVW scene to a PGM scene. |
| DeleteCasterSceneConfig | Deletes the scene configuration of a production studio. |
| DescribeCasterScenes | Queries the scenes of a production studio. |
| UpdateCasterSceneAudio | Updates the audio configuration of a scene. You can also add a new audio configuration or apply an existing configuration to a different scene. |
| DescribeCasterSceneAudio | Queries the audio configuration of a scene. |
| StartCasterScene | Starts a specified PVW (preview) scene. |
| StopCasterScene | Stops a specified PVW (preview) scene. |
Channel management
| API | Description |
|---|---|
| SetCasterChannel | Sets a channel for a production studio. |
| DescribeCasterChannels | Queries the channels of a production studio. |
Standby stream management
| API | Description |
|---|---|
| EffectCasterUrgent | Switches a production studio to the standby resource. |
| EffectCasterVideoResource | Updates the standby video of a production studio. |
Playlist mode (new)
| API | Description |
|---|---|
| AddShowIntoShowList | Adds an episode to an episode list. |
| RemoveShowFromShowList | Removes an episode from an episode list. |
| ModifyShowList | Modifies the attributes of an episode list. |
| DescribeShowList | Queries a playlist. |
| PlayChoosenShow | Switches to a specified episode. |
| InitializeAutoShowListTask | Creates a scheduled task. |
| DescribeAutoShowListTasks | Queries scheduled tasks for automatic start and stop. |
| EditShowAndReplace | Creates a video editing job. |
| GetEditingJobInfo | Queries information about video editing jobs. |
| SetShowListBackground | Sets the background for a playlist. |
Virtual studio management
| API | Description |
|---|---|
| AddStudioLayout | Adds layout settings for a virtual production studio. |
| DeleteStudioLayout | Deletes a layout from a virtual studio. |
| ModifyStudioLayout | Modifies the layout of a virtual studio. |
| DescribeStudioLayouts | Queries the layouts of a virtual studio. |
Playlist mode (legacy)
| API | Description |
|---|---|
| AddCasterEpisode | Adds an episode to a production studio. |
| DeleteCasterEpisode | Deletes an episode from a production studio. |
| ModifyCasterEpisode | Modifies the configuration of a production studio episode. The episode type cannot be changed. |
| AddCasterEpisodeGroup | Adds an episode list to a production studio. |
| DeleteCasterEpisodeGroup | Deletes an episode list from a production studio. |
| AddCasterEpisodeGroupContent | Adds content to an episode group of a production studio. |
| AddCasterProgram | Adds a program list to a production studio. |
| DescribeCasterProgram | Queries the program list of a production studio. |
| ModifyCasterProgram | Modifies the program list of a production studio. |
| DeleteCasterProgram | Deletes the episode list for carousel playback in a production studio. |
| AddPlaylistItems | Adds items to a playlist. |
| DeletePlaylistItems | Deletes items from a playlist. |
| ListPlaylistItems | Queries the items in a specified playlist. |
| EditPlaylist | Edits a playlist. |
| DeletePlaylist | Deletes an entire playlist. |
| ListPlaylist | Queries episode lists. |
| StartPlaylist | Starts a playlist. |
| StopPlaylist | Stops a playlist. |
Cloud-based stream merging
|
API |
Title |
Description |
Interactive Messaging (Server-Side)
| API | Description |
|---|---|
| GetMessageToken | Obtains a persistent connection token. The client uses this token to communicate with capabilities through the LWP protocol. |
| CreateMessageApp | Creates an interactive messaging application. |
| UpdateMessageApp | Updates an interactive messaging application. |
| ListMessageApp | Queries interactive messaging applications. |
| GetMessageApp | Queries the details of an interactive messaging application. |
| QueryMessageApp | Queries interactive messaging applications based on specified conditions. |
| DeleteMessageApp | Deletes an interactive messaging application. |
| CreateMessageGroup | Creates a message group. |
| UpdateMessageGroup | Updates message group information. |
| GetMessageGroup | Queries the details of a message group. |
| ListMessageGroup | Queries the message groups for a specified user. |
| ListMessageGroupUser | Queries message group members. |
| ListMessageGroupUserById | Queries user information by user ID list. |
| JoinMessageGroup | Adds a user to a message group. |
| LeaveMessageGroup | Removes a user from a message group. |
| MuteGroupUser | Mutes one or more members in a message group. |
| CancelMuteGroupUser | Unmutes one or more members in a message group. |
| MuteAllGroupUser | Mutes an entire message group. |
| CancelMuteAllGroupUser | Unmutes an entire message group. |
| ListMuteGroupUser | Queries the muted members in a message group. |
| SendMessageToGroup | Sends a message to all members of a message group. |
| SendMessageToGroupUsers | Sends a message to specified users in a message group. |
| SendLike | Sends a like message. |
| ListMessage | Queries the message list. |
| BatchGetOnlineUsers | Queries whether one or more users are online based on their UIDs. |
Interactive Messaging (New)
| API | Description |
|---|---|
| CreateLiveMessageApp | Creates an interactive messaging application. |
| DescribeLiveMessageApp | Queries an interactive messaging application. |
| ListLiveMessageApps | Queries interactive messaging applications. |
| ModifyLiveMessageAppAudit | Modifies the content moderation settings of an interactive messaging application. |
| ModifyLiveMessageAppCallback | Modifies the callback settings of an interactive messaging application. |
| ModifyLiveMessageAppDisable | Disables or enables an interactive messaging application. |
| ModifyLiveMessageUserInfo | Modifies the information about a user. |
| CreateLiveMessageGroup | Creates an interactive messaging group. |
| ModifyLiveMessageGroup | Modifies the information of an interactive messaging group. |
| DescribeLiveMessageGroup | Queries the information about an interactive messaging group. |
| DeleteLiveMessageGroup | Deletes an interactive messaging group. |
| RecoverLiveMessageDeletedGroup | Restores a deleted interactive messaging group. |
| ListLiveMessageGroups | Queries the interactive messaging groups in an application. |
| ListLiveMessageGroupByPage | Queries interactive messaging groups by page. |
| ListLiveMessageGroupUsers | Queries users in an interactive messaging group. |
| CheckLiveMessageUsersInGroup | Checks whether a user is in an interactive messaging group. |
| CheckLiveMessageUsersOnline | Checks whether one or more specified users are online. |
| KickLiveMessageGroupUser | Removes a user from an interactive messaging group. |
| BanLiveMessageGroup | Mutes a user in an interactive messaging group. |
| UnbanLiveMessageGroup | Unmutes a user in an interactive messaging group. |
| AddLiveMessageGroupBand | Mutes users in a group. |
| ModifyLiveMessageGroupBand | Modifies the mute status of users in a group. |
| RemoveLiveMessageGroupBand | Unmutes users in an interactive messaging group. |
| DescribeLiveMessageGroupBand | Queries the mute status of users. |
| SendLiveMessageGroup | Sends a message to a group. |
| SendLiveMessageUser | Sends a message to a specified user. |
| ListLiveMessageGroupMessages | Queries messages sent in a group. |
| DeleteLiveMessageGroupMessage | Deletes a message from an interactive messaging group. |
| DeleteLiveMessageUserMessage | Deletes a message sent to a user. |
ApsaraVideo Real-Time Communication
Cloud recording
| API | Description |
|---|---|
| StartRtcCloudRecording | Starts an RTC cloud recording task. |
| UpdateRtcCloudRecording | Updates an RTC cloud recording task. |
| StopRtcCloudRecording | Stops an RTC cloud recording task. |
| DescribeRtcCloudRecordingFiles | Queries information about RTC cloud recording files and tasks. |
Channel management
| API | Description |
|---|---|
| CreateRTCWhipStreamAddress | Creates a WHIP ingest URL for an RTC channel. |
| CreateRoomRealTimeStreamAddress | Creates an RTMP ingest URL for a channel. |
| DeleteChannel | Closes a channel and removes all current members. The channel can be reused later. |
| ListRTCLiveRooms | Queries active ARTC channels. |
| DescribeChannelParticipants | Queries online users in a channel. |
| DescribeChannelUsers | Queries the details of online users in a channel. |
| RemoveTerminals | Removes users from a channel. |
Bypass stream forwarding
| API | Description |
|---|---|
| StartLiveMPUTask | Creates a stream mixing and transcoding task. |
| UpdateLiveMPUTask | Updates a mixed-stream relay task. |
| StopLiveMPUTask | Stops a mixed-stream relay task. |
| ListRtcMPUTaskDetail | Queries the parameters of mixed-stream relay tasks. |
| SetLiveMpuTaskSei | Configures custom Supplemental Enhancement Information (SEI) for co-streaming. |
Cloud transcoding
| API | Description |
|---|---|
| StartRtcCloudTranscode | Starts a cloud transcoding job. |
| StopRtcCloudTranscode | Stops a cloud transcoding job. |
| DescribeRtcCloudTranscode | Queries the details of an RTC cloud transcoding job. |
Event callbacks
| API | Description |
|---|---|
| CreateEventSub | Creates a callback to subscribe to channel or user events. |
| UpdateEventSub | Updates a callback for subscribing to channel or user events. |
| DeleteEventSub | Deletes a callback for subscribing to channel or user events. |
| ListEventSub | Queries the events generated in subscribed channels. |
| ListEventSubEvent | Queries callback records. |
| CreateRtcMPUEventSub | Creates a subscription to mixed-stream relay events. |
| UpdateRtcMPUEventSub | Updates a subscription to mixed-stream relay events. |
| DeleteRtcMPUEventSub | Deletes a subscription to mixed-stream relay events. |
| DescribeRtcMPUEventSub | Queries a subscription to mixed-stream relay events. |
| ListRtcMPUEventSubRecord | Queries the callback records of a subscription to mixed-stream relay events. |
Real-time speech transcription and translation
| API | Description |
|---|---|
| CreateRtcAsrTask | Creates a live subtitle task to transcribe an audio stream to text in real time. |
| QueryRtcAsrTasks | Queries the status of real-time speech-to-text or translation tasks. |
| StopRtcAsrTask | Stops a live subtitle task. |
| DeleteRtcAsrTask | Deletes a real-time speech-to-text or translation task. |
RTS SDK Statistics
| API | Description |
|---|---|
| DescribeRTSNativeSDKFirstFrameCost | Queries the composition of first-frame latency within a specified time period. |
| DescribeRTSNativeSDKFirstFrameDelay | Queries the average first-frame delay over a specified period. |
| DescribeRTSNativeSDKPlayFailStatus | Queries playback failure status codes within a specified time range. |
| DescribeRTSNativeSDKPlayTime | Queries the playback duration within a specified time range. |
| DescribeRTSNativeSDKVvData | Queries the total and successful playback counts within a specified time period. |
Log Management
| API | Description |
|---|---|
| CreateLiveRealTimeLogDelivery | Configures real-time log delivery for a domain name. |
| EnableLiveRealtimeLogDelivery | Enables real-time log delivery for a domain name. |
| DisableLiveRealtimeLogDelivery | Pauses real-time log delivery for a domain name. |
| ModifyLiveRealtimeLogDelivery | Modifies the real-time log delivery configuration for a domain name. |
| DeleteLiveRealtimeLogDelivery | Deletes a real-time log delivery configuration. |
| DeleteLiveRealTimeLogLogstore | Deletes a Logstore for real-time log delivery. |
| DescribeLiveDomainRealtimeLogDelivery | Queries the real-time log delivery information for a domain name. |
| DescribeLiveRealtimeLogAuthorized | Queries the authorization status for real-time log delivery. |
| ListLiveRealtimeLogDelivery | Queries all real-time log delivery configurations. |
| ListLiveRealtimeLogDeliveryDomains | Queries all streaming domains configured for real-time log delivery. |
| ListLiveRealtimeLogDeliveryInfos | Queries information about all real-time log delivery services. |
| DescribeLivePushProxyLog | Queries the download URLs for offline logs of proxied live streams. |
| DescribeLiveDomainLog | Queries the download URLs for the raw access logs of a specified live streaming domain. |
EdgeScript
| API | Description |
|---|---|
| SetLiveDomainStagingConfig | Sets or modifies domain configurations in the canary release environment. |
| DescribeLiveDomainStagingConfig | Queries the feature configurations of an accelerated domain name in the canary release environment. |
| PublishLiveStagingConfigToProduction | Publishes configurations from the canary release environment to the production environment. |
| RollbackLiveStagingConfig | Rolls back configurations in the canary release environment. |
| DeleteLiveSpecificStagingConfig | Deletes domain configurations in the canary release environment. |
Tag Management
| API | Description |
|---|---|
| TagLiveResources | Adds tags to a domain name in ApsaraVideo Live. |
| UnTagLiveResources | Removes tags from a domain name in ApsaraVideo Live. |
| ListLiveTagResources | Queries resources and tags based on specified conditions. |
| DescribeLiveTagResources | Queries the tags of ApsaraVideo Live resources. |
Toolbox
| API | Description |
|---|---|
| DescribeLiveIpInfo | Checks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP). |
| DescribeLiveStreamAuthChecking | Queries the authentication status of an active stream. |
Toutiao Live Streaming
| API | Description |
|---|---|
| DescribeToutiaoLivePlay | Queries stream pulling information for a specified Toutiao live stream. |
| DescribeToutiaoLivePublish | Queries the stream ingest information for a specified Toutiao live stream. |