Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. VodImageSpriteTemplate
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.VodImageSpriteTemplate

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provide a resource to create a VOD image sprite template.

    Create VodImageSpriteTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VodImageSpriteTemplate(name: string, args: VodImageSpriteTemplateArgs, opts?: CustomResourceOptions);
    @overload
def VodImageSpriteTemplate(resource_name: str,
                           args: VodImageSpriteTemplateArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def VodImageSpriteTemplate(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           row_count: Optional[float] = None,
                           sample_type: Optional[str] = None,
                           sample_interval: Optional[float] = None,
                           column_count: Optional[float] = None,
                           format: Optional[str] = None,
                           name: Optional[str] = None,
                           resolution_adaptive: Optional[bool] = None,
                           height: Optional[float] = None,
                           fill_type: Optional[str] = None,
                           comment: Optional[str] = None,
                           sub_app_id: Optional[float] = None,
                           vod_image_sprite_template_id: Optional[str] = None,
                           width: Optional[float] = None)
    func NewVodImageSpriteTemplate(ctx *Context, name string, args VodImageSpriteTemplateArgs, opts ...ResourceOption) (*VodImageSpriteTemplate, error)
    public VodImageSpriteTemplate(string name, VodImageSpriteTemplateArgs args, CustomResourceOptions? opts = null)
    public VodImageSpriteTemplate(String name, VodImageSpriteTemplateArgs args)
public VodImageSpriteTemplate(String name, VodImageSpriteTemplateArgs args, CustomResourceOptions options)

    type: tencentcloud:VodImageSpriteTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VodImageSpriteTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VodImageSpriteTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VodImageSpriteTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VodImageSpriteTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VodImageSpriteTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VodImageSpriteTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VodImageSpriteTemplate resource accepts the following input properties:

    ColumnCount double
    Subimage column count of an image sprite.
    RowCount double
    Subimage row count of an image sprite.
    SampleInterval double
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    SampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    Comment string
    Template description. Length limit: 256 characters.
    FillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    Format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    Height double
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    Name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    ResolutionAdaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    SubAppId double
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    VodImageSpriteTemplateId string
    ID of the resource.
    Width double
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    ColumnCount float64
    Subimage column count of an image sprite.
    RowCount float64
    Subimage row count of an image sprite.
    SampleInterval float64
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    SampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    Comment string
    Template description. Length limit: 256 characters.
    FillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    Format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    Height float64
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    Name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    ResolutionAdaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    SubAppId float64
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    VodImageSpriteTemplateId string
    ID of the resource.
    Width float64
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount Double
    Subimage column count of an image sprite.
    rowCount Double
    Subimage row count of an image sprite.
    sampleInterval Double
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType String
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    comment String
    Template description. Length limit: 256 characters.
    fillType String
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format String
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height Double
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name String
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive Boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    subAppId Double
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    vodImageSpriteTemplateId String
    ID of the resource.
    width Double
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount number
    Subimage column count of an image sprite.
    rowCount number
    Subimage row count of an image sprite.
    sampleInterval number
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    comment string
    Template description. Length limit: 256 characters.
    fillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height number
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    subAppId number
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    vodImageSpriteTemplateId string
    ID of the resource.
    width number
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    column_count float
    Subimage column count of an image sprite.
    row_count float
    Subimage row count of an image sprite.
    sample_interval float
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sample_type str
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    comment str
    Template description. Length limit: 256 characters.
    fill_type str
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format str
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height float
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name str
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolution_adaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    sub_app_id float
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    vod_image_sprite_template_id str
    ID of the resource.
    width float
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount Number
    Subimage column count of an image sprite.
    rowCount Number
    Subimage row count of an image sprite.
    sampleInterval Number
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType String
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    comment String
    Template description. Length limit: 256 characters.
    fillType String
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format String
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height Number
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name String
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive Boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    subAppId Number
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    vodImageSpriteTemplateId String
    ID of the resource.
    width Number
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VodImageSpriteTemplate resource produces the following output properties:

    CreateTime string
    Creation time of template in ISO date format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    UpdateTime string
    Last modified time of template in ISO date format.
    CreateTime string
    Creation time of template in ISO date format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    UpdateTime string
    Last modified time of template in ISO date format.
    createTime String
    Creation time of template in ISO date format.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime String
    Last modified time of template in ISO date format.
    createTime string
    Creation time of template in ISO date format.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime string
    Last modified time of template in ISO date format.
    create_time str
    Creation time of template in ISO date format.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    update_time str
    Last modified time of template in ISO date format.
    createTime String
    Creation time of template in ISO date format.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime String
    Last modified time of template in ISO date format.

    Look up Existing VodImageSpriteTemplate Resource

    Get an existing VodImageSpriteTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VodImageSpriteTemplateState, opts?: CustomResourceOptions): VodImageSpriteTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        column_count: Optional[float] = None,
        comment: Optional[str] = None,
        create_time: Optional[str] = None,
        fill_type: Optional[str] = None,
        format: Optional[str] = None,
        height: Optional[float] = None,
        name: Optional[str] = None,
        resolution_adaptive: Optional[bool] = None,
        row_count: Optional[float] = None,
        sample_interval: Optional[float] = None,
        sample_type: Optional[str] = None,
        sub_app_id: Optional[float] = None,
        type: Optional[str] = None,
        update_time: Optional[str] = None,
        vod_image_sprite_template_id: Optional[str] = None,
        width: Optional[float] = None) -> VodImageSpriteTemplate
    func GetVodImageSpriteTemplate(ctx *Context, name string, id IDInput, state *VodImageSpriteTemplateState, opts ...ResourceOption) (*VodImageSpriteTemplate, error)
    public static VodImageSpriteTemplate Get(string name, Input<string> id, VodImageSpriteTemplateState? state, CustomResourceOptions? opts = null)
    public static VodImageSpriteTemplate get(String name, Output<String> id, VodImageSpriteTemplateState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:VodImageSpriteTemplate    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ColumnCount double
    Subimage column count of an image sprite.
    Comment string
    Template description. Length limit: 256 characters.
    CreateTime string
    Creation time of template in ISO date format.
    FillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    Format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    Height double
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    Name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    ResolutionAdaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    RowCount double
    Subimage row count of an image sprite.
    SampleInterval double
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    SampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    SubAppId double
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    UpdateTime string
    Last modified time of template in ISO date format.
    VodImageSpriteTemplateId string
    ID of the resource.
    Width double
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    ColumnCount float64
    Subimage column count of an image sprite.
    Comment string
    Template description. Length limit: 256 characters.
    CreateTime string
    Creation time of template in ISO date format.
    FillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    Format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    Height float64
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    Name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    ResolutionAdaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    RowCount float64
    Subimage row count of an image sprite.
    SampleInterval float64
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    SampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    SubAppId float64
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    UpdateTime string
    Last modified time of template in ISO date format.
    VodImageSpriteTemplateId string
    ID of the resource.
    Width float64
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount Double
    Subimage column count of an image sprite.
    comment String
    Template description. Length limit: 256 characters.
    createTime String
    Creation time of template in ISO date format.
    fillType String
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format String
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height Double
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name String
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive Boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    rowCount Double
    Subimage row count of an image sprite.
    sampleInterval Double
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType String
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    subAppId Double
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    type String
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime String
    Last modified time of template in ISO date format.
    vodImageSpriteTemplateId String
    ID of the resource.
    width Double
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount number
    Subimage column count of an image sprite.
    comment string
    Template description. Length limit: 256 characters.
    createTime string
    Creation time of template in ISO date format.
    fillType string
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format string
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height number
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name string
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    rowCount number
    Subimage row count of an image sprite.
    sampleInterval number
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType string
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    subAppId number
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    type string
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime string
    Last modified time of template in ISO date format.
    vodImageSpriteTemplateId string
    ID of the resource.
    width number
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    column_count float
    Subimage column count of an image sprite.
    comment str
    Template description. Length limit: 256 characters.
    create_time str
    Creation time of template in ISO date format.
    fill_type str
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format str
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height float
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name str
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolution_adaptive bool
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    row_count float
    Subimage row count of an image sprite.
    sample_interval float
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sample_type str
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    sub_app_id float
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    type str
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    update_time str
    Last modified time of template in ISO date format.
    vod_image_sprite_template_id str
    ID of the resource.
    width float
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    columnCount Number
    Subimage column count of an image sprite.
    comment String
    Template description. Length limit: 256 characters.
    createTime String
    Creation time of template in ISO date format.
    fillType String
    Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black.
    format String
    Image format, Valid values:

    • jpg: jpg format;
    • png: png format;
    • webp: webp format; Default value: jpg.
    height Number
    Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.
    name String
    Name of a time point screen capturing template. Length limit: 64 characters.
    resolutionAdaptive Boolean
    Resolution adaption. Valid values: true,false. true: enabled. In this case, width represents the long side of a video, while height the short side; false: disabled. In this case, width represents the width of a video, while height the height. Default value: true.
    rowCount Number
    Subimage row count of an image sprite.
    sampleInterval Number
    Sampling interval. If sample_type is Percent, sampling will be performed at an interval of the specified percentage. If sample_type is Time, sampling will be performed at the specified time interval in seconds.
    sampleType String
    Sampling type. Valid values: Percent, Time. Percent: by percent. Time: by time interval.
    subAppId Number
    The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    type String
    Template type, value range:

    • Preset: system preset template;
    • Custom: user-defined templates.
    updateTime String
    Last modified time of template in ISO date format.
    vodImageSpriteTemplateId String
    ID of the resource.
    width Number
    Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both width and height are 0, the resolution will be the same as that of the source video; If width is 0, but height is not 0, width will be proportionally scaled; If width is not 0, but height is 0, height will be proportionally scaled; If both width and height are not 0, the custom resolution will be used. Default value: 0.

    Import

    VOD image sprite template can be imported using the id($subAppId#$templateId), e.g.

    $ pulumi import tencentcloud:index/vodImageSpriteTemplate:VodImageSpriteTemplate foo $subAppId#$templateId

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud