Skip to content

Commit 2d61cca

Browse files
crab21crab21
committed
docs: 1、add VOD datasource directory for provider.2、update describe
1 parent c698f7d commit 2d61cca

8 files changed

+426
-1
lines changed

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
## 1.45.2 (Unreleased)
2+
3+
ENHANCEMENTS:
4+
5+
* update Resource and Datasource description.
6+
27
## 1.45.1 (October 16, 2020)
38

49
ENHANCEMENTS:

‎tencentcloud/provider.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,11 @@ TcaplusDB
390390
391391
VOD
392392
Data Source
393+
tencentcloud_vod_adaptive_dynamic_streaming_templates
394+
tencentcloud_vod_snapshot_by_time_offset_templates
395+
tencentcloud_vod_super_player_configs
396+
tencentcloud_vod_image_sprite_templates
397+
tencentcloud_vod_procedure_templates
393398
394399
395400
Resource

‎website/docs/d/vod_adaptive_dynamic_streaming_templates.html.markdown

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
subcategory: "VOD"
3+
layout: "tencentcloud"
4+
page_title: "TencentCloud: tencentcloud_vod_adaptive_dynamic_streaming_templates"
5+
sidebar_current: "docs-tencentcloud-datasource-vod_adaptive_dynamic_streaming_templates"
6+
description: |-
7+
Use this data source to query detailed information of VOD adaptive dynamic streaming templates.
8+
---
9+
10+
# tencentcloud_vod_adaptive_dynamic_streaming_templates
11+
12+
Use this data source to query detailed information of VOD adaptive dynamic streaming templates.
13+
14+
## Example Usage
15+
16+
```hcl
17+
resource "tencentcloud_vod_adaptive_dynamic_streaming_template" "foo" {
18+
format = "HLS"
19+
name = "tf-adaptive"
20+
drm_type = "SimpleAES"
21+
disable_higher_video_bitrate = false
22+
disable_higher_video_resolution = false
23+
comment = "test"
24+
25+
stream_info {
26+
video {
27+
codec = "libx265"
28+
fps = 4
29+
bitrate = 129
30+
resolution_adaptive = false
31+
width = 128
32+
height = 128
33+
fill_type = "stretch"
34+
}
35+
audio {
36+
codec = "libmp3lame"
37+
bitrate = 129
38+
sample_rate = 44100
39+
audio_channel = "dual"
40+
}
41+
remove_audio = false
42+
}
43+
stream_info {
44+
video {
45+
codec = "libx264"
46+
fps = 4
47+
bitrate = 256
48+
}
49+
audio {
50+
codec = "libfdk_aac"
51+
bitrate = 256
52+
sample_rate = 44100
53+
}
54+
remove_audio = true
55+
}
56+
}
57+
58+
data "tencentcloud_vod_adaptive_dynamic_streaming_templates" "foo" {
59+
type = "Custom"
60+
definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id
61+
}
62+
```
63+
64+
## Argument Reference
65+
66+
The following arguments are supported:
67+
68+
* `definition` - (Optional) Unique ID filter of adaptive dynamic streaming template.
69+
* `result_output_file` - (Optional) Used to save results.
70+
* `sub_app_id` - (Optional) 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.
71+
* `type` - (Optional) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.
72+
73+
## Attributes Reference
74+
75+
In addition to all arguments above, the following attributes are exported:
76+
77+
* `template_list` - A list of adaptive dynamic streaming templates. Each element contains the following attributes:
78+
* `comment` - Template description.
79+
* `create_time` - Creation time of template in ISO date format.
80+
* `definition` - Unique ID of adaptive dynamic streaming template.
81+
* `disable_higher_video_bitrate` - Whether to prohibit transcoding video from low bitrate to high bitrate. `false`: no, `true`: yes.
82+
* `disable_higher_video_resolution` - Whether to prohibit transcoding from low resolution to high resolution. `false`: no, `true`: yes.
83+
* `drm_type` - DRM scheme type.
84+
* `format` - Adaptive bitstream format.
85+
* `name` - Template name.
86+
* `stream_info` - List of AdaptiveStreamTemplate parameter information of output substream for adaptive bitrate streaming.
87+
* `audio` - Audio parameter information.
88+
* `audio_channel` - Audio channel system. Valid values: mono, dual, stereo.
89+
* `bitrate` - Audio stream bitrate in Kbps. Value range: `0` and `[26, 256]`. If the value is `0`, the bitrate of the audio stream will be the same as that of the original audio.
90+
* `codec` - Audio stream encoder. Valid value are: `libfdk_aac` and `libmp3lame`.
91+
* `sample_rate` - Audio stream sample rate. Valid values: `32000`, `44100`, `48000`. in Hz.
92+
* `remove_audio` - Whether to remove audio stream. `false`: no, `true`: yes.
93+
* `video` - Video parameter information.
94+
* `bitrate` - Bitrate of video stream in Kbps. Value range: `0` and `[128, 35000]`. If the value is `0`, the bitrate of the video will be the same as that of the source video.
95+
* `codec` - Video stream encoder. Valid values: `libx264`, `libx265`, `av1`.`libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4.
96+
* `fill_type` - 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. Note: this field may return null, indicating that no valid values can be obtained.
97+
* `fps` - Video frame rate in Hz. Value range: `[0, 60]`. If the value is `0`, the frame rate will be the same as that of the source video.
98+
* `height` - Maximum value of the height (or short side) of a video stream in px. Value range: `0` and `[128, 4096]`. 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. Note: this field may return null, indicating that no valid values can be obtained.
99+
* `resolution_adaptive` - 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. Note: this field may return null, indicating that no valid values can be obtained.
100+
* `width` - Maximum value of the width (or long side) of a video stream in px. Value range: `0` and `[128, 4096]`. 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. Note: this field may return null, indicating that no valid values can be obtained.
101+
* `type` - Template type filter. Valid values: `Preset`,`Custom`. `Preset`: preset template; `Custom`: custom template.
102+
* `update_time` - Last modified time of template in ISO date format.
103+
104+

‎website/docs/d/vod_image_sprite_templates.html.markdown

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
subcategory: "VOD"
3+
layout: "tencentcloud"
4+
page_title: "TencentCloud: tencentcloud_vod_image_sprite_templates"
5+
sidebar_current: "docs-tencentcloud-datasource-vod_image_sprite_templates"
6+
description: |-
7+
Use this data source to query detailed information of VOD image sprite templates.
8+
---
9+
10+
# tencentcloud_vod_image_sprite_templates
11+
12+
Use this data source to query detailed information of VOD image sprite templates.
13+
14+
## Example Usage
15+
16+
```hcl
17+
resource "tencentcloud_vod_image_sprite_template" "foo" {
18+
sample_type = "Percent"
19+
sample_interval = 10
20+
row_count = 3
21+
column_count = 3
22+
name = "tf-sprite"
23+
comment = "test"
24+
fill_type = "stretch"
25+
width = 128
26+
height = 128
27+
resolution_adaptive = false
28+
}
29+
30+
data "tencentcloud_vod_image_sprite_templates" "foo" {
31+
type = "Custom"
32+
definition = tencentcloud_vod_image_sprite_template.foo.id
33+
}
34+
```
35+
36+
## Argument Reference
37+
38+
The following arguments are supported:
39+
40+
* `definition` - (Optional) Unique ID filter of image sprite template.
41+
* `result_output_file` - (Optional) Used to save results.
42+
* `sub_app_id` - (Optional) 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.
43+
* `type` - (Optional) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.
44+
45+
## Attributes Reference
46+
47+
In addition to all arguments above, the following attributes are exported:
48+
49+
* `template_list` - A list of image sprite templates. Each element contains the following attributes:
50+
* `column_count` - Subimage column count of an image sprite.
51+
* `comment` - Template description.
52+
* `create_time` - Creation time of template in ISO date format.
53+
* `definition` - Unique ID of image sprite template.
54+
* `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.
55+
* `height` - 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.
56+
* `name` - Name of a time point screen capturing template.
57+
* `resolution_adaptive` - Resolution adaption. Valid values: `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.
58+
* `row_count` - Subimage row count of an image sprite.
59+
* `sample_interval` - 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.
60+
* `sample_type` - Sampling type. Valid values: `Percent`, `Time`. `Percent`: by percent. `Time`: by time interval.
61+
* `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.
62+
* `update_time` - Last modified time of template in ISO date format.
63+
* `width` - 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.
64+
65+

