tencentcloud 1.81.189, Apr 30 25

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.VodSampleSnapshotTemplate

Explore with Pulumi AI

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Create VodSampleSnapshotTemplate Resource

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

Constructor syntax

new VodSampleSnapshotTemplate(name: string, args: VodSampleSnapshotTemplateArgs, opts?: CustomResourceOptions);

@overload
def VodSampleSnapshotTemplate(resource_name: str,
                              args: VodSampleSnapshotTemplateArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def VodSampleSnapshotTemplate(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              sample_interval: Optional[float] = None,
                              sample_type: Optional[str] = None,
                              sub_app_id: Optional[float] = None,
                              comment: Optional[str] = None,
                              fill_type: Optional[str] = None,
                              format: Optional[str] = None,
                              height: Optional[float] = None,
                              name: Optional[str] = None,
                              resolution_adaptive: Optional[str] = None,
                              vod_sample_snapshot_template_id: Optional[str] = None,
                              width: Optional[float] = None)

func NewVodSampleSnapshotTemplate(ctx *Context, name string, args VodSampleSnapshotTemplateArgs, opts ...ResourceOption) (*VodSampleSnapshotTemplate, error)

public VodSampleSnapshotTemplate(string name, VodSampleSnapshotTemplateArgs args, CustomResourceOptions? opts = null)

public VodSampleSnapshotTemplate(String name, VodSampleSnapshotTemplateArgs args)
public VodSampleSnapshotTemplate(String name, VodSampleSnapshotTemplateArgs args, CustomResourceOptions options)

type: tencentcloud:VodSampleSnapshotTemplate
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 VodSampleSnapshotTemplateArgs: 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 VodSampleSnapshotTemplateArgs: 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 VodSampleSnapshotTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VodSampleSnapshotTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VodSampleSnapshotTemplateArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

VodSampleSnapshotTemplate 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 VodSampleSnapshotTemplate resource accepts the following input properties:

SampleInterval double: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
SampleType string: Sampled screencapturing type. Valid values: 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.
Comment string: Template description. Length limit: 256 characters.
FillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
Format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
ResolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
VodSampleSnapshotTemplateId 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.

SampleInterval float64: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
SampleType string: Sampled screencapturing type. Valid values: 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.
Comment string: Template description. Length limit: 256 characters.
FillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
Format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
ResolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
VodSampleSnapshotTemplateId 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.

sampleInterval Double: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType String: Sampled screencapturing type. Valid values: 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.
comment String: Template description. Length limit: 256 characters.
fillType String: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format String: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive String: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
vodSampleSnapshotTemplateId 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.

sampleInterval number: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType string: Sampled screencapturing type. Valid values: 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.
comment string: Template description. Length limit: 256 characters.
fillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
vodSampleSnapshotTemplateId 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.

sample_interval float: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sample_type str: Sampled screencapturing type. Valid values: 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.
comment str: Template description. Length limit: 256 characters.
fill_type str: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format str: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolution_adaptive str: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
vod_sample_snapshot_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.

sampleInterval Number: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType String: Sampled screencapturing type. Valid values: 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.
comment String: Template description. Length limit: 256 characters.
fillType String: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format String: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive String: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
vodSampleSnapshotTemplateId 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 VodSampleSnapshotTemplate resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing VodSampleSnapshotTemplate Resource

Get an existing VodSampleSnapshotTemplate 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?: VodSampleSnapshotTemplateState, opts?: CustomResourceOptions): VodSampleSnapshotTemplate

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        fill_type: Optional[str] = None,
        format: Optional[str] = None,
        height: Optional[float] = None,
        name: Optional[str] = None,
        resolution_adaptive: Optional[str] = None,
        sample_interval: Optional[float] = None,
        sample_type: Optional[str] = None,
        sub_app_id: Optional[float] = None,
        vod_sample_snapshot_template_id: Optional[str] = None,
        width: Optional[float] = None) -> VodSampleSnapshotTemplate

func GetVodSampleSnapshotTemplate(ctx *Context, name string, id IDInput, state *VodSampleSnapshotTemplateState, opts ...ResourceOption) (*VodSampleSnapshotTemplate, error)

public static VodSampleSnapshotTemplate Get(string name, Input<string> id, VodSampleSnapshotTemplateState? state, CustomResourceOptions? opts = null)

public static VodSampleSnapshotTemplate get(String name, Output<String> id, VodSampleSnapshotTemplateState state, CustomResourceOptions options)

resources:  _:    type: tencentcloud:VodSampleSnapshotTemplate    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:

Comment string: Template description. Length limit: 256 characters.
FillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
Format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
ResolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
SampleInterval double: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
SampleType string: Sampled screencapturing type. Valid values: 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.
VodSampleSnapshotTemplateId 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.

Comment string: Template description. Length limit: 256 characters.
FillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
Format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
ResolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
SampleInterval float64: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
SampleType string: Sampled screencapturing type. Valid values: 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.
VodSampleSnapshotTemplateId 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.

comment String: Template description. Length limit: 256 characters.
fillType String: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format String: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive String: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
sampleInterval Double: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType String: Sampled screencapturing type. Valid values: 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.
vodSampleSnapshotTemplateId 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.

comment string: Template description. Length limit: 256 characters.
fillType string: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format string: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive string: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
sampleInterval number: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType string: Sampled screencapturing type. Valid values: 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.
vodSampleSnapshotTemplateId 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.

comment str: Template description. Length limit: 256 characters.
fill_type str: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format str: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolution_adaptive str: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
sample_interval float: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sample_type str: Sampled screencapturing type. Valid values: 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.
vod_sample_snapshot_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.

comment String: Template description. Length limit: 256 characters.
fillType String: Fill type. 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.Default value: black.
format String: Image format. Valid values: jpg, png. 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 sampled screencapturing template. Length limit: 64 characters.
resolutionAdaptive String: Resolution adaption. Valid values: open: enabled. In this case, Width represents the long side of a video, while Height the short side; close: disabled. In this case, Width represents the width of a video, while Height the height.Default value: open.
sampleInterval Number: Sampling interval. If SampleType is Percent, sampling will be performed at an interval of the specified percentage. If SampleType is Time, sampling will be performed at the specified time interval in seconds.
sampleType String: Sampled screencapturing type. Valid values: 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.
vodSampleSnapshotTemplateId 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 snapshot template can be imported using the id($subAppId#$templateId), e.g.

$ pulumi import tencentcloud:index/vodSampleSnapshotTemplate:VodSampleSnapshotTemplate sample_snapshot_template $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 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.VodSampleSnapshotTemplate

On this page

On this page

Create VodSampleSnapshotTemplate Resource

Constructor syntax

Parameters

VodSampleSnapshotTemplate Resource Properties

Inputs

Outputs

Look up Existing VodSampleSnapshotTemplate Resource

Import

Package Details

On this page

On this page