Sign in

v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB
Video settings templates

List video settings templates

Lists video settings templates available to your organization.

get/video_settings_templates

Query parameters

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

Response

OK

idinteger
slugstring

Unique identifier for the object

namestring
logo_image_urlstring uri nullable

The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.

logo_image_position'top-left' | 'top-right'

The position of the logo that appears in the corner of the video.

background_colorstring

The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)

text_transform'none' | 'uppercase' | 'lowercase' | 'titlecase'

Text transformation to apply to captions

text_background_colorstring

The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)

text_background_radiusnumber

Border radius of the text background

text_colorstring

The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)

text_secondary_colorstring nullable

Color of the text captions to show on every other scene (CSS color format)

text_highlight_colorstring nullable

The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)

text_highlight_secondary_colorstring nullable

Color of highlighted text to show on every other scene. Supports CSS colors including linear-gradient(to right, ...)

text_highlight_background_colorstring

Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))

text_highlight_secondary_background_colorstring nullable

Color of the background behind the highlighted text to show on every other scene (CSS color format, supports linear-gradient(to right, ...))

text_highlight_background_radiusnumber

Border radius of the highlight text background

text_shadowstring

Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))

text_highlight_shadowstring nullable

Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))

text_strokestring

Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

text_highlight_strokestring nullable

Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

text_fontsstring[]

A list of fonts to use. Fonts will be prioritized automatically based on glyph coverage for the text. The default fonts are built-in, but you can include remote URLs to custom fonts in .ttf or .otf format.

text_font_sizeinteger

Font size for text captions (30-90).

text_widthnumber

Maximum width of text as a ratio of the frame width.

text_linesinteger nullable

The maximum number of lines of text to show at once. Must be between 1 and 5. If not specified, text_lines will default to landscape=4, square=5, portrait=5.

text_wordsinteger nullable

Maximum number of words to show per line

text_horizontal_align'start' | 'center' | 'end'

The horizontal alignment of text lines, either 'start', 'center', or 'end'. A value of 'start' aligns the text to the left for left-to-right languages, right otherwise. A value of 'end' aligns the text to the right for left-to-right languages, left otherwise.

text_vertical_align'start' | 'center' | 'end'

The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).

text_horizontal_offsetnumber

The horizontal offset of text relative to the frame width, between -1.0 and 1.0

text_vertical_offsetnumber

The vertical offset of text relative to the frame height, between -1.0 and 1.0

text_animation'classic' | 'reveal' | 'karaoke' | 'pop'

The text animation to show

entrance_animation'none' | 'fade' | 'zoom-in' | 'zoom-out' | 'slide-up' | 'slide-down' | 'slide-left' | 'slide-right' | 'pop'

The entrance animation for image and video segments

exit_animation'none' | 'fade' | 'zoom-in' | 'zoom-out' | 'slide-up' | 'slide-down' | 'slide-left' | 'slide-right' | 'pop'

The exit animation for image and video segments

waveform_colorstring

The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)

content_image_enabledboolean

When true, uses the content's featured image as video background

image_extraction_enabledboolean

When true, automatically extracts images from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.

pan_and_zoom_enabledboolean

When true, applies pan and zoom effects to background images

audio_and_waveform_enabledboolean

When true, video includes audio and animated waveform visualization

text_captions_enabledboolean

When true, displays text captions overlaid on the video

playback_mode'cycle' | 'space-evenly' | 'follow-article'

The playback mode for images in the video. There are three available options. A value of 'cycle' will cycle through images, potentially repeating them according to cycle_time. A value of 'space-evenly' will space images evenly throughout the video without repeating them. A value of 'follow-article' will show images at the point when they appear in the article. Note that 'follow-article' is not applicable for summaries which have different text.

cycle_timeinteger

The time in milliseconds to show each image when playback_mode is set to 'cycle'.

preview_urlstring nullable