‎website/docs/d/vod_procedure_templates.html.markdown

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
subcategory: "VOD"
3+
layout: "tencentcloud"
4+
page_title: "TencentCloud: tencentcloud_vod_procedure_templates"
5+
sidebar_current: "docs-tencentcloud-datasource-vod_procedure_templates"
6+
description: |-
7+
Use this data source to query detailed information of VOD procedure templates.
8+
---
9+
10+
# tencentcloud_vod_procedure_templates
11+
12+
Use this data source to query detailed information of VOD procedure templates.
13+
14+
## Example Usage
15+
16+
```hcl
17+
resource "tencentcloud_vod_procedure_template" "foo" {
18+
name = "tf-procedure"
19+
comment = "test"
20+
media_process_task {
21+
adaptive_dynamic_streaming_task_list {
22+
definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id
23+
}
24+
snapshot_by_time_offset_task_list {
25+
definition = tencentcloud_vod_snapshot_by_time_offset_template.foo.id
26+
ext_time_offset_list = [
27+
"3.5s"
28+
]
29+
}
30+
image_sprite_task_list {
31+
definition = tencentcloud_vod_image_sprite_template.foo.id
32+
}
33+
}
34+
}
35+
36+
data "tencentcloud_vod_procedure_templates" "foo" {
37+
type = "Custom"
38+
name = tencentcloud_vod_procedure_template.foo.id
39+
}
40+
```
41+
42+
## Argument Reference
43+
44+
The following arguments are supported:
45+
46+
* `name` - (Optional) Name of procedure template.
47+
* `result_output_file` - (Optional) Used to save results.
48+
* `sub_app_id` - (Optional) 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.
49+
* `type` - (Optional) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.
50+
51+
## Attributes Reference
52+
53+
In addition to all arguments above, the following attributes are exported:
54+
55+
* `template_list` - A list of adaptive dynamic streaming templates. Each element contains the following attributes:
56+
* `comment` - Template description.
57+
* `create_time` - Creation time of template in ISO date format.
58+
* `media_process_task` - Parameter of video processing task.
59+
* `adaptive_dynamic_streaming_task_list` - List of adaptive bitrate streaming tasks. Note: this field may return null, indicating that no valid values can be obtained.
60+
* `definition` - Adaptive bitrate streaming template ID.
61+
* `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
62+
* `animated_graphic_task_list` - List of animated image generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
63+
* `definition` - Animated image generating template ID.
64+
* `end_time_offset` - End time of animated image in video in seconds.
65+
* `start_time_offset` - Start time of animated image in video in seconds.
66+
* `cover_by_snapshot_task_list` - List of cover generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
67+
* `definition` - Time point screen capturing template ID.
68+
* `position_type` - Screen capturing mode. Valid values: `Time`, `Percent`. `Time`: screen captures by time point, `Percent`: screen captures by percentage.
69+
* `position_value` - Screenshot position: For time point screen capturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover. For percentage screen capturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover.
70+
* `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
71+
* `image_sprite_task_list` - List of image sprite generating tasks. Note: this field may return null, indicating that no valid values can be obtained.
72+
* `definition` - Image sprite generating template ID.
73+
* `sample_snapshot_task_list` - List of sampled screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained.
74+
* `definition` - Sampled screen capturing template ID.
75+
* `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
76+
* `snapshot_by_time_offset_task_list` - List of time point screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained.
77+
* `definition` - Time point screen capturing template ID.
78+
* `ext_time_offset_list` - The list of screenshot time points. `s` and `%` formats are supported: When a time point string ends with `s`, its unit is second. For example, `3.5s` means the 3.5th second of the video; When a time point string ends with `%`, it is marked with corresponding percentage of the video duration. For example, `10%` means that the time point is at the 10% of the video entire duration.
79+
* `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
80+
* `transcode_task_list` - List of transcoding tasks. Note: this field may return null, indicating that no valid values can be obtained.
81+
* `definition` - Video transcoding template ID.
82+
* `mosaic_list` - List of blurs. Up to 10 ones can be supported.
83+
* `coordinate_origin` - Origin position, which currently can only be: `TopLeft`: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text.
84+
* `end_time_offset` - End time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will exist till the last video frame; If this value is greater than `0` (e.g., n), the blur will exist till second n; If this value is smaller than `0` (e.g., -n), the blur will exist till second n before the last video frame.
85+
* `height` - Blur height. `%` and `px` formats are supported: If the string ends in `%`, the `height` of the blur will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height; If the string ends in `px`, the `height` of the blur will be in px; for example, 100px means that Height is 100 px.
86+
* `start_time_offset` - Start time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame; If this value is greater than `0` (e.g., n), the blur will appear at second n after the first video frame; If this value is smaller than `0` (e.g., -n), the blur will appear at second n before the last video frame.
87+
* `width` - Blur width. `%` and `px` formats are supported: If the string ends in `%`, the `width` of the blur will be the specified percentage of the video width; for example, 10% means that `width` is 10% of the video width; If the string ends in `px`, the `width` of the blur will be in px; for example, 100px means that Width is 100 px.
88+
* `x_pos` - The horizontal position of the origin of the blur relative to the origin of coordinates of the video. `%` and `px` formats are supported: If the string ends in `%`, the XPos of the blur will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width; If the string ends in `px`, the XPos of the blur will be the specified px; for example, 100px means that XPos is 100 px.
89+
* `y_pos` - Vertical position of the origin of blur relative to the origin of coordinates of video. `%` and `px` formats are supported: If the string ends in `%`, the YPos of the blur will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height; If the string ends in `px`, the YPos of the blur will be the specified px; for example, 100px means that YPos is 100 px.
90+
* `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained.
91+
* `name` - Task flow name.
92+
* `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.
93+
* `update_time` - Last modified time of template in ISO date format.
94+
95+

0 commit comments

Comments
 (0)