hml/media/video.json

{
  "name": "video",
  "version": [
    {
      "name": "v3.0"
    }
  ],
  "syscap": [
    "SystemCapability.ArkUI.ArkUI.Full"
  ],
  "description": [
    {
      "name": "The <video> component provides a video player."
    }
  ],
  "attributes": [
    {
      "name": "muted",
      "required": false,
      "description": [
        {
          "name": "Whether a video is muted."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "src",
      "required": false,
      "description": [
        {
          "name": "URI of the video content to play."
        }
      ],
      "type": "string"
    },
    {
      "name": "autoplay",
      "required": false,
      "description": [
        {
          "name": "Whether a video is played automatically after being rendered."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "poster",
      "required": false,
      "description": [
        {
          "name": "Preview poster of a video."
        }
      ],
      "type": "string"
    },
    {
      "name": "loop",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "required": false,
      "description": [
        {
          "name": "Whether the video play from the beginning."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "controls",
      "required": false,
      "description": [
        {
          "name": "Whether the control bar is displayed during video playback. If the value is set to false, the control bar is not displayed. The default value is true, and the platform can either show or hide the control bar."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "starttime",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "required": false,
      "description": [
        {
          "name": "Where the video starts playing."
        }
      ],
      "type": "number"
    },
    {
      "name": "direction",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "required": false,
      "description": [
        {
          "name": "Controls the layout mode of the Video component in full-screen mode. Set this parameter tovertical. Set this parameter tohorizontal. Set this parameter to auto. In full-screen mode, the video is displayed in landscape or portrait mode based on the width and height. If this parameter is set to adapt, the video is displayed in landscape or portrait mode based on the device direction."
        }
      ],
      "type": "string"
    },
    {
      "name": "speed",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "required": false,
      "description": [
        {
          "name": "Controls the video playback speed. A larger value indicates a faster video playback speed.The value ranges from 0.1 to 20.0. The precision is float."
        }
      ],
      "type": "number"
    },
    {
      "name": "id",
      "required": false,
      "description": [
        {
          "name": "Unique ID of a component."
        }
      ],
      "type": "string"
    },
    {
      "name": "style",
      "required": false,
      "description": [
        {
          "name": "Style declaration of a component."
        }
      ],
      "type": "string"
    },
    {
      "name": "class",
      "required": false,
      "description": [
        {
          "name": "Style class of a component, which is used to refer to a style table."
        }
      ],
      "type": "string"
    },
    {
      "name": "ref",
      "required": false,
      "description": [
        {
          "name": "Used to register reference information for elements or child components. The reference information is registered with the parent component on $refs."
        }
      ],
      "type": "string"
    },
    {
      "name": "disabled",
      "required": false,
      "description": [
        {
          "name": "Whether the component is disabled. If the component is disabled, the component cannot respond to user interaction."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "focusable",
      "required": false,
      "description": [
        {
          "name": "Whether the component can gain the focus. When focusable is set to true, the component can gain the focus if there is a focusable child component. If this attribute is set to false, the component and its child components cannot gain the focus."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "data-*",
      "required": false,
      "description": [
        {
          "name": "Attribute set for components to facilitate data storage and reading."
        }
      ],
      "type": "string"
    },
    {
      "name": "voicelabel",
      "required": false,
      "description": [
        {
          "name": "Voice label. When a voice label is triggered, the click event of the component is triggered. NOTE: The voice label takes effect only when the click event is set."
        }
      ],
      "type": "string"
    },
    {
      "name": "subscriptflag",
      "required": false,
      "description": [
        {
          "name": "Voice subscript switch. Available values are as follows: auto: For the <image> and <list-item> components, if subscriptflag is set to auto, the voice subscript is turned on. For other components, if subscriptflag is set to auto, the voice subscript is turned off. on: Turn on the voice subscript. off: Turn off the voice subscript. If no customized subscript is set, the subscript is automatically accumulated from 1. NOTE The voice subscript takes effect only when the click event is set."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "auto"
        },
        {
          "name": "on"
        },
        {
          "name": "off"
        }
      ]
    },
    {
      "name": "subscriptlabel",
      "required": false,
      "description": [
        {
          "name": "Custom subscript. After it is set, the subscript is displayed in the way you specified. To make this attribute take effect, you need to turn on the voice subscript."
        }
      ],
      "type": "string"
    },
    {
      "name": "scenelabel",
      "required": false,
      "description": [
        {
          "name": "Available values are as follows: video: Video scenario. For example, to watch a video, a user can say the voiceLabel (usually the video name), play voiceLabel, see voiceLabel, or watch voiceLabel, etc. audio: Music scenario. For example, to listen to a song, a user can say the voiceLabel (usually the song name), play voiceLabel, or listen voiceLabel, etc. page: Page scenario. For example, to go to a page, a user can say the voiceLabel (usually the page name), switch to voiceLabel, go to voiceLabel, or jump to voiceLabel, etc. switch: Switch scenario. For example, to turn on or turn off a switch, a user can say the voiceLabel (usually the switch name), turn on voiceLabel, open voiceLabel, turn off voiceLabel, close voiceLabel, etc. common: Common scenario, which is triggered by the voiceLabel."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "video"
        },
        {
          "name": "audio"
        },
        {
          "name": "page"
        },
        {
          "name": "switch"
        },
        {
          "name": "common"
        }
      ]
    },
    {
      "name": "accessibilitygroup",
      "required": false,
      "description": [
        {
          "name": "Accessibility group. If this attribute is set to true, the component and all its child components form an entire selectable component, and the accessibility service will no longer available for the content of its child components."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "accessibilitytext",
      "required": false,
      "description": [
        {
          "name": "Accessibility text. If a component does not contain text information, it will not be read when the component is selected by the screen reader. In this case, the screen reader user cannot know which component is selected. To solve this problem, you can set this attribute for components without text information. When the component is selected by the screen reader, the specified accessibility text will be read, informing the user which component is selected. If a component with this attribute set contains text information, only the accessibility text will be read."
        }
      ],
      "type": "string"
    },
    {
      "name": "accessibilitydescription",
      "required": false,
      "description": [
        {
          "name": "Accessibility description. You can specify further explanation of the current component, for example, possible operation consequences, especially those cannot be learned from component attributes and accessibility text. You can set a detailed description text for the attribute of the component to help users understand the operation to be performed. If a component contains both text information and the accessibility description, the text is read first and then the accessibility description, when the component is selected."
        }
      ],
      "type": "string"
    },
    {
      "name": "accessibilityimportance",
      "required": false,
      "description": [
        {
          "name": "Accessibility importance, which is used to decide whether a component can be identified by the accessibility service. The value can be auto, yes, no, or no-hide-descendants. The last value forces the screen reader to ignore the current component and all its subcomponents. yes: The current component is selectable for the accessibility service. no: The current component is not selectable for the accessibility service."
        }
      ],
      "type": "string"
    },
    {
      "name": "for",
      "required": false,
      "description": [
        {
          "name": "Expands the current element based on the configured data list."
        }
      ],
      "type": "string"
    },
    {
      "name": "tid",
      "required": false,
      "description": [
        {
          "name": "The tid attribute is used to accelerate the for loop. It is used to improve the re-rendering efficiency when data in a loop changes. The tid attribute specifies the unique ID of each element in the array. If it is not specified, the index of each element in the array is used as the ID. For example, tid='id' indicates that the id attribute of each element is its unique identifier."
        }
      ],
      "type": "string"
    },
    {
      "name": "if",
      "required": false,
      "description": [
        {
          "name": "Whether the element is added or removed."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "elif",
      "required": false,
      "description": [],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "else",
      "required": false,
      "description": [],
      "type": "string"
    },
    {
      "name": "show",
      "required": false,
      "description": [
        {
          "name": "Whether the element is displayed or hidden."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    }
  ],
  "events": [
    {
      "name": "drag",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The duration of drag.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragstart",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag starts.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragend",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag ends.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragenter",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag enters.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragover",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag overs.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragleave",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag leaves.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "drop",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag drops.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "prepared",
      "description": [
        {
          "name": "Triggered when a video preparation is complete."
        }
      ]
    },
    {
      "name": "start",
      "description": [
        {
          "name": "Triggered when a video is played."
        }
      ]
    },
    {
      "name": "pause",
      "description": [
        {
          "name": "Triggered when a video is paused."
        }
      ]
    },
    {
      "name": "finish",
      "description": [
        {
          "name": "Triggered when the video finishes playing."
        }
      ]
    },
    {
      "name": "error",
      "description": [
        {
          "name": "Triggered when the playback fails."
        }
      ]
    },
    {
      "name": "seeking",
      "description": [
        {
          "name": "Triggered to report time information when the progress bar is being dragged."
        }
      ]
    },
    {
      "name": "seeked",
      "description": [
        {
          "name": "Triggered to report playback time information when the user finishes dragging the progress bar."
        }
      ]
    },
    {
      "name": "timeupdate",
      "description": [
        {
          "name": "Triggered once per 250 ms when the playing progress changes."
        }
      ]
    },
    {
      "name": "stop",
      "description": [
        {
          "name": "This event is triggered when a request is made to stop playing a video. The stop event is not triggered when the finish event is triggered."
        }
      ]
    },
    {
      "name": "fullscreenchange",
      "description": [
        {
          "name": "Triggered when a video enters or exits the full screen mode."
        }
      ]
    },
    {
      "name": "touchstart",
      "description": [
        {
          "name": "Triggered when the tapping starts."
        }
      ]
    },
    {
      "name": "touchmove",
      "description": [
        {
          "name": "Triggered when the tapping moves."
        }
      ]
    },
    {
      "name": "touchcancel",
      "description": [
        {
          "name": "Triggered when the tapping is interrupted."
        }
      ]
    },
    {
      "name": "touchend",
      "description": [
        {
          "name": "Triggered when the tapping ends."
        }
      ]
    },
    {
      "name": "focus",
      "description": [
        {
          "name": "Triggered when the component gains focus. The <span> component cannot gain focus."
        }
      ]
    },
    {
      "name": "key",
      "description": [
        {
          "name": "The key event is specific to smart TVs and is triggered when a user presses a key on the remote control. If the return value is true, the page processes the key event; If the return value is false, the default key event processing logic is used; If no value is returned, false is used as the return value."
        }
      ]
    },
    {
      "name": "swipe",
      "description": [
        {
          "name": "Triggered when a user quickly slides on a component."
        }
      ]
    },
    {
      "name": "accessibility",
      "description": [
        {
          "name": "Event dispatched by the accessibility service."
        }
      ]
    },
    {
      "name": "click",
      "description": [
        {
          "name": "Triggered when a component is clicked."
        }
      ]
    },
    {
      "name": "longpress",
      "description": [
        {
          "name": "Triggered when a component is long pressed."
        }
      ]
    },
    {
      "name": "doubleclick",
      "description": [
        {
          "name": "Triggered when a component is double clicked."
        }
      ]
    },
    {
      "name": "pinchstart",
      "description": [
        {
          "name": "Triggered when the pinch starts."
        }
      ]
    },
    {
      "name": "pinchupdate",
      "description": [
        {
          "name": "Triggered when the pinch updates."
        }
      ]
    },
    {
      "name": "pinchend",
      "description": [
        {
          "name": "Triggered when the pinch ends."
        }
      ]
    },
    {
      "name": "pinchcancel",
      "description": [
        {
          "name": "Triggered when the pinch is interrupted."
        }
      ]
    },
    {
      "name": "blur",
      "description": [
        {
          "name": "Triggered when the component loses focus. The <span> component cannot lose focus."
        }
      ]
    },
    {
      "name": "attached",
      "description": [
        {
          "name": "The event will be called when the render node is attached on the tree."
        }
      ]
    },
    {
      "name": "detached",
      "description": [
        {
          "name": "The event will be called when the render node is detached on the tree."
        }
      ]
    }
  ],
  "supportedSubComponents": false,
  "supportedSubComponentsRestriction": [],
  "unSupportSubComponentsRestriction": [],
  "parentComponentsRestriction": []
}