Template Parameter Description

Last updated: 2020-02-24 15:08:38

    When creating a parameter template, you need to set the parameters, including bitrate, video width and height, remuxing format, and codec. This document describe the key parameters for each template and their value ranges.

    Audio/Video Transcoding Template

    Category Parameter Description
    Muxing
    Container format The following video and audio container formats are supported:
  • Video: MP4, TS, HLS, and FLV
  • Audio: MP3, M4A, FLAC, and OGG
  • Video stream deletion If this parameter is enabled, the output video after transcoding will contain only the audio stream with the video stream discarded
    Audio stream deletion If this parameter is enabled, the output video after transcoding will contain only the video stream with the audio stream discarded
    Video encoding Codec H.264 and H.265 are supported
    Bitrate Supported bitrate range: 10–35 Mbps
    Frame rate Supported frame rate range: 1–60 fps; common values: 24, 25, and 30 fps
    Resolution
  • Supported width range: 128–4,096 px
  • Supported height range: 128–4,096 px
  • GOP length Supported GOP length range: 1–10s
    Profile
  • When the video codec is H.264, the `Baseline`, `Main`, and `High` profiles are supported
  • When the video codec is H.265, only the `Main` profile is supported
  • Color space YUV420P is supported
    Audio encoding parameters Codec MP3, AAC, AC3, and FLAC are supported
    Sample rate The following audio sample rates are supported:
  • 34,000 Hz
  • 44,100 Hz
  • 48,000 Hz
  • Bitrate Supported bitrate range: 26–256 Kbps, including the following values:
  • 48 Kbps
  • 64 Kbps
  • 128 Kbps
  • Channel
  • Mono
  • Dual
  • Stereo
  • Watermark Template

    Parameter Description
    Type Image and text watermarks are supported:
  • Image watermark: Static or animated images are supported
  • Text watermark: Texts in various languages are supported
  • Position Relative position of a watermark in the video
    Image Dimension Size of an image watermark in the video
    Image Content Binary content of an image watermark
    Font Size Font size of a text watermark
    Font Type Font of a text watermark, e.g., Times New Roman
    Font Color Color of a text watermark, e.g., 0xRRGGBB
    Font Alpha Transparency of text watermark. Value range: 0–100%

    Screenshot Template

    Time point screenshot template

    A time point screenshot template is used to take a screenshot at a specified time point or to generate a thumbnail cover.

    Parameter Description
    Format Output format of a screenshot file. Currently, only JPG is supported
    Width Screenshot width. Value range: 128–4,096 px
    Height Screenshot height. Value range: 128–4,096 px
    Fill Type Filling refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. Generally, the following filling types are supported:
  • Stretch: The screenshot is stretched to match the aspect ratio of the source video, which may distort the image.
  • Fill in black: This option retains the aspect ratio of the source video for the screenshot and the unmatched area is filled in black.
  • Fill in white: This option retains the aspect ratio of the source video for the screenshot and the unmatched area is filled in white.
  • Gaussian blur: This option retains the aspect ratio of the source video for the screenshot and Gaussian blur is applied to the unmatched area.
  • Sampled screenshot template

    A sampled screenshot template is used to take sampled screenshots.

    Parameter Description
    Format Output format of a screenshot file. Currently, only JPG is supported
    Width Screenshot width. Value range: 128–4,096 px
    Height Screenshot height. Value range: 128–4,096 px
    Sample Type The following two types are supported:
  • Sample by percent: If this is selected and Interval is set to 5% for example, 20 screenshots will be generated
  • Sample by time: If this is selected and Interval is set to 10s for example, the number of generated screenshots will depend on the video length
  • Interval Sampling interval.
  • If the sampling type is by percent, this parameter will be a percent value
  • If the sampling type is by time, this parameter will be in seconds
  • Fill Type Filling refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. Generally, the following filling types are supported:
  • Stretch: The screenshot is stretched to match the aspect ratio of the source video, which may distort the image.
  • Fill in black: This option retains the aspect ratio of the source video for the screenshot and the unmatched area is filled in black.
  • Fill in white: This option retains the aspect ratio of the source video for the screenshot and the unmatched area is filled in white.
  • Gaussian blur: This option retains the aspect ratio of the source video for the screenshot and Gaussian blur is applied to the unmatched area.
  • Image sprite screenshot template

    An image sprite screenshot template is used to take screenshots and combine them to generate an image sprite.

    Parameter Description
    Format Output format of an image sprite file. Currently, only JPG is supported
    Width Sub-image width
    Height Sub-image height
    Rows Number sub-image rows in an image sprite
    Columns Number sub-image columns in an image sprite
    Sample Type Sub-image sampling method. Currently, only sampling by time is supported
    Interval Time interval for capturing sub-images
    • The value of Width * Columns should be between 128 and 4,096 px (i.e., the range of the image sprite width).
    • The value of Height * Rows should be between 128 and 4,096 px (i.e., the range of the image sprite height).

    Animated Image Generating Template

    The target specification of an animated image is subject to parameters such as animated image format, width, height, and frame rate.

    Parameter Description
    Format Output format of an animated image file. Currently, only GIF and WEBP are supported
    Width Animated image width. Value range: 128–4,096 px
    Height Animated image height. Value range: 128–4,096 px
    FPS Supported frame rate range: 1–60 fps

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help