JSON Message Body
Table 1 describes the fields in a JSON message.
| Parameter | Type | Description |
|---|---|---|
| event_type | String | Event type. Possible values include:
|
| transcode_info | Transcoding information. This parameter is used only when event_type is TranscodeComplete or TranscodeStart. | |
| thumbnail_info | Snapshot information. This parameter is used only when event_type is ThumbnailComplete. | |
| animated_graphics_info | GIF image information. This parameter is used only when event_type is AnimatedGraphicsComplete. | |
| remux_info | Packaging information. This parameter is used only when event_type is RemuxComplete. |
| Parameter | Type | Description |
|---|---|---|
| task_id | string | Task ID |
| status | tring | Event status.
|
| create_time | string | Time when a task is created |
| start_time | string | Time when a task starts |
| end_time | string | Time when a task ends |
| intput | Storage location of an input file | |
| output | Storage location of an output file | |
| description | string | Task description |
| media_detail | Transcoding details. This field is unavailable if transcoding fails. |
| Parameter | Type | Description |
|---|---|---|
| features | String[] | Task name |
| origin_para | Input file information | |
| output_video_paras | Information about multiple output media files | |
| output_watermark_para | Watermark information |
| Parameter | Type | Description |
|---|---|---|
| duration | Integer | Duration of an input file |
| file_format | String | Input file format |
| video | Input video file information | |
| audio | Input audio file information |
| Parameter | Type | Description |
|---|---|---|
| width | Integer | Video width |
| height | Integer | Video height |
| bitrate | Integer | Video bitrate |
| frame_rate | Integer | Video frame rate |
| codec | string | Video codec |
| Parameter | Type | Description |
|---|---|---|
| codec | string | Audio codec |
| sample | Integer | Audio sampling rate |
| channels | Integer | Audio channel |
| bitrate | Integer | Audio bitrate |
| Parameter | Type | Description |
|---|---|---|
| template_id | Integer | ID of the template used by the output video |
| size | Integer | Video size |
| pack | string | Video container format |
| video | Video | Output file (video) information |
| audio | Audio | Output file (audio) information |
| file_name | string | Output file name |
| conver_duration | double | Converted duration |
| error | Error | Error information |
| Parameter | Type | Description |
|---|---|---|
| time_duration | Int32 | Watermark duration |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Task ID |
| status | String | Event status.
|
| create_time | String | Time when a task is created |
| start_time | String | Time when a task starts |
| end_time | String | Time when a task ends |
| description | String | Task description. If a task is abnormal, this field indicates error details. |
| input | Input file information | |
| output | Output file information | |
| output_param | Animated GIF parameters |
| Parameter | Type | Description |
|---|---|---|
| location | String | Region where an OBS bucket is deployed |
| bucket | String | Name of the OBS bucket |
| object | String | File path.
|
| file_name | String | Name of an output file.
|
| Parameter | Type | Description |
|---|---|---|
| format | String | Output file format. Currently, only GIF format is supported. |
| width | Integer | Width of an output file |
| height | Integer | Height of an output file |
| start | Integer | Start time Unit: millisecond |
| end | Integer | End time |
| frame_rate | Integer | Frame rate of the output file |
| Parameter | Type | Description |
|---|---|---|
| task_id | string | Task ID |
| status | tring | Event status.
|
| create_time | string | Time when a task is created |
| start_time | String | Time when a task starts |
| end_time | string | Time when a task ends |
| intput | Storage location of an input file | |
| output | Storage location of an output file | |
| description | string | Task description |
| output_file_name | String | Output file name |
| thumbnail_info | PicInfo[] | Snapshot details. This field is unavailable if capturing snapshots fails. |
| Parameter | Type | Description |
|---|---|---|
| pic_name | String | Snapshot file name |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Task ID |
| status | String | Event status.
|
| create_time | String | Time when a task is created |
| start_time | String | Time when a task starts |
| end_time | String | Time when a task ends |
| description | String | Task description. If a task is abnormal, this field indicates error details. |
| input | Input file information | |
| output | Output file information | |
| output_param | Packaging parameters |
Last Article: Appendix
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.