use_start_time: Specify start time

Description Usage Arguments Details Value Examples

View source: R/use_start_time.R

Description

This function provides you a consistent way to specify the start time, regardless of the service. Please note that Box does not provide a means to specify the start time.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## S3 method for class 'vembedr_embed_box'
use_start_time(embed, ...)

## S3 method for class 'vembedr_embed_channel9'
use_start_time(embed, start_time, is_paused = TRUE, ...)

## S3 method for class 'vembedr_embed_msstream'
use_start_time(embed, start_time, ...)

## S3 method for class 'vembedr_embed_vimeo'
use_start_time(embed, start_time, ...)

## S3 method for class 'vembedr_embed_youtube'
use_start_time(embed, start_time, ...)

use_start_time(embed, ...)

## Default S3 method:
use_start_time(embed, ...)

Arguments

embed

vembedr_embed object, created using an embed() function

...

generic arguments to pass through

start_time

numeric (seconds), or character (e.g. "3m15s")

is_paused

logical, for "Channel 9" specifies if the video should be paused at this time

Details

The start_time argument can take a variety of formats; these inputs all evaluate to the same value:

Please note that for Vimeo, you can specify a start time, but you can not specify that the video be paused at this time. In other words, it is like "autoplay" is set to TRUE, and you cannot unset it.

Value

Object with S3 class vembedr_embed

Examples

1
2

vembedr documentation built on Oct. 23, 2020, 8:26 p.m.