Video browsing - All parameters

In this section we will provide you a reference with all configurations available in the video browsing component.


Attribute NameDescriptionData TypeMandatoryDefault Value

parentObject

API name of the parent object.

String

True, if One to Many


queryObject

API name of the object to query

String

True, if One to One

Video_Junction__c

queryRecordID

Id of the junction record that has to be selected

Id

True, if One to One


selectVideoField

Lookup on the queryObject that references the video

String

False

Chaq_Video__c

videoAuthorField

Field on the queryObject that holds the name to display

String

False


filterByField

API name of the field on the queryObject that should be used for filtering the result

String

True, if One to Many


filterByValue

Value to be filtered on the filterByField field on the queryObject

Id

True, if One to Many


filterByWhereField

Extension of the filterByField / filterByValue, allowing to define more complex or additional conditions to narrow down the result set of queryObjects - Field on the left of the LIKE operatorStringFalse

filterByWhereValue

Extension of the filterBy/filterValue, allowing to define more complex or additional conditions to narrow down the result set of queryObjects - Value on the right of the LIKE operatorStringFalse

primaryColour

Primary colour, in a rgb format

String

False


secondaryColour

Secondary colour, in a rgb format

String

False


tertiaryColour

Tertiary colour, in a rgb format

String

False


hideHeaderHide the header in each video preview card. The header normally contains the author of the video.BooleanFalseFalse
hideFooter

Hide the footer in each video preview card. The footer contains a reference to the questions

BooleanFalseFalse

videoApprovedOrigin

Origin where to push the recording events

String

False
autoPlay

Auto play the first video once it's loaded and available on the page

BooleanFalseFalse
showCallToActionURL

Display the call to action URL once the video has ended

BooleanFalseFalse
disableFullscreenHide the command that enables the full screen togglingBooleanFalseFalse
playsInlinePlays the video / audio inline on a mobile device, without going full screenBooleanFalseFalse
disablePIPHides the picture in picture button on the playerBooleanFalseFalse
videoProfile

Video Profile to add to the video. Empty string to skip this configuration

StringFalse
effectProfile

Effect Profile to add to the video. Empty string to skip this configuration

StringFalse

0 leaves this field empty

-1 defaults to the Org default value

videoMaxHeightMax height of the video playerIntegerFalse350
showAudioTranscriptionAsSubtitleDisplay the audio transcription as subtitlesBooleanFalseFalse
streamWidthDefines the preferred width of the stream for the videoIntegerFalse
showdurationShow / hide the duration of the video, shown before playing itBooleanFalseTrue
enableVaultEnable the Vault actionsBooleanFalseTrue
enableVideoDownloadEnable the downloading of a mediaBooleanFalseFalse
showTranscriptionsShow the transcription of the media in the footer of the player BooleanFalse
hideTitleHide the title of the video on the playerBooleanFalse
videoHeightPreferred height of the video player componentStringFalse"auto" vs "full-height"
tagFilterFilter the list of medias by a selected tagStringFalse
enableBoltListEnable a new generation of video players, bringing a faster, modern and intuitive video player experienceBooleanFalseFalse
enableAnnotationsUsing the new video player and only when the Versioning feature is turned on, our users can also draw visual annotations on videos: circles, rectangles, free hand drawings and text messages are added to a subset of a video, allowing multiple users to work together, exchanging their perspective via annotation commentsBooleanFalseFalse
annotationsCompareActivate the comparison featureBooleanFalseFalse
annotationsAccessLevel

When the annotations are turned on, use this attribute to specify the level of privilege the running user has, in particular:
- "previewer": the user can only see the annotations whilst playing the video, without the navigation on top left
- “readonly”: the user can only browse existing annotations
- “commenter”: as a “readonly” user, plus adding new comments
- “reviewer”: as a “basic” user, plus also creating new annotations
- “manager”: as a reviewer, but also can mark an annotation as “Resolved”

StringFalsereadonly
enableWatermarkEnable the watermarking featureBooleanFalseFalse
watermarkMessageDefine what label the watermark should displayStringFalse$User.Email
watermarkAngleAngle used to display the watermarkIntegerFalse-35
watermarkColourColour used to display the watermarkStringFalsergb(215,218,233)
watermarkSecondaryColourSecondary colour for the watermarkStringFalsergb(0,0,0)
watermarkColourStepsSteps to interpolate the two coloursIntegerFalse
watermarkOpacitySet the opacity of the watermarkIntegerFalse
watermarkFontFamilyFont family used for the watermarkStringFalseHelvetica
watermarkFontSizeFont size used for the watermarkIntegerFalse15
watermarkGapHeightGap factor to space in height the lines of the watermarkDecimalFalse1
watermarkGapWidthGap factor to space in width the lines of the watermarkDecimalFalse1
contextMenuTitleTitle for the context menuStringFalseNativeVideo
contextMenuLinkLink for the context menuStringFalsehttps://www.nativevideo.co
enableTagsDisplay the tags associated to the mediaBooleanFalse