Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ijlyttle/vembedr
Functions to Embed Video in HTML
https://github.com/ijlyttle/vembedr
box embed-videos r rmarkdown shiny vimeo youtube
Last synced: 11 days ago
JSON representation
Functions to Embed Video in HTML
- Host: GitHub
- URL: https://github.com/ijlyttle/vembedr
- Owner: ijlyttle
- License: other
- Created: 2016-05-14T22:29:15.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2021-12-11T21:47:54.000Z (almost 3 years ago)
- Last Synced: 2024-10-12T06:46:17.148Z (26 days ago)
- Topics: box, embed-videos, r, rmarkdown, shiny, vimeo, youtube
- Language: HTML
- Homepage: https://ijlyttle.github.io/vembedr
- Size: 5.72 MB
- Stars: 58
- Watchers: 4
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shiny-extensions - vembedr - Embed videos in R Markdown documents and Shiny apps. (UI Components / Image / Audio / Video)
README
---
output:
github_document
---
# vembedr
[](https://cran.r-project.org/package=vembedr)
[](https://github.com/ijlyttle/vembedr/actions)
```{r, echo = FALSE}
library("htmltools")
library("vembedr")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
The goal of vembedr is to make it a little bit easier for you to embed videos into your **RMarkdown** documents and your **Shiny** apps;
these services are supported:
- YouTube
- Vimeo
- Box
- Microsoft Stream
## New to version 0.1.5
- updated internal implementation to comport with latest Pandoc.
([#52](https://github.com/ijlyttle/vembedr/pull/52), thanks [\@jnolis](https://github.com/jnolis)!)
- deprecated Microsoft Channel 9 (including UserR! 2016 & 2017), as [Channel 9 has been moved](https://docs.microsoft.com/en-us/teamblog/channel9joinedmicrosoftlearn).
([#54](https://github.com/ijlyttle/vembedr/pull/54))
## Installation
You can install the latest released version from CRAN with:
```{r eval=FALSE}
install.packages("vembedr")
```
or the latest development version from GitHub with:
```{r eval=FALSE}
# install.packages("devtools")
devtools::install_github("ijlyttle/vembedr")
```
## Documentation
This project supports two documentation-websites, built using [pkgdown](https://pkgdown.r-lib.org):
- [CRAN version](https://ijlyttle.github.io/vembedr/)
- latest [developent version](https://ijlyttle.github.io/vembedr/dev/) from GitHub
### Usage
The most useful function might be `embed_url()`.
If the URL is from one of the supported services, it will do the right thing:
```r
library("vembedr")
embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs")
```
The video is not embedded in this README file as is rendered to Markdown; to see embedded videos, please see `vignette("vembedr")`. Each of the supported services, e.g. YouTube, is discussed in `vignette("embed")`.
The functions are designed to be piped.
For example, here's how you can modify the appearance and the start time:
```r
embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs") %>%
use_start_time("1m32") %>%
use_align("center")
```
To see these functions in action, see `vignette("modify")`.
### Caveats
- Be aware that, due to licensing issues, not all videos will play when embedded at a different site (like your HTML document).
- The RStudio viewer will embed YouTube and Vimeo videos, but not others.
Videos from all services should be rendered as you expect in a browser like Chrome.
- Some of the formatting, e.g. rounded corners, does not render on mobile sites.
## Code of Conduct
Please note that the vembedr project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.