ApsaraVideo Player

Chart style

ApsaraVideo Player is a media component that allows you to customize the URL of a video. You can add a video player to a visual application to play your video.

Settings

• Search Configuration: Click Search Configuration in the upper-right corner of the Configuration panel. In the Search Configuration panel, enter the name of the configuration items that you want to search for to quickly locate the configuration items. Fuzzy match is supported. For more information, see Search for asset configurations.

• Size: indicates the size of a widget, including its pixel width and height. You can click the icon to lock the aspect ratio of the widget and modify the width and height of the widget in equal proportion. Click again to unlock. The aspect ratio is not limited after unlocking.

• Position: the position of a widget, which is indicated by pixel X and Y coordinates. X-coordinate indicates the pixel distance between the upper-left corner of the widget and the left border of the canvas. Y-coordinate indicates the pixel distance between the upper-left corner of the widget and the upper border of the canvas.

• Rotation Angle: the angle of a rotation that uses the center point of a widget as the rotation point. The unit is degrees (°). You can use one of the following methods to control the rotation angle of a widget:

  • Directly enter the degrees in the Rotation Angle spin box or click the plus sign (+) or minus sign (-) to increase or decrease the value in the Rotation Angle spin box.

  • Drag the black dot in the icon to control the rotation angle of the widget.

  • Click the icon to flip the widget style.

  • Click the icon to flip the widget style.

• Opacity: Valid values: 0 to 1. If this parameter is set to 0, the widget is hidden. If this parameter is set to 1, the widget is completely displayed. Default value: 1.

• Playback Mode: the playback mode of the video stream. You can select H5 or Flash.

  Important

  The Flash mode in the chrome browser has stopped updating, and the video link in RTMP format cannot be used normally.

• Video Link: the URL of the video stream. You can also configure the URL on the Data tab. You can also configure the URL on the Data tab.

  Note

  MP4, FLV, M3U8, and RTMP are supported.

• Cover Image: the content of the video cover image. To use an image on a remote server, enter the URL of the image in the upper-right corner. Click Preview in the image box to preview the image format. Click Change in the dashed box below the image box. For more information about how to change the image design asset, see Use the interface.

• Playback Settings: Turn on the switch to configure automatic playback and loop playback for the video.

• Live Streaming: If you turn on the switch, you can use a live stream to play the live stream. This feature is available only when you set Playback Mode to H5.

• Volume Settings: If you turn on the switch, you can mute the video playback. If you turn off the switch, you can set the volume in %. Configurable only when H5 is selected for playback mode.

• Control Bar Settings: Set the trigger mode of the control bar, including Hover and Tap. You can configure this only when you select H5 for Playback Mode.

• Full: If you turn on the switch, the video is stretched to fit the size of the content frame when the aspect ratio of the video does not match the size of the content frame.

Data panel

source: the URL of the video stream. This function is the same as that of the configuration items of the video link in the configuration panel. If you configure both parameters, this parameter takes effect in priority.

Interaction tab

This widget does not support interaction events.

Configure interactions in Blueprint Editor

1. In Canvas Editor, right-click a widget in the Layer panel and select Add to Blueprint Editor.

2. Click the icon in the upper-left corner.

3. In the blueprint editor, click Alibaba Cloud Streaming Player in the Added Nodes pane. On the canvas, you can view the parameters in the blueprint editor, as shown in the following figure.

   • Events

     Events	Description
     When the interface description request is completed	The event is triggered with the processed JSON data after a data interface request is responded and processed by a filter. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.
     When the interface description request fails	The event that is returned when a data interface request fails (such as network problems or interface errors) and is processed by the filter. The event also throws the processed JSON data. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.

   • Action

     Action	Description
     Request API Description	This action is performed to request the server data again. The data sent by an upstream data processing node or layer node is used as a parameter. For example, if ApsaraVideo Streaming Player sets the API data source to https://api.test and the data passed to the Request API Description action to { id: '1'}, the final request interface is https://api.test?id=1.
     Import Interface Description	After data of a widget is processed in accordance with its drawing format, the widget is imported for redrawing. You do not need to request server data again. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.
     Start the playback	This action starts to play the video and does not need parameter input.
     Pause the playback	This action pauses the video playback and does not need parameter input.
     End playback	This action stops the video playback and does not need parameter input.
     Update component configurations	Style configurations of widgets are dynamically updated. Before this action is executed, you must click the widget in Canvas Editor, click the Settings tab in the right-side panel, and click Copy Configurations to... to obtain widget configurations. After that, change the style field for the data processing node in Blueprint Editor.
     Display	Displays the widget. The following example shows the reference data. return { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" };
     Hide	The following example shows how to hide a widget. return { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" };
     Switch to the implicit state	Specifies whether to show or hide a widget. The following example shows the reference data. return { "animationIn": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }, "animationOut": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" } };
     China Mobile	Move a widget to a specified location. The following example shows the reference data. return { // The positioning type. to indicates absolute positioning, whereas by indicates relative positioning. The default value is to. "positionType": "to", // The location, which is indicated by the x and y coordinates. "attr": { "x": 0, "y": 0 }, // The animation type. "animation": { "enable": false, // The duration in which animation is displayed. "animationDuration": 1000, // The animation curve, which can be set to linear|easeInOutQuad|easeInOutExpo. "animationEasing": "linear" } };