Upload Plugin 2.0

Notes:

1. This document briefly describes how to use the POLYV web upload plugin from a user's perspective.
2. The usage of V2.0 is completely identical to V1.0, so there is no need to change the original API calls or logic. Simply replace the call address of polyv-upload.js. (V2.0 is recommended)

1. Features:

1. File Upload
   1. Before uploading, you can select a category, add tags, choose video optimization processing, modify the file name and file description, etc.
   2. You can set a default upload directory.
   3. You can set whether to encode the source file.
   4. Supports resumable upload. If the network is interrupted or the browser restarts due to a failure, the same file can resume uploading from the breakpoint. (This feature is only supported in browsers >= IE10 and mainstream browsers.)
   5. Supports selecting multiple files simultaneously and displays upload progress.
2. View Videos
   1. View the video list.
   2. Search for videos by title keywords.
   3. Retrieve specific video information.
   4. Change the cover image. a. Upload a new image as the cover. b. Select a video screenshot as the cover. c. Select a recently uploaded image as the cover.
3. Option to display only the "Upload List", only the "Video List", or both.
4. Can call interfaces (response, uploadSuccess, uploadFail) to return video information.
5. Provides methods to open and close the plugin.

2. Browser Support

• Supports most mainstream browsers. IE is compatible with IE9 and above.
• In browsers that support HTML5 new features, resumable upload is supported, and files up to 30GB can be uploaded.
• Conversely, in browsers that do not support HTML5 new features (e.g., IE9), resumable upload is not supported, and the maximum file size is 2GB.

3. Getting Started Guide:

1. First, add a button to the page that calls the plugin:

<input type="button" id="upload" value="上传"></input>

2. Include the POLYV upload plugin JS file:

<script src="//static.polyv.net/file/plug-in-v2/polyv-upload.min.js"></script>

3. Add a script to initialize the upload parameters and create a new upload instance.

var obj = {
    uploadButtton: 'upload',
    userid: data.userid,
    ts: data.ts,
    hash: data.hash,
    sign: data.sign,
    component: 'all',
    cataid: 1499657507273,
    luping: '1',
    extra: {
        keepsource: 1,
    }
};
upload = new PolyvUpload(obj);

Run Online

4. Periodically update parameters like sign: The ts, hash, and sign parameters in the upload configuration have a time limit. You need to update the parameters every 3 minutes. Use the update(data) method to update them. If the upload parameters include the correct requestUrl parameter, the plugin can automatically update the sign and other values internally.

5. Explanation of Upload Parameters: (For more details, please refer to the documentation below.)

• uploadButtton: The ID of the button that opens the upload control.
• userid: You can find your userid in the "Cloud Video" backend -> "Settings" -> "API Interface" page.
• ts: A 13-digit millisecond timestamp.
• hash: The MD5 hash value calculated from the string formed by concatenating ts and writeToken in order.
• sign: The MD5 hash value calculated from the string formed by concatenating secretkey and ts in order.
• component: Set to 'all' to display both the upload list and the video list.
• cataid: The upload directory ID. '1' represents the default category.
• luping: Enables video courseware optimization processing, which improves the clarity of uploaded screen recording videos.
• keepsource: Plays the source file (does not encode the source file). Setting this to 1 means playing the source file.

6. Code Example for Getting User Information (PHP):

/* 
说明：以下的userid、secretkey、writeToken、readToken可以在“云点播”后台->“设置”->“API接口”页面中找到。
*/
$userid = "your userid";
$secretkey = "your sercrety";
$writeToken = "your writeToken";
$readToken = "your readToken";

$ts = time() * 1000;
$hash = md5($ts . $writeToken);
$sign = md5($secretkey . $ts);

4. Usage Documentation

1. Upload Parameters options

2. Methods

1. update(data)

Used to update the ts, hash, and sign information.

2. closeWrap()

Closes the plugin.

3. openWrap()

Opens the plugin.

4. destroy()

Destroys the instance.

5. setParams(Object|String[, value])

Updates optional configuration parameters.

setParams Parameter Description:

• When the first parameter is of type Object, multiple plugin parameters can be updated simultaneously. For example:

upload.setParams({
    cataid: 233333,
    luping: 1,
    defaultTagPlaceholder: '标签文字说明'
});

• When the first parameter is of type String, only a single plugin parameter is updated. The first parameter is the name of the plugin parameter to update, and the value parameter is required. For example:

upload.setParams('cataid', 233333);

setParams Updatable Parameters: component, luping, defaultTagPlaceholder, defaultDescPlaceholder, fileLimit, fileLimitTips, fileNumberLimit, fileNumberLimitTips, width, height, extra

5. Demo Download

Demo Download: POLYV Web Upload Plugin Source Code

6. Version History

v2.1.0

• Added file type validation for uploads.
• Added parameter support for modifying the upload region.
• Added parameter support for limiting the total size of a single batch upload.