VideoComponent
Defined in: parser/types.ts:861
The VideoComponent interface is used to define the properties of a video component. This component is used to render a video with optional controls.
Most often, video components will be used for trainings, and will have a forceCompletion field set to true. This will prevent the participant from moving on until the video has finished playing.
As such, the forceCompletion field is set to true by default, and the withTimeline field is set to false by default.
For example, to render a training video with a path of <study-name>/assets/video.mp4, you would use the following snippet:
{
"type": "video",
"path": "<study-name>/assets/video.mp4",
}
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
allowFailedTraining? | boolean | Controls whether the component should allow failed training. If not provided, the default is true. | BaseIndividualComponent.allowFailedTraining | parser/types.ts:576 |
correctAnswer? | Answer[] | The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess. | BaseIndividualComponent.correctAnswer | parser/types.ts:570 |
description? | string | The description of the component. This is used to identify and provide additional information for the component in the admin panel. | BaseIndividualComponent.description | parser/types.ts:580 |
forceCompletion? | boolean | Whether to force the video to play until the end. Defaults to true. | - | parser/types.ts:866 |
helpTextPathOverride? | string | Optional override for the help text. If present, will override the default help text path set in the uiConfig. | BaseIndividualComponent.helpTextPathOverride | parser/types.ts:592 |
instruction? | string | The instruction of the component. This is used to identify and provide additional information for the component in the admin panel. | BaseIndividualComponent.instruction | parser/types.ts:582 |
instructionLocation? | ConfigResponseBlockLocation | The location of the instructions. | BaseIndividualComponent.instructionLocation | parser/types.ts:568 |
meta? | Record<string, unknown> | The meta data for the component. This is used to identify and provide additional information for the component in the admin panel. | BaseIndividualComponent.meta | parser/types.ts:578 |
nextButtonDisableTime? | number | A timeout (in ms) after which the next button will be disabled. | BaseIndividualComponent.nextButtonDisableTime | parser/types.ts:586 |
nextButtonEnableTime? | number | A timer (in ms) after which the next button will be enabled. | BaseIndividualComponent.nextButtonEnableTime | parser/types.ts:588 |
nextButtonLocation? | ConfigResponseBlockLocation | The location of the next button. | BaseIndividualComponent.nextButtonLocation | parser/types.ts:566 |
nextButtonText? | string | The text that is displayed on the next button. | BaseIndividualComponent.nextButtonText | parser/types.ts:564 |
path | string | The path to the video. This could be a relative path from the public folder or might be a url to an external website. | - | parser/types.ts:864 |
provideFeedback? | boolean | Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false. | BaseIndividualComponent.provideFeedback | parser/types.ts:572 |
recordAudio? | boolean | Whether or not to record audio for a component. Only relevant if recordStudyAudio in the uiConfig is true. Defaults to false. | BaseIndividualComponent.recordAudio | parser/types.ts:584 |
response | Response[] | The responses to the component | BaseIndividualComponent.response | parser/types.ts:560 |
responseDividers? | boolean | Whether to show the response dividers. Defaults to false. | BaseIndividualComponent.responseDividers | parser/types.ts:590 |
trainingAttempts? | number | The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user. | BaseIndividualComponent.trainingAttempts | parser/types.ts:574 |
type | "video" | - | - | parser/types.ts:862 |
withTimeline? | boolean | Whether to show the video timeline. Defaults to false. | - | parser/types.ts:868 |