edit-icon download-icon

UpdateLiveAppSnapshotConfig

Last Updated: Apr 11, 2018

Description

Update the snapshot configuration in the live stream. The output content is stored in OSS. The configuration is effective when the stream is pushed again.

Request parameters

Parameters Type Required or not Example values Description
Action String Yes UpdateLiveAppSnapshotConfig

The name of this interface. Value: UpdateLiveAppSnapshotConfig

AppName String Yes test123

Name of the app, which the live stream belongs to.
The * symbol is supported, indicating all the AppNames under the domain name.

DomainName String Yes test.com

Your CDN domain name.

OssBucket String No test123

Name of the bucket in OSS.

OssEndpoint String No oss-cn-shanghai.aliyuncs.com

OSS endpoint domain name.

OverwriteOssObject String No {AppName}/{StreamName}.jpg

The storage file name in OSS. This file is overwritten at every snapshot.

  • Smaller than 256 bytes.
  • Currently only supports generating JPG images.
  • Supports variable matching, including {AppName} and {StreamName}. For example: {AppName}/{StreamName}.jpg.
  • If - is passed in, it indicates deleting this field.

SequenceOssObject String No snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

The storage file name in OSS. This file adopts incremental storage for every snapshot. You can query the files within a period of time using the DescribeLiveStreamSnapshotInfo interface.

  • Smaller than 256 bytes.
  • Currently nly supports generating JPG images.
  • Supports variable matching, including {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. Among them, you must provide one of {UnixTimestamp} and {Sequence}. For example: snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg.
  • If - is passed in, it indicates deleting this field.

TimeInterval Integer No 5

Snapshot cycle.

  • Range: [5,3600]
  • Unit: seconds.

Return parameters

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

The ID of the job request

Example

Request example

  1. /?AppName=test123&DomainName=test.com
  2. &AccessKeyId=XxlctR6mMqO6mhXxX&Action=UpdateLiveAppSnapshotConfig
  3. &OssBucket=test123&OssEndpoint=oss-cn-shanghai.aliyuncs.com&OverwriteOssObject={AppName}/{StreamName}.jpg&SequenceOssObject=snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg&TimeInterval=5&<Public Request Parameter>

Normal return example

JSON format

  1. {
  2. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
  3. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.