Skip to content

Commit

Permalink
Docs--update-video-mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviaflory authored and kennylam committed Dec 7, 2023
1 parent b8e4a42 commit 5c784ec
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/pages/components/video.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Video
description: The Video component allows you to embed Kaltura videos from the media center in various ways throughout a page.
description: Video allows you to embed videos from Media Center throughout a page, using the IBM standard video player, Kaltura.
---

import ComponentDescription from 'components/ComponentDescription';
Expand All @@ -11,19 +11,18 @@ import ResourceLinks from 'components/ResourceLinks';

<AnchorLinks>

<AnchorLink>Resources</AnchorLink>
<AnchorLink>Overview</AnchorLink>
<AnchorLink>Resources</AnchorLink>
<AnchorLink>Content guidance</AnchorLink>
<AnchorLink>Feedback</AnchorLink>

</AnchorLinks>

<ResourceLinks name="Video" type="ui" />

## Overview

The video component defaults to the aspect ratio of the source video, or one of the standard aspect ratios specified
below can be used instead. In most cases 16x9 is recommended.
in the [content guidance](#content-guidance) table can be used instead. In most cases, 16:9 is recommended.

By default, the component is prefilled with content returned from the Kaltura service. You can override this default
content and provide a custom video title, description, and poster image. If the content is optional for the component
Expand All @@ -45,6 +44,8 @@ The latter is recommended for a more immersive viewing experience.

<Caption>Example of a video inside lightbox media viewer</Caption>

<ResourceLinks name="Video" type="ui" />

## Content guidance

| Element | Content type | Required | Instances | Character limit <br/>(English / translated) | Notes |
Expand All @@ -53,7 +54,7 @@ The latter is recommended for a more immersive viewing experience.
| Video title | Text | No | 1 | 65 / 85 | Optional overide of default title appears as caption under poster image. Video duration appended to title. |
| Video description | Text | No | 1 | 200 / 260 | Default populates but can be overridden. Only appears in [Lightbox media viewer](./lightbox-media-viewer). |
| Play mode | Option list | No | 1 || In-line (default), lightbox. |
| Aspect ratio | Option list | No | 1 || Default is 16x9. Other ratios are 9x16, 2x1, 1x2, 4x3, 3x4, 1x1. |
| Aspect ratio | Option list | No | 1 || Default is 16:9. Other ratios are 9:16, 2:1, 1:2, 4:3, 3:4, 1:1. |
| Poster image | [Image](https://www.ibm.com/standards/carbon/components/images) | No | 1 || Default to poster image from video source. Optional overide. |

For more information, see the [character count standards](https://www.ibm.com/standards/carbon/guidelines/content#character-count-standards).
Expand Down

0 comments on commit 5c784ec

Please sign in to comment.