Apsara Video SDK:Extension components

Built-in components

Last played position component

This component allows you to resume playback from the last played position. If you set the autoPlay parameter to false, you are notified of the last played position. You can click on the progress bar to seek to the playback position. If you set the autoPlay parameter to true, the video is automatically played from the last played position. For more information, see MemoryPlayComponent.

Animated watermark (Marquee component)

This component is used to add a text watermark that contains user information such as the user ID to videos. This helps reduce copyright infringements. You can specify the watermark location and the color and size of the text. For more information, see BulletScreenComponent.

Start ad component

This component is used to display an image ad before video playback starts. For more information, see StartADComponent.

Pause ad component

This component is used to display an image ad when video playback is paused. For more information, see PauseADComponent.

Video ad sequence component

This component is used to play multiple video ads before video playback starts. For more information, see ManyVideoADComponent.

Play next component

This component adds the Play Next button to the control bar of the player. You can customize a click event for the button and pass the click event as a component parameter. For more information, see PlayerNextComponent.

Playlist component

This component adds the buttons for displaying the playlist and switching among videos to the control bar of the player and displays a playlist in the player. For more information, see PlaylistComponent.

Rotation and mirroring component

This component adds the buttons for rotating and mirroring a video to the control bar of the player. For more information, see RotateMirrorComponent.

Video ad component

The video ad component plays a video ad before video playback starts. For more information, see VideoADComponent.

Live comment component

This component adds a text input box and the buttons for enabling, disabling, and sending live comments to the control bar of the player. For more information, see AliplayerDanmuComponent.

Preview component

This component allows you to preview a video for a period of time. After the preview ends, this component notifies you of the conditions that need to be met to play the entire video. For more information, see PreviewVodComponent.

Progress marker component

This component marks the key points of a video. When you move the pointer over a marked key point, the specified image is displayed. For more information, see ProgressComponent.

Subtitle component

This component allows you to switch subtitles in different languages. For more information, see CaptionComponent.

Audio track component

This component is used to switch audio tracks. For more information, see TrackComponent.

Add components

1. Add the components to ApsaraVideo Player SDK for web.

   <script type="text/javascript"charset="utf-8"src="/aliplayercomponents-1.0.9.min.js"></script>

   Note

   Alibaba Cloud CDN resources are not included in ApsaraVideo Player SDK for web. If you want to use CDN resources, add them after you download them to your local PC. To download the JS files, access the AliyunPlayer_Web page.

2. Mount the components to ApsaraVideo Player SDK for web.

   Note

   The following sample code is only for your reference. Configurations vary based on different types of components.

   var player = new Aliplayer({
    id: "player-con",
    source: "//player.alicdn.com/video/editor.mp4",
    components: [{
    name: 'xxxComponent',
    type: AliPlayerComponent.xxxComponent
    }]
    }, function (player) {
    });

Manage components

If you need to use only one component, add a reference to the JS file of the component in your project. To use a component in the ApsaraVideo Player component library, call AliPlayerComponent.XXX to add the component to your player.

Package components

"build_customize": set NODE_ENV=production&&webpack --config webpack.config.customize.js --progress

• Package all components

  You can run one of the following commands to package all components for ApsaraVideo Player SDK for web. The component package is stored in /disk/aliplayer-components/aliplayercomponents.min.js.

  $ npm run build
  # Or:
  $ npm run build all

• Package specific components

  To reduce the size of the component package, run the following command to add only the components that you need to the package:

  $ npm run build componentsName # componentsName specifies the component name.

  Note

  componentsName specifies the component name. Separate multiple component names with spaces. For example, to package the live comment component and marquee component, run the $ npm run build AliplayerDanmu BulletScreen command. Valid values for componentsName:

  • AliplayerDanmu: the live comment component.

  • BulletScreen: the marquee component.

  • MemoryPlay: the last played position component.

  • PauseAD: the pause ad component.

  • PlayerNext: the play next component.

  • Playlist: the playlist component.

  • Preview: the preview component.

  • RotateMirror: the rotation and mirroring component.

  • StartAD: the start ad component.

  • Staticad: the pause ad component.

  • VideoAD: the video ad component.

  • Caption: the subtitle component.

  • Track: the audio track component.

  • ManyVideoAD: the video ad sequence component.

  • RateComponent: the playback speed component.

  The component package aliplayercomponents.min.js is stored in /disk/aliplayer-components. Add a reference to the file in your project to use the components.

Add a specific component

• Add a reference to a specific .js file in your HTML file

  <script type="text/javascript" src="js/staticAdComponent.min.js"></script>
   

• Add the component to the player

  var option = {
   id: "J_prismPlayer",
   autoplay: true,
   isLive:false,
   playsinline:true,
   width:"100%",
   height:"100%",
   useH5Prism:true, // Enable the HTML5 player.
   useFlashPrism:false,
   source:source,
   vid:vid,
   playauth:playauth,
   cover:"",
   components:[{type:StaticAdComponent,args:['http://cdnoss.example.com/cover****.png',
   'http://player.alicdn.com']}]
  };
  
  var player = new Aliplayer(option);
   

Add the ApsaraVideo Player component library

• Add a reference to a specific .js file in your HTML file

  <script type="text/javascript" src="js/aliplayerComponents.min.js"></script>

• Add the component to the player

  Parameter	Description
  name	The name of the component. The player obtains the component by the component name.
  type	The type of the component.
  args	The parameters of the component.

  var option = {
   id: "J_prismPlayer",
   autoplay: true,
   isLive:false,
   playsinline:true,
   width:"100%",
   height:"100%",
   useH5Prism:true, // Enable the HTML5 player.
   useFlashPrism:false,
   source:source,
   vid:vid,
   playauth:playauth,
   cover:"",
   components:[{type:AliPlayerComponent.StaticAdComponent,args:['http://cdnoss.youkouyang.com/cover.png',
   'http://player.alicdn.com']},
   notParameComponent,
   {name:'adComponent1',type:notParameComponent}
   ]
  };
  
  var player = new Aliplayer(option);
   

Obtain a component

Call the getComponent method and set the name parameter to obtain a component.

var component = player.getComponent('adComponent');

Add dependencies

$ cd customComponents
$ npm install