The content of this page has been automatically translated by AI. If you encounter any problems while reading, you can view the corresponding content in Chinese.
Help & Documentation>Tencent Interactive Whiteboard

Document Transcoding Event

Last updated: 2024-12-20 10:52:32

On this page:

Transcoding Progress

Event Name
TranscodeProgressChanged
Event Description
Notify the App backend when document transcoding progress changes. EventData structure definition:
Parameter name
Type
Description
TaskId
String
Document TaskId with changed progress
Progress
Integer
Current transcoding progress
Resolution
String
Document resolution, this value is an empty string until the document transcoding service parses the file resolution
Title
String
Document title, this value is an empty string until the document transcoding service parses the file title
Pages
Integer
Total number of pages in the document, this value is 0 until the document transcoding service parses the total number of pages
Example
{
  "EventType": "TranscodeProgressChanged",
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "Progress": 24,
    "Resolution": "1024x768",
    "Title": "Test.ppt",
    "Pages": 16
  }
}

Transcoding Completed

Event Name
TranscodeFinished
Event Description
Notify the App backend when document transcoding is complete.
EventData Structural Definition:
Parameter name
Type
Description
TaskId
String
TaskId of the completed transcoded document
Resolution
String
Document resolution
Title
String
Document title
Pages
Integer
Total number of pages in the document
ResultUrl
String
Document transcoding result
ThumbnailUrl
String
Thumbnail URL
ThumbnailResolution
String
Thumbnail resolution
CompressFileUrl
String
Download URL for the transcoded result packaged compressed file
Error.Code
String
If an error occurs during document transcoding, this field will appear. Refer to the API documentation for specific error code descriptions Querying document transcoding task
Error.Message
String
Specific error description if an error occurs during document transcoding
Example
Example 1 Successful transcoding callback
{
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventType": "TranscodeFinished",
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "Resolution": "1024x768",
    "Title": "Test.ppt",
    "Pages": 16,
    "ResultUrl": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
    "ThumbnailUrl": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
    "ThumbnailResolution": "793x1122",
    "CompressFileUrl": ""
  }
}
Example 2 Transcoding Failed Callback
{
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventType": "TranscodeFinished",
  "EventData": {
    "Error": {
      "Code": "InvalidParameter.UrlFormatError",
      "Message": "Document download URL is invalid"
    },
    "TaskId": "bj0mt2l23osdj300hl30",
    "Resolution": "",
    "Title": "",
    "Pages": 0,
    "ResultUrl": "",
    "ThumbnailUrl": "",
    "ThumbnailResolution": "",
    "CompressFileUrl": ""
  }
}

PPT detection end

Event Name
PPTCheckFinished
Event Description
Notify the App backend when PPT detection is complete.

EventData Structural Definition:
Parameter name
Type
Description
TaskId
String
Task Id
IsOK
bool
Is the PPT file normal
ResultUrl
String
Repaired PPT URL, only available when the parameter AutoHandleUnsupportedElement=true is set during task creation
Slides
Array of ErrSlide
Error PPT page list
ErrSlide structure definition:
Parameter name
Type
Description
Page
String
Page
Errs
Array of ErrInfo
Error element list
ErrInfo structure definition:
Parameter name
Type
Description
Name
String
Element Name
Type
int
0: Unsupported ink stroke type 1: Automatic page turning 2: Corrupted audio and video 3: Inaccessible resources 4: Read-only file 5: Unsupported element editing lock status 6: Fonts with potential compatibility issues 7: GIF images with softened edges 8: Incompatible space underscore 9: Segmented animations with mixed math formulas and text content 10: Segmented animations with gradient color text 11: Incompatible dispersion alignment 12: Incompatible multiple line spacing settings
13: Datetime type element with special character content in a:fld Tag
Detail
String
Error details
Example
Example 1 Callback with no anomalies detected
{
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventType": "PPTCheckFinished",
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "IsOK": true
  }
}
Example 2 Anomaly Detection Callback
{
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventType": "PPTCheckFinished",
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "IsOK": false,
    "ResultUrl": "https://xxx/xxx/test_fixed.ppt",
    "Slides": [
      {
        "Page": "Slide 5",
        "Errs": [{
          "Name": "Ink 1",
          "Type": 0,
          "Detail": "WPS Ink"
        }]
      }
    ]
  }
}
Example 3 Detection Failed Callback
{
  "ExpireTime": 1590046391,
  "SdkAppId": 1400000001,
  "Sign": "a2dabb362a9b811c0e26953a6276a41c",
  "Timestamp": 1575545412,
  "EventType": "PPTCheckFinished",
  "EventData": {
    "Error": {
      "Code": "InvalidParameter.UrlFormatError",
      "Message": "Document download URL is invalid"
    },
    "TaskId": "bj0mt2l23osdj300hl30"
  }
}

中国站 - English