- Product Introduction
- Purchase Guide
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs (in Beta Testing)
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- Contact Us
- Service Agreement
- TIW Policy
- Product Introduction
- Purchase Guide
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs (in Beta Testing)
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- Contact Us
- Service Agreement
- TIW Policy
Document Requirements
Last updated: 2023-05-26 14:29:55
General requirements
1. Check whether the filename contains special characters. It is recommended that the name contain only letters, digits, and Chinese characters. Transcoding is likely to fail if the filename contains special characters.
2. Check whether the file path contains special characters. Transcoding is likely to fail if the file path contains special characters.
3. Ensure the document is editable. Transcoding will fail for read-only, encrypted, or other protected documents.
4. Use Microsoft Office 2013 or later to prepare a dynamic document. Dynamic documents made using earlier Microsoft Office versions (such as Microsoft office 2003 or Microsoft Office 2007) or other office software such as WPS and Keynote are not supported.
5. Use Microsoft Office 2013 or later to prepare a static document. You can also use one made from other office software such as WPS.
Requirements for dynamic documents
Note
Dynamic document: A PPT or PPTX document with animation effects, audios, videos, or other dynamic elements inserted.
Dynamic transcoding: A process that converts a dynamic PPT or PPTX document to web pages, with the animation effects, audios, and videos in the original document retained.
Dynamic document transcoding priority: A dynamic document transcoding task has a normal priority by default, and supports a dynamic document with up to 500 pages. If a dynamic document exceeds 500 pages, a low-priority transcoding task needs to be initiated.
Normal priority:
Dynamic document types: PPT, PPTX
Maximum document download time: 2 minutes
Maximum document pages: 500
Maximum size: 200 MB
Low priority:
Dynamic document types: PPT, PPTX
Maximum document download time: 10 minutes
Maximum document pages: 2,000
Maximum size: 200 MB
Caution
Low-priority transcoding refers to transcoding tasks initiated with the
Priority parameter set to low. These transcoding tasks support larger files and more PPT pages, but take a longer time to complete and may be performed during off-peak hours (such as in the early morning). If you need to use large PPT files with many pages, choose the low-priority dynamic transcoding solution, but ensure that you initiate the transcoding task at least 1 day before you use the transcoded documents on the whiteboard.1. It is recommended that the size of a single page (including all elements such as text, images, and audio and video files) in a PowerPoint file not exceed 300 KB. If a PowerPoint file or a page is too large, loading of the file may be slow or even fail.
1.1 Due to resource constraints, file transcoding tasks need to queue up, and the transcoding time also depends on the file size. Therefore, when there are many transcoding tasks or the file size is too large, queuing or transcoding time will increase, resulting in a longer time to complete transcoding.
1.2 For PowerPoint files that need to be shared, we recommend you transcode them in advance (for example, submit a transcoding task one day in advance), so that they can be directly loaded for use when needed. This avoids waiting for a long time during classes or meetings, providing better experience.
2. Use the default Chinese and English fonts of the operating system in PowerPoint files. Do not use the fonts installed by yourself, as non-default fonts may cause garbled characters or PowerPoint style errors. To learn about the supported fonts, see here.
3. Set transitions to "On Mouse Click" for dynamic PowerPoint files so that you can click to change slides. Otherwise, clicking on a dynamic PowerPoint file page will not change slides.
4. Do not embed Flash content into PowerPoint files as Flash playback is not supported.
5. Try not to insert audio or video files in PowerPoint files. If it is necessary to do so, observe the following requirements:
5.1 You can play, pause, or drag the progress bar only for embedded MP3 and MP4 files. Therefore, embed only MP3 or MP4 files in PowerPoint files. If you want to embed audio/video files in other formats, convert them to MP3 or MP4 first.
5.2 When inserting an MP4 video in a dynamic PowerPoint file, do not set it to automatically play and set its transitions to "On Mouse Click". Otherwise, the displayed content will be out of sync to different users.
5.3 Do not set audio and video files embedded in PowerPoint files to play automatically.
6. When inserting a GIF file in a PowerPoint file, observe the following requirements:
6.1 Set the GIF file to loop playback before inserting it; otherwise, the GIF file may not play properly after transcoding.
6.2 Do not add effects such as edge smoothing to the GIF file; otherwise, the GIF file may not play properly after transcoding.
6.3 Do not crop the GIF file; otherwise, its dimensions may be displayed abnormally after transcoding.
7. Do not insert external links in PowerPoint files, as they cannot be opened.
8. Do not preserve inks in PowerPoint files, as this may result in transcoding failure. You can open a PowerPoint file, and then go to Home > Select > Selection Pane to check whether there are inks.
9. Note the following when adding animation effects to a PowerPoint file:
9.1 Do not add unsupported animation effects (Bold Flash, Underline, Grow With Color, Bold Reveal, and Wipe). To learn which animation effects are supported, see here.
9.2 Try not to use more than 5 animation effects per slide in a PowerPoint file, as doing so may cause slow or failed loading of the file.
9.3 Try not to use more than one animation effect per trigger per slide in a PowerPoint file, as doing so may cause the displayed content to be out of sync to different users.
9.4 Try not to use cross-slide animation effects in a PowerPoint file, as doing so may cause the displayed content to be out of sync to different users..
9.5 Do not set animations or links that will cause transitions in a PowerPoint file, as doing so may cause the displayed content to be out of sync to different users.
9.6 Add animation effects to text only when the text is in non-editing mode.
9.7 Do not add 3D animations to elements.
9.8 Do not set a loop animation on the same element.
9.9 Do not add a mask on slide elements in PowerPoint files, as the mask may affect the display and click effects of the elements.
9.10 Do not click to execute the next animation before the current one is complete. Otherwise, the animation display effect may be inconsistent on different devices.
9.11 Show text, mathematical formulas, and other content in separate text boxes, with each animation corresponding to a text box. Otherwise, the animations may not play properly after transcoding.
10. To ensure the clarity of PowerPoint files, we recommend you:
10.1 Set the slide size to be twice the default width and height, that is, a width of 50 cm and a height of 28 cm for 16:9 aspect ratio, or a width of 50 cm and a height of 38 cm for 4:3 aspect ratio. Select Design > Slide Size > Custom Slide Size to customize the size.
10.2 Transcode a file using the high-definition API. Note that doing so will result in a larger output file, which may cause slow or failed loading of the file.
11. Not hide a slide; otherwise, it may not be displayed properly.
12. Try not to add a neon background to text in PPT/PPTX files.
Requirements for static documents
Note
Static document transcoding: A process that converts documents in various formats (including PPT, PPTX, WORD, PDF, JPG, JPEG, PNG, and BMP) to images, without retaining the dynamic elements (such as animations and audio/video).
Static document types: PPT, PPTX, WORD, PDF, JPG, JPEG, PNG, BMP
Maximum size: 200 MB
Maximum document pages: 5000
1. Use the default Chinese and English fonts of the operating system in static documents. Do not use the fonts installed by yourself, as non-default fonts may cause garbled characters or PowerPoint style errors. To learn about the supported fonts, see here.
2. Ensure that the width of all pages in a file is the same. Otherwise, some pages may not be displayed completely or jitter may occur.
Yes
No
Was this page helpful?