All Products
Search

This Product

    ApsaraVideo Live:Configure snapshots

    Document Center

    ApsaraVideo Live:Configure snapshots

    Last Updated:Nov 06, 2024

    The snapshot feature of ApsaraVideo Live allows you to capture snapshots of live streams based on a specified snapshot interval and store the snapshots in the JPG format in a specified Object Storage Service (OSS) bucket. This topic describes how to configure video snapshots.

    Prerequisites

    OSS is activated, and a specific bucket is created. This way, ApsaraVideo Live can store live stream snapshots in the bucket. For more information, see Activate OSS and Create a bucket.

    Important

    The bucket must reside in the same region as the live center of the streaming domain. Cross-region snapshot capture is not supported.

    Procedure

    1. Log on to the ApsaraVideo Live console.

    2. In the left-side navigation pane, choose Feature Management > Snapshots. On the Snapshots page, click the Snapshot Settings tab.

    3. Select the streaming domain that you want to configure.

    4. Click Add.

    5. Configure the snapshot template.

      image

      The following table describes the parameters of a snapshot template.

      Parameter

      Description

      AppName

      The name of the application. The value of the AppName parameter must be the same as the application name specified in the ingest URL. Otherwise, the configuration does not take effect. If you want to configure snapshot settings for all applications under the domain name, enter an asterisk (*).

      Snapshot Interval

      The interval between two consecutive snapshots. Unit: seconds. Valid values: 5 to 3600.

      Storage Location

      The storage location of snapshots in OSS.

      The OSS bucket must reside in the same region as the live center of the streaming domain. Cross-region snapshot capture is not supported.

      Storage Mode

      Two storage modes are available. You can select them at the same time.

      • Overwrite: Video snapshots are captured in sequence based on the snapshot interval. A newly captured snapshot overwrites the previous one.

      • New: Video snapshots are captured in sequence based on the snapshot interval. New snapshots with a sequence number of N + 1 (N ≥ 0) are stored in OSS in sequence.

      Note

      If you select the two modes at the same time, snapshots are captured in both modes.

      Note

      After the configuration is complete, all the specified applications under the domain name capture and store snapshots based on the configured template.

      If you modify the snapshot settings, the modification takes effect only for newly ingested streams.

    6. Click OK.

    References

    For more information about the snapshot feature, see Live stream snapshots.