ApsaraVideo VOD:Basic Features

The basic features of the Web Player are implemented through properties or APIs.

The rules for calling APIs are as follows:

var player = new Aliplayer({},function(player) {
    player.setSpeed(2);
 });

This feature jumps to a specific time for playback. It is implemented by the seek API. The following code provides an example:

// time is the specified time in seconds.
player.seek(time)

This feature pauses video playback. It is implemented by the pause API. The following code provides an example:

player.pause()

This feature destroys the player instance. It is implemented by the dispose API. The following code provides an example:

player.dispose()

This feature rotates the video by a specified angle. It is implemented by the setRotate API. After setting the rotation, you can also query the rotation angle. The following code provides an example:

// Set the rotation angle. A positive value for <angle> indicates clockwise rotation, and a negative value indicates counterclockwise rotation. For example, player.setRotate(180) rotates the video 180 degrees clockwise.
player.setRotate(<angle>)
// Get the rotation angle.
player.getRotate()

This feature supports horizontal and vertical mirroring. It is implemented by the setImage API. The following code provides an example:

// Horizontal mirror
player.setImage('horizon')
// Vertical mirror
player.setImage('vertical')

In addition, the Web Player provides the videoHeight and videoWidth properties to set the height and width of the video. The height and width are typically set to values smaller than the container dimensions to prevent the video from overflowing the parent container during rotation and mirroring. The following code provides an example:

 width: '100%', // Container size
 height: '100%', // Container size
 videoHeight:"200px", // Video height

This feature retrieves the current playback time. It is implemented by the getCurrentTime API. The following code provides an example:

// The API returns the time in seconds.
player.getCurrentTime()

This feature retrieves the total duration of the video. You can retrieve the duration only after the video is loaded, which occurs after the play event. It is implemented by the getDuration API. The following code provides an example:

player.getDuration()

This feature monitors the player's status. It is implemented by the getStatus API. The return values include the following:

• init: Initialized.

• ready: Ready.

• loading: Loading.

• play: Play.

• pause: Paused.

• playing: Playing.

• waiting: Waiting for buffer.

• error: Error.

• ended: Ended.

The following code provides an example:

player.getStatus()

Setting the volume includes volume adjustment and muting.

This feature adjusts the volume level. It is implemented by the setVolume API. After setting the volume, you can also retrieve the volume information. The following code provides an example:

// The value of volume is a real number between 0 and 1.
player.setVolume(0)
// Get the volume information.
player.getVolume()

This feature mutes a video that is playing. It is implemented by the mute API. The following code provides an example:

// Mute the video
player.mute();
// Unmute the video
player.unMute();

The default UI of the Web Player SDK includes a playback speed control feature. Viewers can select a playback speed from the interface. If you use a custom UI, you can implement the playback speed control feature using the setSpeed API.

For example:

// The following example sets the playback speed to twice the current speed.
player.setSpeed(2)

This feature allows multi-definition playback by setting the addresses of multiple definition streams.

• If you use the VID+PlayAuth method for playback, no extra settings are required. The Web Player SDK retrieves the definition list from the ApsaraVideo VOD service. Viewers can click the Settings button in the control bar of the playback interface to view the definition list.

  Note

  When using the VID+PlayAuth method, you can set the `format` property in H5 playback mode to select the MP4 or MP3 format. The default format is MP4.

• If you use the URL playback method by setting the source property, you must specify the addresses of multiple definition streams as key-value pairs in the source property's JSON structure. After you apply the settings, viewers can click the Settings button in the control bar of the playback interface to view the definition list.

When using the URL playback method, the key-value pairs in the JSON structure for the `source` property include the following:

   "OD": "<Original Quality URL>"
   "FD": "<Low Definition URL>"
   "LD": "<Standard Definition URL>"
   "SD": "<High Definition URL>"
   "HD": "<Ultra High Definition URL>"
   "2K": "<2K URL>"
   "4K": "<4K URL>"

The following code provides an example of how to set definitions for the URL playback method:

// The example sets the addresses for Ultra High Definition and High Definition.
source:'{"HD":"http://******/player/hdexample.mp4","SD":"http://******/player/sdexample.mp4"}'

The Web Player also supports the `qualitySort` property to sort the definitions in ascending or descending order.

• desc: Sorts in descending order (from highest to lowest).

• asc: Sorts in ascending order (from lowest to highest).