Frequently Asked Questions

Updated: 2023-12-11 10:55:23

1. What is the bundle size of the Viewer SDK? Can its features be called on demand?

The bundle size is approximately 1MB (before GZip). The pluggable mechanism for functional modules is under development (medium priority). Once completed, features can be called on demand.

2. If we have already integrated the Live JSSDK, how can we upgrade to the Viewer SDK?

The workflows and interfaces of the two SDKs are completely different. Direct upgrade is not possible; re-integration is required. Although the workload is significant, the benefits are substantial:

The Live JSSDK only provides basic live viewing and co-hosting features, requiring other SDKs to build a basic live viewing page. The Viewer SDK integrates all necessary features for a live viewing page.
The Live JSSDK lacks a supporting UI layer, offering only a few simple demo features. The Viewer SDK has comprehensive functionality and interaction, allowing customers to develop "standing on the shoulders of giants," resulting in lower customization costs and higher reliability.

3. If we are not using the Vue.js tech stack, or the framework version is inconsistent, how can we call the SaaS UI layer?

Method 1: Treat the viewer page as an independent project, so its tech stack is unrelated to the original project. This is the recommended approach.
Method 2: Develop your own solution by referencing the SaaS UI source code. However, this is not recommended, as it requires a long development time and is prone to deviations during implementation.

4. If our frontend development capabilities are limited, will custom development be very difficult?

Polyv has dedicated SDK delivery personnel who can assist you with low and medium-low complexity modifications.
If you have high-complexity customization needs, paid customization services are also available.

5. After the Viewer SDK and SaaS UI layer are updated, how can customers synchronize modifications?

SDK iterations will ensure backward compatibility as much as possible, so:

For non-major version updates, simply upgrade the version.
For major version updates, follow the upgrade guide strictly.

The SaaS UI layer is an entire open-source project, not a service provided via APIs. Once the code is modified, updates cannot be applied by overwriting files. Recommended update methods:

If there are many custom modifications, locate the required changes based on file paths or the open-source project's change log, and update selectively.
If there are few custom modifications, record the changes. When updating the UI layer, pull the latest open-source project code and reapply the modifications.

6. Can the Viewer SDK and SaaS UI layer run on native mini-programs?

The Viewer SDK contains only logic code and is independent of the UI and tech framework, so it has the potential to be compatible with native mini-program environments. This is currently under development (low priority).

The SaaS UI layer is developed based on Vue.js and uses many browser-specific APIs, so it cannot run in native mini-program environments.