tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
tencentcloud.getVodImageSpriteTemplates
Start a Neo task
Explain and create a tencentcloud.getVodImageSpriteTemplates resource
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
Use this data source to query detailed information of VOD image sprite templates.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const fooVodImageSpriteTemplate = new tencentcloud.VodImageSpriteTemplate("foo", {
sampleType: "Percent",
sampleInterval: 10,
rowCount: 3,
columnCount: 3,
name: "tf-sprite",
comment: "test",
fillType: "stretch",
width: 128,
height: 128,
resolutionAdaptive: false,
});
const foo = tencentcloud.getVodImageSpriteTemplatesOutput({
type: "Custom",
definition: fooVodImageSpriteTemplate.vodImageSpriteTemplateId,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
foo_vod_image_sprite_template = tencentcloud.VodImageSpriteTemplate("foo",
sample_type="Percent",
sample_interval=10,
row_count=3,
column_count=3,
name="tf-sprite",
comment="test",
fill_type="stretch",
width=128,
height=128,
resolution_adaptive=False)
foo = tencentcloud.get_vod_image_sprite_templates_output(type="Custom",
definition=foo_vod_image_sprite_template.vod_image_sprite_template_id)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooVodImageSpriteTemplate, err := tencentcloud.NewVodImageSpriteTemplate(ctx, "foo", &tencentcloud.VodImageSpriteTemplateArgs{
SampleType: pulumi.String("Percent"),
SampleInterval: pulumi.Float64(10),
RowCount: pulumi.Float64(3),
ColumnCount: pulumi.Float64(3),
Name: pulumi.String("tf-sprite"),
Comment: pulumi.String("test"),
FillType: pulumi.String("stretch"),
Width: pulumi.Float64(128),
Height: pulumi.Float64(128),
ResolutionAdaptive: pulumi.Bool(false),
})
if err != nil {
return err
}
_ = tencentcloud.GetVodImageSpriteTemplatesOutput(ctx, tencentcloud.GetVodImageSpriteTemplatesOutputArgs{
Type: pulumi.String("Custom"),
Definition: fooVodImageSpriteTemplate.VodImageSpriteTemplateId,
}, nil)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;
return await Deployment.RunAsync(() =>
{
var fooVodImageSpriteTemplate = new Tencentcloud.VodImageSpriteTemplate("foo", new()
{
SampleType = "Percent",
SampleInterval = 10,
RowCount = 3,
ColumnCount = 3,
Name = "tf-sprite",
Comment = "test",
FillType = "stretch",
Width = 128,
Height = 128,
ResolutionAdaptive = false,
});
var foo = Tencentcloud.GetVodImageSpriteTemplates.Invoke(new()
{
Type = "Custom",
Definition = fooVodImageSpriteTemplate.VodImageSpriteTemplateId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.VodImageSpriteTemplate;
import com.pulumi.tencentcloud.VodImageSpriteTemplateArgs;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetVodImageSpriteTemplatesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var fooVodImageSpriteTemplate = new VodImageSpriteTemplate("fooVodImageSpriteTemplate", VodImageSpriteTemplateArgs.builder()
.sampleType("Percent")
.sampleInterval(10.0)
.rowCount(3.0)
.columnCount(3.0)
.name("tf-sprite")
.comment("test")
.fillType("stretch")
.width(128.0)
.height(128.0)
.resolutionAdaptive(false)
.build());
final var foo = TencentcloudFunctions.getVodImageSpriteTemplates(GetVodImageSpriteTemplatesArgs.builder()
.type("Custom")
.definition(fooVodImageSpriteTemplate.vodImageSpriteTemplateId())
.build());
}
}
resources:
fooVodImageSpriteTemplate:
type: tencentcloud:VodImageSpriteTemplate
name: foo
properties:
sampleType: Percent
sampleInterval: 10
rowCount: 3
columnCount: 3
name: tf-sprite
comment: test
fillType: stretch
width: 128
height: 128
resolutionAdaptive: false
variables:
foo:
fn::invoke:
function: tencentcloud:getVodImageSpriteTemplates
arguments:
type: Custom
definition: ${fooVodImageSpriteTemplate.vodImageSpriteTemplateId}
Using getVodImageSpriteTemplates
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getVodImageSpriteTemplates(args: GetVodImageSpriteTemplatesArgs, opts?: InvokeOptions): Promise<GetVodImageSpriteTemplatesResult>
function getVodImageSpriteTemplatesOutput(args: GetVodImageSpriteTemplatesOutputArgs, opts?: InvokeOptions): Output<GetVodImageSpriteTemplatesResult>def get_vod_image_sprite_templates(definition: Optional[str] = None,
id: Optional[str] = None,
result_output_file: Optional[str] = None,
sub_app_id: Optional[float] = None,
type: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVodImageSpriteTemplatesResult
def get_vod_image_sprite_templates_output(definition: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
result_output_file: Optional[pulumi.Input[str]] = None,
sub_app_id: Optional[pulumi.Input[float]] = None,
type: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVodImageSpriteTemplatesResult]func GetVodImageSpriteTemplates(ctx *Context, args *GetVodImageSpriteTemplatesArgs, opts ...InvokeOption) (*GetVodImageSpriteTemplatesResult, error)
func GetVodImageSpriteTemplatesOutput(ctx *Context, args *GetVodImageSpriteTemplatesOutputArgs, opts ...InvokeOption) GetVodImageSpriteTemplatesResultOutput> Note: This function is named GetVodImageSpriteTemplates in the Go SDK.
public static class GetVodImageSpriteTemplates
{
public static Task<GetVodImageSpriteTemplatesResult> InvokeAsync(GetVodImageSpriteTemplatesArgs args, InvokeOptions? opts = null)
public static Output<GetVodImageSpriteTemplatesResult> Invoke(GetVodImageSpriteTemplatesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVodImageSpriteTemplatesResult> getVodImageSpriteTemplates(GetVodImageSpriteTemplatesArgs args, InvokeOptions options)
public static Output<GetVodImageSpriteTemplatesResult> getVodImageSpriteTemplates(GetVodImageSpriteTemplatesArgs args, InvokeOptions options)
fn::invoke:
function: tencentcloud:index/getVodImageSpriteTemplates:getVodImageSpriteTemplates
arguments:
# arguments dictionaryThe following arguments are supported:
- Definition string
- Unique ID filter of image sprite template.
- Id string
- Result
Output stringFile - Used to save results.
- Sub
App doubleId - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- Definition string
- Unique ID filter of image sprite template.
- Id string
- Result
Output stringFile - Used to save results.
- Sub
App float64Id - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- definition String
- Unique ID filter of image sprite template.
- id String
- result
Output StringFile - Used to save results.
- sub
App DoubleId - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- definition string
- Unique ID filter of image sprite template.
- id string
- result
Output stringFile - Used to save results.
- sub
App numberId - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- definition str
- Unique ID filter of image sprite template.
- id str
- result_
output_ strfile - Used to save results.
- sub_
app_ floatid - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- type str
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- definition String
- Unique ID filter of image sprite template.
- id String
- result
Output StringFile - Used to save results.
- sub
App NumberId - Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
- type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
getVodImageSpriteTemplates Result
The following output properties are available:
- Id string
- Template
Lists List<GetVod Image Sprite Templates Template List> - A list of image sprite templates. Each element contains the following attributes:
- Definition string
- Unique ID of image sprite template.
- Result
Output stringFile - Sub
App doubleId - Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- Id string
- Template
Lists []GetVod Image Sprite Templates Template List - A list of image sprite templates. Each element contains the following attributes:
- Definition string
- Unique ID of image sprite template.
- Result
Output stringFile - Sub
App float64Id - Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- id String
- template
Lists List<GetVod Image Sprite Templates Template List> - A list of image sprite templates. Each element contains the following attributes:
- definition String
- Unique ID of image sprite template.
- result
Output StringFile - sub
App DoubleId - type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- id string
- template
Lists GetVod Image Sprite Templates Template List[] - A list of image sprite templates. Each element contains the following attributes:
- definition string
- Unique ID of image sprite template.
- result
Output stringFile - sub
App numberId - type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- id str
- template_
lists Sequence[GetVod Image Sprite Templates Template List] - A list of image sprite templates. Each element contains the following attributes:
- definition str
- Unique ID of image sprite template.
- result_
output_ strfile - sub_
app_ floatid - type str
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
- id String
- template
Lists List<Property Map> - A list of image sprite templates. Each element contains the following attributes:
- definition String
- Unique ID of image sprite template.
- result
Output StringFile - sub
App NumberId - type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template.
Supporting Types
GetVodImageSpriteTemplatesTemplateList
- Column
Count double - Subimage column count of an image sprite.
- Comment string
- Template description.
- Create
Time string - Creation time of template in ISO date format.
- Definition string
- Unique ID filter of image sprite template.
- Fill
Type 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. - Height double
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - Name string
- Name of a time point screen capturing template.
- Resolution
Adaptive bool - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - Row
Count double - Subimage row count of an image sprite.
- Sample
Interval double - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, sampling will be performed at the specified time interval in seconds. - Sample
Type string - Sampling type. Valid values:
Percent,Time.Percent: by percent.Time: by time interval. - Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - Update
Time string - Last modified time of template in ISO date format.
- Width double
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
- Column
Count float64 - Subimage column count of an image sprite.
- Comment string
- Template description.
- Create
Time string - Creation time of template in ISO date format.
- Definition string
- Unique ID filter of image sprite template.
- Fill
Type 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. - Height float64
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - Name string
- Name of a time point screen capturing template.
- Resolution
Adaptive bool - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - Row
Count float64 - Subimage row count of an image sprite.
- Sample
Interval float64 - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, sampling will be performed at the specified time interval in seconds. - Sample
Type string - Sampling type. Valid values:
Percent,Time.Percent: by percent.Time: by time interval. - Type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - Update
Time string - Last modified time of template in ISO date format.
- Width float64
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
- column
Count Double - Subimage column count of an image sprite.
- comment String
- Template description.
- create
Time String - Creation time of template in ISO date format.
- definition String
- Unique ID filter of image sprite template.
- fill
Type 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. - height Double
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - name String
- Name of a time point screen capturing template.
- resolution
Adaptive Boolean - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - row
Count Double - Subimage row count of an image sprite.
- sample
Interval Double - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, sampling will be performed at the specified time interval in seconds. - sample
Type String - Sampling type. Valid values:
Percent,Time.Percent: by percent.Time: by time interval. - type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - update
Time String - Last modified time of template in ISO date format.
- width Double
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
- column
Count number - Subimage column count of an image sprite.
- comment string
- Template description.
- create
Time string - Creation time of template in ISO date format.
- definition string
- Unique ID filter of image sprite template.
- fill
Type 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. - height number
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - name string
- Name of a time point screen capturing template.
- resolution
Adaptive boolean - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - row
Count number - Subimage row count of an image sprite.
- sample
Interval number - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, sampling will be performed at the specified time interval in seconds. - sample
Type string - Sampling type. Valid values:
Percent,Time.Percent: by percent.Time: by time interval. - type string
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - update
Time string - Last modified time of template in ISO date format.
- width number
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
- column_
count float - Subimage column count of an image sprite.
- comment str
- Template description.
- create_
time str - Creation time of template in ISO date format.
- definition str
- Unique ID filter of image sprite template.
- 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. - height float
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - name str
- Name of a time point screen capturing template.
- resolution_
adaptive bool - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - row_
count float - Subimage row count of an image sprite.
- sample_
interval float - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, 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. - type str
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - update_
time str - Last modified time of template in ISO date format.
- width float
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
- column
Count Number - Subimage column count of an image sprite.
- comment String
- Template description.
- create
Time String - Creation time of template in ISO date format.
- definition String
- Unique ID filter of image sprite template.
- fill
Type 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. - height Number
- Maximum value of the
height(or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0,widthwill be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used. - name String
- Name of a time point screen capturing template.
- resolution
Adaptive Boolean - Resolution adaption. Valid values:
true: enabled. In this case,widthrepresents the long side of a video, whileheightthe short side;false: disabled. In this case,widthrepresents the width of a video, whileheightthe height. - row
Count Number - Subimage row count of an image sprite.
- sample
Interval Number - Sampling interval. If
sample_typeisPercent, sampling will be performed at an interval of the specified percentage. Ifsample_typeisTime, sampling will be performed at the specified time interval in seconds. - sample
Type String - Sampling type. Valid values:
Percent,Time.Percent: by percent.Time: by time interval. - type String
- Template type filter. Valid values:
Preset,Custom.Preset: preset template;Custom: custom template. - update
Time String - Last modified time of template in ISO date format.
- width Number
- Maximum value of the
width(or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If bothwidthandheightare0, the resolution will be the same as that of the source video; Ifwidthis0, butheightis not0, width will be proportionally scaled; Ifwidthis not0, butheightis0,heightwill be proportionally scaled; If bothwidthandheightare not0, the custom resolution will be used.
Package Details
- Repository
- tencentcloud tencentcloudstack/terraform-provider-tencentcloud
- License
- Notes
- This Pulumi package is based on the
tencentcloudTerraform Provider.
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
