---
title: Video
framework: applenewsformat
role: symbol
role_heading: Object
path: applenewsformat/video
---

# Video

The component for adding a video.

## Declaration

```data
object Video
```

## Properties

role: Always video for this component. URL: The URL of a video file that can be played using AVPlayer. HTTP Live Streaming (HLS) is highly recommended (.M3U8). For more information about HLS, see HTTP Live Streaming, accessibilityCaption: A caption that describes the content of the video file. The text is used for VoiceOver. For more information about VoiceOver, see the Vision page in Accessibility. If you don’t provide accessibilityCaption, VoiceOver uses the caption value. allowsPrerollAds: A Boolean value that determines if the video player displays a preroll advertisement before playback starts. anchor: An object that defines vertical alignment with another component. animation: An object that defines an animation you apply to the component. Use the none value for conditional design elements. Adding it here has no effect. aspectRatio: The aspect ratio of the video: width divided by height. The aspect ratio determines the height of the video player. When this property is omitted, the video player will have a 16:9 aspect ratio (1.777), and videos with ratios other than 16:9 will automatically be letterboxed. behavior: An object that defines behavior for a component, like Parallax or Springy. Use the none value for conditional design elements. Adding it here has no effect. caption: A caption that describes the content of the video file. This text is used by VoiceOver if accessibilityCaption is not provided, or it can be shown when the video cannot be played.  For more information about VoiceOver, see the Vision page in Accessibility. conditional: An instance or array of component properties that you can apply conditionally, and the conditions that cause Apple News Format to apply them. explicitContent: A Boolean value that indicates that the video or its still image may contain explicit content. hidden: A Boolean value that determines whether the component is hidden. identifier: An optional unique identifier for this component. If you use identifier, it must be unique across the entire document. You need an identifier for your component if you want to anchor other components to it. layout: An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that you define at the top level of the document. If you don’t define layout, size and position are based on various factors, such as the device type, the length of the content, and the role of this component. stillURL: The URL of an image file that should be shown when the video has not yet been played. Image URLs can begin with http://, https://, or bundle://. If the image URL begins with bundle://, the image file must be in the same directory as the document. Encode image filenames as URLs. See Preparing Image, Video, Audio, Music, and ARKit Assets. style: An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that you define at the top level of the document. Use the none value for conditional design elements. Adding it here has no effect.

## Mentioned in

Preparing Image, Video, Audio, Music, and ARKit Assets Using HTML with Apple News Format

## Discussion

Discussion Use the video component to add a video to your article by specifying a video URL. Users can control playback and watch the video from inside the article. You can also include an image to display when the video is not playing. To include a video from Dailymotion, Vimeo, or YouTube, use the EmbedWebVideo component instead of the video component. See Preparing Image, Video, Audio, Music, and ARKit Assets. Example {   "components": [     {       "role": "video",       "URL": "https://devstreaming-cdn.apple.com/videos/streaming/examples/bipbop_4x3/bipbop_4x3_variant.m3u8"     }   ] }

## Relationships

### Inherits From

- [Component](applenewsformat/component.md)

## See Also

### Related Documentation

- [Adding a Video](applenews/adding-a-video.md)

### Audio and Video

- [Audio](applenewsformat/audio.md)
- [Music](applenewsformat/music.md)
- [Podcast](applenewsformat/podcast.md)
- [EmbedWebVideo](applenewsformat/embedwebvideo.md)