Skip to content

Commit

Permalink
Update CldVideoPlayer.md Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcos-Bernasconi authored Oct 11, 2024
1 parent 821e91e commit 58c6099
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/content/2.components/CldVideoPlayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ Adding a button to select chapters (you can pass `chapters` prop as a boolean if

| Prop Name | Type | Default | Description | Example |
| ---------------------- | -------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| autoPlay | string | `"never"` | When, if, should the video automatically play. See `autoplayMode` in [Video Player docs](https://cloudinary.com/documentation/video_player_api_reference#constructor_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) | `"on-scroll"` |
| autoPlay | boolean | `false` | Make the video automatically play | `true` |
| autoplayMode | string | `"always"` | When, if, should the video automatically play. See `autoplayMode` in [Video Player docs](https://cloudinary.com/documentation/video_player_api_reference#constructor_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) | `"on-scroll"` |
| className | string | - | Additional class names added to the video container | `"my-video-player"` |
| colors | object | See below | Player chrome colors | See Colors Below |
| controls | boolean | `true` | Show player controls | `true` |
Expand All @@ -127,6 +128,7 @@ Adding a button to select chapters (you can pass `chapters` prop as a boolean if
| onPause | Function | - | Triggered on video pause | See Events Below |
| onPlay | Function | - | Triggered on video play | See Events Below |
| onEnded | Function | - | Triggered when video has ended play | See Events Below |
| playsinline | boolean | `false` | Can be used with autoplay and muted to enable autoplay on iOS devices | `true`
| playerRef | Ref | - | React ref to access Player instance | See Refs Below |
| showLogo | boolean | `true` | Show the Cloudinary logo on Player | `false` |
| src | string | - | **Required**: Video public ID | `"videos/my-video"` |
Expand Down

0 comments on commit 58c6099

Please # to comment.