AddLiveAppSnapshotConfig

Description

Configure snapshot information targeting the AppName in the live stream. The output content is stored in OSS. The configuration is effective when the stream is pushed again.

Request parameters

Parameter

Type

Required

Example values

Description

Action

String

Yes

AddLiveAppSnapshotConfig

The name of this interface. Value: AddLiveAppSnapshotConfig

AppName

String

Yes

testApp

Name of the app , which the live stream belongs to. Supports wildcard (*), indicating all the AppNames under the domain name.

DomainName

String

Yes

www.yourdomain.com

Your CDN domain name.

OssBucket

String

Yes

test123

Name of the bucket stored in OSS.

OssEndpoint

String

Yes

oss-cn-shanghai.aliyuncs.com

OSS endpoint domain name.

TimeInterval

Integer

Yes

5

Snapshot cycle. Range: [5,3600]Unit: seconds.

OverwriteOssObject

String

No

{AppName}/{StreamName}.jpg

The storage file name in OSS. After every snapshot you take, the file is overwritten.

Smaller than 256 bytes.

Currently only supports generating JPG images.

Supports variable matching, including {AppName} and {StreamName}. For example: {AppName}/{StreamName}.jpg.

SequenceOssObject

String

No

snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

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

Smaller than 256 bytes.

Currently only supports generating JPG images.

Supports variable matching, including {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. Among them, you must provide either {UnixTimestamp} or {Sequence}. For example: snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg.