This product(
live/2016-11-01
) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Domain name management
API | Title | Description |
---|---|---|
AddLiveDomain | AddLiveDomain | Adds a domain name to ApsaraVideo Live. |
AddLiveDomainPlayMapping | AddLiveDomainPlayMapping | Maps a sub-streaming domain to a main streaming domain. |
DeleteLiveDomainPlayMapping | DeleteLiveDomainPlayMapping | Deletes the mapping between a main streaming domain and a sub-streaming domain. |
AddLiveDomainMapping | AddLiveDomainMapping | Creates the mapping between a streaming domain and an ingest domain. |
DeleteLiveDomain | DeleteLiveDomain | Removes a domain name from ApsaraVideo Live. |
DeleteLiveDomainMapping | DeleteLiveDomainMapping | Deletes the mapping between a streaming domain and an ingest domain. |
DescribeLiveDomainMapping | DescribeLiveDomainMapping | Queries the mappings of an ingest domain, a main streaming domain, or a sub-streaming domain. |
DescribeLiveDomainDetail | DescribeLiveDomainDetail | Queries the basic information about a domain name. |
DescribeLiveUserDomains | DescribeLiveUserDomains | Queries domain names of ApsaraVideo Live in your Alibaba Cloud account. |
StartLiveDomain | StartLiveDomain | Enables a disabled domain name. After the domain name is enabled, its status changes to online. |
StopLiveDomain | StopLiveDomain | Disables an enabled domain name. After the domain name is disabled, its status changes to offline. |
DescribeLiveCertificateDetail | DescribeLiveCertificateDetail | Queries the details of a certificate. |
DescribeLiveDomainCertificateInfo | DescribeLiveDomainCertificateInfo | Queries certificate information about a domain name. |
DescribeLiveCertificateList | DescribeLiveCertificateList | Queries the certificates of one or more specified domain names or all certificates within your Alibaba Cloud account. |
SetLiveDomainCertificate | SetLiveDomainCertificate | Enables or disables the certificate of a domain name, and modifies the certificate information. |
BatchDeleteLiveDomainConfigs | BatchDeleteLiveDomainConfigs | Deletes the configurations of multiple domain names at a time. |
BatchSetLiveDomainConfigs | BatchSetLiveDomainConfigs | Configures multiple domain names at a time. |
DescribeLiveDomainConfigs | DescribeLiveDomainConfigs | Queries one or more configurations of a domain name. |
DescribeLiveDomainByCertificate | DescribeLiveDomainByCertificate | Queries the accelerated domain names that match a certificate. |
DescribeLiveHttpsDomainList | DescribeLiveHttpsDomainList | Queries the information about all certificates that you have configured. |
ModifyLiveDomainSchdmByProperty | ModifyLiveDomainSchdmByProperty | Modifies the acceleration region of a domain name. |
DescribeLiveUserTags | DescribeLiveUserTags | |
VerifyLiveDomainOwner | VerifyLiveDomainOwner | Verifies the ownership of a domain name. |
Prefetch
API | Title | Description |
---|---|---|
SetLiveStreamPreloadTasks | SetLiveStreamPreloadTasks | |
DescribeLiveStreamPreloadTasks | DescribeLiveStreamPreloadTasks | |
HotLiveRtcStream | HotLiveRtcStream | Configures prefetch for a live stream that is ingested based on Real-Time Communication (RTC). |
Live stream pulling
API | Title | Description |
---|---|---|
AddLivePullStreamInfoConfig | AddLivePullStreamInfoConfig | Creates a stream pulling configuration for a live stream. |
DescribeLivePullStreamConfig | DescribeLivePullStreamConfig | Queries the stream pulling configurations for a domain name. |
DeleteLivePullStreamInfoConfig | DeleteLivePullStreamInfoConfig | Deletes a stream pulling configuration. |
SetLiveLazyPullStreamInfoConfig | SetLiveLazyPullStreamInfoConfig | Creates a configuration of triggered stream pulling. |
DescribeLiveLazyPullStreamConfig | DescribeLiveLazyPullStreamConfig | Queries the configurations of triggered stream pulling for a streaming domain. |
DeleteLiveLazyPullStreamInfoConfig | DeleteLiveLazyPullStreamInfoConfig | Deletes a configuration of triggered stream pulling. |
UpdateLivePullStreamInfoConfig | UpdateLivePullStreamInfoConfig | Modifies the stream pulling configurations of a live stream. |
Live stream management
API | Title | Description |
---|---|---|
DescribeLiveStreamsBlockList | DescribeLiveStreamsBlockList | Queries the blacklist of live stream URLs under a main streaming domain. |
DescribeLiveStreamsControlHistory | DescribeLiveStreamsControlHistory | Queries the operation history of live streams under a domain name or in an application. |
DescribeLiveStreamBitRateData | DescribeLiveStreamBitRateData | Queries the frame rates and bitrates of a live stream that is based on Real-Time Messaging Protocol (RTMP) in a specified time period. |
DescribeLiveStreamsOnlineList | DescribeLiveStreamsOnlineList | Queries the information about all active streams under a specified domain name or the active streams of an application under a specified domain name. |
DescribeLiveStreamsPublishList | DescribeLiveStreamsPublishList | Queries the stream ingest records of a domain name or an application or stream under a domain name. |
ForbidLiveStream | ForbidLiveStream | Disables a live stream. You can specify the time when the live stream is resumed. |
ResumeLiveStream | ResumeLiveStream | Resumes the ingest of a live stream. |
DescribeLiveDomainOnlineUserNum | DescribeLiveDomainOnlineUserNum | Queries the number of online users at a specified point in time for all live streams under a specified domain name. |
DescribeLiveDomainFrameRateAndBitRateData | DescribeLiveDomainFrameRateAndBitRateData | Queries the frame rates and bitrates of all live streams under an ingest domain. |
DescribeLiveDomainLimit | DescribeLiveDomainLimit | Queries the maximum numbers of ingested and transcoded streams for a streaming domain. |
DescribeLiveStreamState | DescribeLiveStreamState | Queries the status of a stream in real time. |
Edge node stream relay
API | Title | Description |
---|---|---|
DescribeLiveEdgeTransfer | DescribeLiveEdgeTransfer | Queries the configuration of edge node stream relay. |
DeleteLiveEdgeTransfer | DeleteLiveEdgeTransfer | Deletes the configuration of edge node stream relay. |
SetLiveEdgeTransfer | SetLiveEdgeTransfer | Sets the configuration of edge node stream relay. |
Live center stream relay
API | Title | Description |
---|---|---|
AddLiveCenterTransfer | AddLiveCenterTransfer | Adds a configuration of live center stream relay. |
UpdateLiveCenterTransfer | UpdateLiveCenterTransfer | Modifies the configurations of live center stream relay. |
DescribeLiveCenterTransfer | DescribeLiveCenterTransfer | Queries the information about a configuration of live center stream relay. |
DeleteLiveCenterTransfer | DeleteLiveCenterTransfer | Deletes a configuration of live center stream relay. |
Primary/secondary stream mixing
API | Title | Description |
---|---|---|
DeleteLiveStreamMerge | DeleteLiveStreamMerge | Deletes an active mixed stream. |
AddLiveStreamMerge | AddLiveStreamMerge | Invoke AddLiveStreamMerge to add primary and backup stream merging configuration. |
DescribeLiveStreamMerge | DescribeLiveStreamMerge | Invoke DescribeLiveStreamMerge to query the primary-standby stream merging configuration. |
Stream delay
API | Title | Description |
---|---|---|
DeleteLiveDelayConfig | DeleteLiveDelayConfig | Deletes a stream delay configuration. |
UpdateLiveDelayConfig | UpdateLiveDelayConfig | Updates a stream delay configuration. |
DescribeLiveDelayConfig | DescribeLiveDelayConfig | Queries the information about a stream delay configuration. |
ListLiveDelayConfig | ListLiveDelayConfig | Queries stream delay configurations. |
CreateLiveDelayConfig | CreateLiveDelayConfig | Adds a stream delay configuration. |
Stream ingest callback
API | Title | Description |
---|---|---|
SetLiveStreamsNotifyUrlConfig | SetLiveStreamsNotifyUrlConfig | Configures stream ingest callbacks under an ingest domain. |
DescribeLiveStreamsNotifyUrlConfig | DescribeLiveStreamsNotifyUrlConfig | Queries the callback configuration for stream ingest under an ingest domain. |
DeleteLiveStreamsNotifyUrlConfig | DeleteLiveStreamsNotifyUrlConfig | Deletes the callback configuration for stream ingest under an ingest domain. |
DescribeLiveStreamsNotifyRecords | DescribeLiveStreamsNotifyRecords | Queries stream ingest callback records. |
Live streaming security
API | Title | Description |
---|---|---|
DeleteLiveStreamBlock | DeleteLiveStreamBlock | Deletes a configuration of stream-level region blocking. |
SetLiveStreamBlock | SetLiveStreamBlock | Configures stream-level region blocking. |
DescribeStreamLocationBlock | DescribeStreamLocationBlock | Queries configurations of stream-level region blocking. |
Time shifting
API | Title | Description |
---|---|---|
DescribeLiveShiftConfigs | DescribeLiveShiftConfigs | Queries the time shifting configurations under a domain name. |
OpenLiveShift | OpenLiveShift | Enables time shifting for a domain name, or enables time shifting for an application or a live stream under the domain name. |
CloseLiveShift | CloseLiveShift | Disables time shifting for a domain name, or disables time shifting for an application or a live stream under the domain name. |
Live stream transcoding
API | Title | Description |
---|---|---|
AddLiveStreamTranscode | AddLiveStreamTranscode | Adds transcoding configurations for a streaming domain. |
AddCustomLiveStreamTranscode | AddCustomLiveStreamTranscode | Adds a custom transcoding configuration for a streaming domain. |
AddRtsLiveStreamTranscode | AddRtsLiveStreamTranscode | Creates a Real-Time Streaming (RTS) transcoding configuration for a streaming domain. |
UpdateCustomLiveStreamTranscode | UpdateCustomLiveStreamTranscode | Updates a custom transcoding configuration. |
UpdateLiveStreamTranscode | UpdateLiveStreamTranscode | Updates a transcoding configuration. |
UpdateRtsLiveStreamTranscode | UpdateRtsLiveStreamTranscode | Updates a custom Real-Time Streaming (RTS) transcoding configuration. |
DeleteLiveStreamTranscode | DeleteLiveStreamTranscode | Deletes a transcoding configuration. |
DescribeLiveStreamTranscodeInfo | DescribeLiveStreamTranscodeInfo | Queries the transcoding configurations of live streams under a main streaming domain. |
AddTrancodeSEI | AddTrancodeSEI | Inserts supplemental enhancement information (SEI) to a live stream when the live stream is transcoded. |
Store live recordings to ApsaraVideo VOD
API | Title | Description |
---|---|---|
AddLiveRecordVodConfig | AddLiveRecordVodConfig | Adds a Live-to-VOD configuration to store recordings in the media library of ApsaraVideo VOD. |
UpdateLiveRecordVodConfig | UpdateLiveRecordVodConfig | |
DeleteLiveRecordVodConfig | DeleteLiveRecordVodConfig | Deletes the configuration of the Live to VOD feature. |
DescribeLiveRecordVodConfigs | DescribeLiveRecordVodConfigs | Queries Live-to-VOD configurations. |
Store recordings to OSS
API | Title | Description |
---|---|---|
AddLiveAppRecordConfig | AddLiveAppRecordConfig | Configure APP recording, with output saved to OSS. |
RealTimeRecordCommand | RealTimeRecordCommand | Controls recordings manually on demand. For example, you can call this operation to start or stop recording at a specific point in time. |
UpdateLiveAppRecordConfig | UpdateLiveAppRecordConfig | Updates a recording configuration for an application. The recordings are stored in Object Storage Service (OSS). |
DeleteLiveAppRecordConfig | DeleteLiveAppRecordConfig | Deletes the recording configurations of an application. |
DeleteLiveStreamRecordIndexFiles | DeleteLiveStreamRecordIndexFiles | Deletes live stream recording files. |
DescribeLiveRecordConfig | DescribeLiveRecordConfig | Queries all recording configurations of an application for a streaming domain. |
DescribeLiveStreamRecordContent | DescribeLiveStreamRecordContent | Queries the recordings of a live stream. |
CreateLiveStreamRecordIndexFiles | CreateLiveStreamRecordIndexFiles | Creates an M3U8 index file for a recording in a specified time period. |
DescribeLiveStreamRecordIndexFile | DescribeLiveStreamRecordIndexFile | Queries the configuration of an index file. |
DescribeLiveStreamRecordIndexFiles | DescribeLiveStreamRecordIndexFiles | Queries the information about all M3U8 index files in a specific time period. |
AddLiveRecordNotifyConfig | AddLiveRecordNotifyConfig | Creates a recording callback configuration for a streaming domain. |
DeleteLiveRecordNotifyConfig | DeleteLiveRecordNotifyConfig | Deletes the recording callback configuration of a streaming domain. |
DescribeLiveRecordNotifyConfig | DescribeLiveRecordNotifyConfig | Queries the recording callback configurations of a streaming domain. |
UpdateLiveRecordNotifyConfig | UpdateLiveRecordNotifyConfig | Modifies the recording callback configuration of a streaming domain. |
Live snapshot
API | Title | Description |
---|---|---|
AddLiveAppSnapshotConfig | AddLiveAppSnapshotConfig | Configures snapshot settings for a streaming domain. |
DeleteSnapshotFiles | DeleteSnapshotFiles | Deletes snapshot files. |
DescribeLiveSnapshotConfig | DescribeLiveSnapshotConfig | Queries the snapshot configurations of a streaming domain. |
UpdateLiveAppSnapshotConfig | UpdateLiveAppSnapshotConfig | Modifies the snapshot configurations of a streaming domain. |
DescribeLiveStreamSnapshotInfo | DescribeLiveStreamSnapshotInfo | Queries the snapshots that are captured within a specified period. |
DescribeLiveSnapshotNotifyConfig | DescribeLiveSnapshotNotifyConfig | Queries the configuration of snapshot callbacks. |
DeleteLiveSnapshotNotifyConfig | DeleteLiveSnapshotNotifyConfig | Deletes the configuration of snapshot callbacks. |
AddLiveSnapshotNotifyConfig | AddLiveSnapshotNotifyConfig | Configures snapshot callbacks. |
UpdateLiveSnapshotNotifyConfig | UpdateLiveSnapshotNotifyConfig | Modifies the configuration of snapshot callbacks. |
SetSnapshotCallbackAuth | SetSnapshotCallbackAuth | Configures authentication for the callback for snapshots. |
QuerySnapshotCallbackAuth | QuerySnapshotCallbackAuth | Queries the authentication configuration for the callback for snapshots. |
Live stream encapsulation
API | Title | Description |
---|---|---|
AddLivePackageConfig | AddLivePackageConfig | Adds a live stream encapsulation configuration. |
UpdateLivePackageConfig | UpdateLivePackageConfig | Updates a live stream encapsulation configuration. |
DescribeLivePackageConfig | DescribeLivePackageConfig | |
DeleteLivePackageConfig | DeleteLivePackageConfig |
Live stream moderation
API | Title | Description |
---|---|---|
AddLiveSnapshotDetectPornConfig | AddLiveSnapshotDetectPornConfig | Adds a video moderation configuration for live streams in an application under a domain name. |
AddLiveDetectNotifyConfig | AddLiveDetectNotifyConfig | Configures callbacks for video moderation results. As a result, a callback URL that is used to receive the callback notifications is added. |
DescribeLiveSnapshotDetectPornConfig | DescribeLiveSnapshotDetectPornConfig | Queries video moderation configurations. |
DescribeLiveDetectNotifyConfig | DescribeLiveDetectNotifyConfig | Queries the configuration of callbacks for video moderation results. |
UpdateLiveSnapshotDetectPornConfig | UpdateLiveSnapshotDetectPornConfig | Modifies video moderation configurations. |
UpdateLiveDetectNotifyConfig | UpdateLiveDetectNotifyConfig | Modifies the configuration of callbacks for video moderation results. As a result, the callback URL that is used to receive the callback notifications is changed. |
DeleteLiveSnapshotDetectPornConfig | DeleteLiveSnapshotDetectPornConfig | Deletes a video moderation configuration. |
DeleteLiveDetectNotifyConfig | DeleteLiveDetectNotifyConfig | Deletes the configuration of callbacks for video moderation results. |
AddLiveAudioAuditConfig | AddLiveAudioAuditConfig | Adds an audio moderation configuration. |
AddLiveAudioAuditNotifyConfig | AddLiveAudioAuditNotifyConfig | Configures callbacks for audio moderation results. |
DeleteLiveAudioAuditConfig | DeleteLiveAudioAuditConfig | Deletes an audio moderation configuration. |
DeleteLiveAudioAuditNotifyConfig | DeleteLiveAudioAuditNotifyConfig | Deletes the configuration of callbacks for audio moderation results. |
UpdateLiveAudioAuditNotifyConfig | UpdateLiveAudioAuditNotifyConfig | Modifies the configuration of callbacks for audio moderation results. |
UpdateLiveAudioAuditConfig | UpdateLiveAudioAuditConfig | Modifies an audio moderation configuration. |
DescribeLiveAudioAuditConfig | DescribeLiveAudioAuditConfig | Queries audio moderation configurations. |
DescribeLiveAudioAuditNotifyConfig | DescribeLiveAudioAuditNotifyConfig | Queries the configuration of callbacks for audio moderation results. |
Global Accelerator
API | Title | Description |
---|---|---|
CreateLivePrivateLine | CreateLivePrivateLine | Creates a Global Accelerator (GA) instance and binds it to an acceleration circuit. |
DeleteLivePrivateLine | DeleteLivePrivateLine | Unbinds a Global Accelerator (GA) instance from an acceleration circuit. |
DescribeLivePrivateLineAreas | DescribeLivePrivateLineAreas | Queries available access points where acceleration circuits start. |
DescribeLivePrivateLineAvailGA | DescribeLivePrivateLineAvailGA | Queries the binding information between Global Accelerator (GA) instances and acceleration circuits. |
Live streaming latency
API | Title | Description |
---|---|---|
DescribeLiveStreamDelayConfig | DescribeLiveStreamDelayConfig | Queries the live streaming latency. |
SetLiveStreamDelayConfig | SetLiveStreamDelayConfig | Configures the live streaming latency. |
Resource monitoring
API | Title | Description |
---|---|---|
DescribeLiveDomainBpsData | DescribeLiveDomainBpsData | Queries the bandwidth data for one or more streaming domains. |
DescribeLiveDomainTrafficData | DescribeLiveDomainTrafficData | Queries the network traffic data for one or more domain names. |
DescribeLiveStreamTranscodeMetricData | DescribeLiveStreamTranscodeMetricData | Queries the transcoding data of a specified domain name at the application level and the stream level. |
DescribeLiveCenterStreamRateData | DescribeLiveCenterStreamRateData | Queries the audio and video frame rates and bitrates of a stream in a live center. |
DescribeLiveDomainBpsDataByLayer | DescribeLiveDomainBpsDataByLayer | Queries the bandwidth and traffic data by protocol for one or more domain names. |
DescribeLiveDomainPushBpsData | DescribeLiveDomainPushBpsData | Queries the bandwidth data for one or more ingest domains. |
DescribeLiveDomainPushTrafficData | DescribeLiveDomainPushTrafficData | Queries the network traffic data for one or more ingest domains. |
DescribeLiveStreamPushMetricDetailData | DescribeLiveStreamPushMetricDetailData | Queries the stream ingest data of a specified domain name at the application level and the stream level. |
DescribeLiveDomainPublishErrorCode | DescribeLiveDomainPublishErrorCode | Queries the HTTP status codes that are returned within a specified period of time under an ingest domain. |
DescribeLiveUpVideoAudioInfo | DescribeLiveUpVideoAudioInfo | Queries the audio and video data of an ingested stream within a specific period of time. |
DescribeLiveDomainRealTimeBpsData | DescribeLiveDomainRealTimeBpsData | Queries the bandwidth data that is collected every minute for one or more domain names. |
DescribeLiveDomainRealTimeTrafficData | DescribeLiveDomainRealTimeTrafficData | Queries the network traffic data that is collected in real time for one or more domain names. |
DescribeLiveDomainRealTimeHttpCodeData | DescribeLiveDomainRealTimeHttpCodeData | Queries the proportions of HTTP status codes returned for one or more domain names. Data is collected every minute. |
DescribeLiveStreamHistoryUserNum | DescribeLiveStreamHistoryUserNum | Queries the number of historical online users for a live stream. |
DescribeLiveStreamCount | DescribeLiveStreamCount | Queries the number of online original streams and transcoded streams among live streams. |
DescribeLiveStreamTranscodeStreamNum | DescribeLiveStreamTranscodeStreamNum | Call DescribeLiveStreamTranscodeStreamNum to query the number of trans-coded streams in real time. |
DescribeLiveDomainPvUvData | DescribeLiveDomainPvUvData | Queries the data of page views (PVs) and unique visitors (UVs) of a streaming domain. |
DescribeLiveTopDomainsByFlow | DescribeLiveTopDomainsByFlow | Queries the top domain names ranked by traffic. |
DescribeLiveStreamsTotalCount | DescribeLiveStreamsTotalCount | Queries the total number of live streams within a specified time range. Data is collected on a daily basis. |
DescribeLiveStreamMetricDetailData | DescribeLiveStreamMetricDetailData | Queries the monitoring data of streams for a specified domain name. Up to 5,000 rows of data can be returned per call. |
DescribeLiveStreamDetailFrameRateAndBitRateData | DescribeLiveStreamDetailFrameRateAndBitRateData | Queries the audio and video frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) stream. |
Statistics-Usage
API | Title | Description |
---|---|---|
DescribeLiveDomainRecordUsageData | DescribeLiveDomainRecordUsageData | Queries the numbers of live recording channels and container format conversions. |
DescribeLiveDomainSnapshotData | DescribeLiveDomainSnapshotData | Queries the number of snapshots for one or more streaming domains. |
DescribeLiveDetectPornData | DescribeLiveDetectPornData | Queries the usage data of content moderation. |
DescribeDomainUsageData | DescribeDomainUsageData | Queries the resource usage data of specific domain names in a specified billable region. |
DescribeLivePushProxyUsageData | DescribeLivePushProxyUsageData | Queries the usage data of live center stream relay. |
DescribeLiveRealtimeDeliveryAcc | DescribeLiveRealtimeDeliveryAcc | Queries the number of real-time log deliveries. |
DescribeLiveDomainTimeShiftData | DescribeLiveDomainTimeShiftData | Queries the resource usage data of time shifting for one or more domain names. |
DescribeLiveDomainStreamTranscodeData | DescribeLiveDomainStreamTranscodeData | Queries the transcoding length for one or more domain names. |
DescribeLiveProducerUsageData | DescribeLiveProducerUsageData | Queries the production studio usage data. |
DescribeLiveDomainMonitoringUsageData | DescribeLiveDomainMonitoringUsageData | Queries the live monitoring usage data for one or more domain names. |
DescribeLiveDelayedStreamingUsage | DescribeLiveDelayedStreamingUsage | Queries the stream delay usage data. |
DescribeLiveGrtnDuration | DescribeLiveGrtnDuration | Queries the co-streaming usage data. |
DescribeMeterLiveBypassDuration | DescribeMeterLiveBypassDuration | DescribeMeterLiveBypassDuration |
DescribeLiveDrmUsageData | DescribeLiveDrmUsageData |
Production studio
API | Title | Description |
---|---|---|
Manage production studios | Manage production studios | |
CreateCaster | CreateCaster | Creates a production studio. |
SetCasterConfig | SetCasterConfig | Configures all parameters for a production studio. If a parameter is not specified, the production studio does not have the relevant configuration. |
DescribeCasterConfig | DescribeCasterConfig | Queries the configurations of a production studio. |
DescribeCasters | DescribeCasters | Queries the list of production studios. |
DescribeCasterStreamUrl | DescribeCasterStreamUrl | Queries the streaming URLs of a production studio. |
CopyCaster | CopyCaster | Duplicates a production studio. |
StartCaster | StartCaster | Starts a production studio. |
StopCaster | StopCaster | Stops a production studio. This stops the PVW and PGM scenes of the production studio. |
DeleteCaster | DeleteCaster | Deletes a production studio. |
RestartCaster | RestartCaster | Restarts a production studio. |
Manage input sources | Manage input sources | |
AddCasterVideoResource | AddCasterVideoResource | Adds an input source to a production studio. The number of input sources is limited by the number of input channels of the production studio. |
DeleteCasterVideoResource | DeleteCasterVideoResource | Removes an input source from a production studio. |
ModifyCasterVideoResource | ModifyCasterVideoResource | Changes the video source for a production studio. |
DescribeCasterVideoResources | DescribeCasterVideoResources | Queries the video resources of a production studio. |
Manage layouts | Manage layouts | |
AddCasterLayout | AddCasterLayout | Adds a layout for a production studio. |
DeleteCasterLayout | DeleteCasterLayout | Deletes a layout in a production studio. |
ModifyCasterLayout | ModifyCasterLayout | Modifies the layout configurations pf a production studio. You need to pass only parameters that you want to modify. |
DescribeCasterLayouts | DescribeCasterLayouts | Queries a specific layout or all layouts of a production studio. |
Manage components | Manage components | |
AddCasterComponent | AddCasterComponent | Adds a component to a production studio. |
DeleteCasterComponent | DeleteCasterComponent | Deletes a component from a production studio. |
ModifyCasterComponent | ModifyCasterComponent | Modifies a component of a production studio. |
DescribeCasterComponents | DescribeCasterComponents | Queries the components of a production studio. |
Manage scenes | Manage scenes | |
CopyCasterSceneConfig | CopyCasterSceneConfig | Applies the configuration of a PVW scene to a PGM scene. |
DeleteCasterSceneConfig | DeleteCasterSceneConfig | Deletes the settings of a scene. |
UpdateCasterSceneConfig | UpdateCasterSceneConfig | Modifies a scene, including the layout, without invalidating the previous configurations. |
SetCasterSceneConfig | SetCasterSceneConfig | Configures all settings of a scene. This is done by clearing all previous settings of the scene and applying new settings, including the layout setting, to the scene. |
DescribeCasterScenes | DescribeCasterScenes | Queries the scenes of a production studio. |
UpdateCasterSceneAudio | UpdateCasterSceneAudio | Modifies the audio configurations of a scene. |
DescribeCasterSceneAudio | DescribeCasterSceneAudio | Queries the audio configurations of a scene. |
StartCasterScene | StartCasterScene | Starts a specified preview scene. |
StopCasterScene | StopCasterScene | Stops a specified preview scene. |
Manage channels | Manage channels | |
SetCasterChannel | SetCasterChannel | Configures a channel of a production studio. |
DescribeCasterChannels | DescribeCasterChannels | Queries the channels of a production studio. |
Manage the standby video | Manage the standby video | |
EffectCasterUrgent | EffectCasterUrgent | Switches a program (PGM) scene to the standby resource in a production studio. |
EffectCasterVideoResource | EffectCasterVideoResource | Updates the standby video resource in a specified scene. |
Production studio in playlist mode (new) | Production studio in playlist mode (new) | |
AddShowIntoShowList | AddShowIntoShowList | Adds an episode to an episode list. |
RemoveShowFromShowList | RemoveShowFromShowList | Removes a specified episode from an episode list. |
ModifyShowList | ModifyShowList | Modifies the attributes of an episode list. |
DescribeShowList | DescribeShowList | Queries the details of an episode list. |
PlayChoosenShow | PlayChoosenShow | Switches to a specified episode. |
InitializeAutoShowListTask | InitializeAutoShowListTask | Creates a scheduled task to start and stop the playback of a playlist at the specified points in time. |
DescribeAutoShowListTasks | DescribeAutoShowListTasks | Queries the scheduled tasks that are used to start and stop playlists at the specified points in time. |
EditShowAndReplace | EditShowAndReplace | Creates an editing task. |
GetEditingJobInfo | GetEditingJobInfo | Queries the information about one or more editing tasks. |
SetShowListBackground | SetShowListBackground | Configures the background of the episode list. |
Virtual studio | Virtual studio | |
AddStudioLayout | AddStudioLayout | Configures a layout for a virtual studio. |
DeleteStudioLayout | DeleteStudioLayout | Deletes a layout in a virtual studio. |
ModifyStudioLayout | ModifyStudioLayout | Modifies a layout of a virtual studio. |
DescribeStudioLayouts | DescribeStudioLayouts | Queries one or more layouts of a virtual studio. |
Production studio in playlist mode (old) | Production studio in playlist mode (old) | |
AddCasterEpisode | AddCasterEpisode | Adds an episode to a production studio. |
DeleteCasterEpisode | DeleteCasterEpisode | Deletes an episode in a production studio. |
ModifyCasterEpisode | ModifyCasterEpisode | Modifies the configurations of an episode in a production studio. You cannot change the episode type. |
AddCasterEpisodeGroup | AddCasterEpisodeGroup | Creates an episode list in a production studio. |
DeleteCasterEpisodeGroup | DeleteCasterEpisodeGroup | Deletes an episode list in a production studio. |
AddCasterEpisodeGroupContent | AddCasterEpisodeGroupContent | Adds information about an episode list in a production studio. |
AddCasterProgram | AddCasterProgram | Adds an episode list to a production studio. |
DescribeCasterProgram | DescribeCasterProgram | Queries the information about an episode list in a production studio. |
ModifyCasterProgram | ModifyCasterProgram | Modifies an episode list of a production studio. |
DeleteCasterProgram | DeleteCasterProgram | Deletes the episode list for carousel playback in a production studio. |
AddPlaylistItems | AddPlaylistItems | Adds episodes to an episode list. |
DeletePlaylistItems | DeletePlaylistItems | Removes episodes from an episode list. |
ListPlaylistItems | ListPlaylistItems | Queries the information about episodes in an episode list. |
EditPlaylist | EditPlaylist | Updates episodes in an episode list. |
DeletePlaylist | DeletePlaylist | Deletes an episode list. |
ListPlaylist | ListPlaylist | Queries the information about one or more episode lists. |
StartPlaylist | StartPlaylist | Starts playing an episode list. |
StopPlaylist | StopPlaylist | Stops playback for an episode list. |
Live stream watermarks
API | Title | Description |
---|---|---|
AddLiveStreamWatermark | AddLiveStreamWatermark | Creates a watermark template. |
DeleteLiveStreamWatermark | DeleteLiveStreamWatermark | Deletes a specified watermark template. |
UpdateLiveStreamWatermark | UpdateLiveStreamWatermark | Updates a watermark template. |
DynamicUpdateWaterMarkStreamRule | DynamicUpdateWaterMarkStreamRule | Dynamically updates a watermark. |
DescribeLiveStreamWatermarks | DescribeLiveStreamWatermarks | Queries watermark templates. |
AddLiveStreamWatermarkRule | AddLiveStreamWatermarkRule | Adds a watermark rule. |
DeleteLiveStreamWatermarkRule | DeleteLiveStreamWatermarkRule | Deletes a watermark rule. |
UpdateLiveStreamWatermarkRule | UpdateLiveStreamWatermarkRule | Updates a watermark rule. |
DescribeLiveStreamWatermarkRules | DescribeLiveStreamWatermarkRules | Queries watermark rules. |
Edge transcoding
API | Title | Description |
---|---|---|
ListEdgeTranscodeTemplate | ListEdgeTranscodeTemplate | Queries a list of edge transcoding templates. |
GetEdgeTranscodeTemplate | GetEdgeTranscodeTemplate | Queries the details of an edge transcoding template. |
CreateEdgeTranscodeJob | CreateEdgeTranscodeJob | Creates an edge transcoding task. |
DeleteEdgeTranscodeJob | DeleteEdgeTranscodeJob | Deletes an edge transcoding task. |
ListEdgeTranscodeJob | ListEdgeTranscodeJob | Queries a list of edge transcoding tasks. |
GetEdgeTranscodeJob | GetEdgeTranscodeJob | Queries the details of an edge transcoding task. |
UpdateEdgeTranscodeJob | UpdateEdgeTranscodeJob | |
StartEdgeTranscodeJob | StartEdgeTranscodeJob | Starts an edge transcoding task. |
StopEdgeTranscodeJob | StopEdgeTranscodeJob | Stops an edge transcoding task. |
Live monitoring
API | Title | Description |
---|---|---|
CreateLiveStreamMonitor | CreateLiveStreamMonitor | Creates a monitoring session. |
UpdateLiveStreamMonitor | UpdateLiveStreamMonitor | Updates the configurations of a monitoring session. |
DescribeLiveStreamMonitorList | DescribeLiveStreamMonitorList | Queries the list of created monitoring sessions. |
StartLiveStreamMonitor | StartLiveStreamMonitor | Starts live monitoring. |
StopLiveStreamMonitor | StopLiveStreamMonitor | Stops live monitoring. |
DeleteLiveStreamMonitor | DeleteLiveStreamMonitor | Deletes a monitoring session. |
Interactive messaging (new)
API | Title | Description |
---|---|---|
CreateLiveMessageApp | CreateLiveMessageApp | Creates an interactive messaging application. |
CreateLiveMessageGroup | CreateLiveMessageGroup | Creates an interactive messaging group. |
DescribeLiveMessageGroup | DescribeLiveMessageGroup | Queries the information about an interactive messaging group. |
ModifyLiveMessageGroup | ModifyLiveMessageGroup | Modifies the information about an interactive messaging group. |
DeleteLiveMessageGroup | DeleteLiveMessageGroup | Deletes an interactive messaging group. |
ListLiveMessageGroups | ListLiveMessageGroups | Queries the interactive messaging groups in an interactive messaging application. |
ListLiveMessageGroupByPage | ListLiveMessageGroupByPage | Queries interactive messaging groups by page. |
ModifyLiveMessageGroupBand | ModifyLiveMessageGroupBand | Modifies the mute status of users. |
DescribeLiveMessageGroupBand | DescribeLiveMessageGroupBand | Queries the mute status of users. |
CheckLiveMessageUsersOnline | CheckLiveMessageUsersOnline | Queries whether one or more specified users are online. |
CheckLiveMessageUsersInGroup | CheckLiveMessageUsersInGroup | Queries whether a user is in an interactive messaging group. |
ListLiveMessageGroupUsers | ListLiveMessageGroupUsers | Queries the users in an interactive messaging group. |
ListLiveMessageGroupMessages | ListLiveMessageGroupMessages | Queries the messages sent in a group. |
UnbanLiveMessageGroup | UnbanLiveMessageGroup | Unmutes a group. |
RecoverLiveMessageDeletedGroup | RecoverLiveMessageDeletedGroup | Restores a deleted interactive messaging group. |
BanLiveMessageGroup | BanLiveMessageGroup | Mutes a group. |
AddLiveMessageGroupBand | AddLiveMessageGroupBand | Mutes one or more users. |
RemoveLiveMessageGroupBand | RemoveLiveMessageGroupBand | Unmutes one or more users. |
DeleteLiveMessageGroupMessage | DeleteLiveMessageGroupMessage | Deletes a message that was sent to an interactive messaging group. |
DeleteLiveMessageUserMessage | DeleteLiveMessageUserMessage | Deletes a message that is sent to a user. |
SendLiveMessageGroup | SendLiveMessageGroup | Sends a message to a group. |
SendLiveMessageUser | SendLiveMessageUser | Sends a message to a user. |
ListLiveMessageApps | ListLiveMessageApps | Queries interactive messaging applications. |
DescribeLiveMessageApp | DescribeLiveMessageApp | Query Interactive Message App |
ModifyLiveMessageAppDisable | ModifyLiveMessageAppDisable | |
ModifyLiveMessageAppAudit | ModifyLiveMessageAppAudit | Modifies the content moderation settings of an interactive streaming application. |
ModifyLiveMessageAppCallback | ModifyLiveMessageAppCallback | |
KickLiveMessageGroupUser | KickLiveMessageGroupUser | Removes a user from an interactive messaging group. |
ModifyLiveMessageUserInfo | ModifyLiveMessageUserInfo | Modifies the information about a user. |
ApsaraVideo Real-time Communication
API | Title | Description |
---|---|---|
Channel management | Channel management | |
DescribeChannelParticipants | DescribeChannelParticipants | Queries online users in a channel. |
DescribeChannelUsers | DescribeChannelUsers | Queries the details of online users in a channel. |
RemoveTerminals | RemoveTerminals | Removes users from a channel. |
CreateRoomRealTimeStreamAddress | CreateRoomRealTimeStreamAddress | Creates a Real-Time Messaging Protocol (RTMP) ingest URL for a channel. |
DeleteChannel | DeleteChannel | Deletes a channel. |
Stream relay | Stream relay | |
StartLiveMPUTask | StartLiveMPUTask | Creates a mixed-stream relay task. |
UpdateLiveMPUTask | UpdateLiveMPUTask | Updates a mixed-stream relay task. |
StopLiveMPUTask | StopLiveMPUTask | Stops a mixed-stream relay task. |
ListRtcMPUTaskDetail | ListRtcMPUTaskDetail | Queries the parameters of mixed-stream relay tasks. |
SetLiveMpuTaskSei | SetLiveMpuTaskSei | Configures the custom supplemental enhancement information (SEI) for co-streaming. |
Event callbacks | Event callbacks | |
CreateEventSub | CreateEventSub | Creates a callback to subscribe to channel or user events. |
ListEventSub | ListEventSub | Queries the events generated in channels to which you subscribe. |
ListEventSubEvent | ListEventSubEvent | Queries callback records. |
UpdateEventSub | UpdateEventSub | Updates a callback that is used to subscribe to channel or user events. |
DeleteEventSub | DeleteEventSub | Deletes a callback that is used to subscribe to channel or user events. |
CreateRtcMPUEventSub | CreateRtcMPUEventSub | Creates a subscription to mixed-stream relay events. |
UpdateRtcMPUEventSub | UpdateRtcMPUEventSub | Updates a subscription to mixed-stream relay events. |
DeleteRtcMPUEventSub | DeleteRtcMPUEventSub | Deletes a subscription to mixed-stream relay events. |
DescribeRtcMPUEventSub | DescribeRtcMPUEventSub | Queries information about a subscription to mixed-stream relay events. |
ListRtcMPUEventSubRecord | ListRtcMPUEventSubRecord | Queries subscriptions to mixed-stream relay events. |
Quality monitoring | Quality monitoring | |
DescribeLiveInteractionMetricData | DescribeLiveInteractionMetricData | Queries the metric data of ApsaraVideo Real-time Communication (ARTC). |
Live subtitles (in public preview)
API | Title | Description |
---|---|---|
DeleteLiveAIProduceRules | DeleteLiveAIProduceRules | Deletes a subtitle rule. |
DescribeLiveAIProduceRules | DescribeLiveAIProduceRules | Queries subtitle rules. |
UpdateLiveAIProduceRules | UpdateLiveAIProduceRules | Updates a subtitle rule. |
AddLiveAIProduceRules | AddLiveAIProduceRules | Adds a subtitle rule. |
DeleteLiveAISubtitle | DeleteLiveAISubtitle | Deletes a specified subtitle template. |
DescribeLiveAISubtitle | DescribeLiveAISubtitle | Queries subtitle templates. |
UpdateLiveAISubtitle | UpdateLiveAISubtitle | Updates a subtitle template. |
AddLiveAISubtitle | AddLiveAISubtitle | Adds a subtitle template. |
Tools
API | Title | Description |
---|---|---|
DescribeLiveIpInfo | DescribeLiveIpInfo | Checks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP). |
DescribeLiveStreamAuthChecking | DescribeLiveStreamAuthChecking | Queries the authentication status of an active stream. |