Module: VidyardVideo

A vidyard video player component.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name	Type	Description
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`videoOptions`	object	Video options for player type from consumer. See https://knowledge.vidyard.com/hc/en-us/articles/360009879754-Use-query-strings-to-override-player-settings.

ref

object | null

Ref to the component.

Since: 1.2.2
Source: modules/Videos/VidyardVideo/index.js, line 16

Returns:

A vidyard video component.

Type:: JSX.Element

Example

import VidyardVideo from '@gravityforms/components/react/admin/modules/Videos/VidyardVideo';

return (
     <VidyardVideo
         customClasses={ [ 'example-class' ] }
         videoOptions={ { uuid: 'example-id' } }
     />
);

Methods

(inner) controlPlayer(e) → {void}

Listen on document for custom events to either play or pause the player using the vidyard api.

Parameters:

Name	Type	Description
`e`	CustomEvent	The event object.

Since: 1.2.2
Source: modules/Videos/VidyardVideo/index.js, line 63

Returns:

Type:: void