Video browsing - All parameters
In this section we will provide you a reference with all configurations available in the video browsing component.
Attribute Name | Description | Data Type | Mandatory | Default 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 operator | String | False | |
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 operator | String | False | |
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 | |
hideHeader | Hide the header in each video preview card. The header normally contains the author of the video. | Boolean | False | False |
hideFooter | Hide the footer in each video preview card. The footer contains a reference to the questions | Boolean | False | False |
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 | Boolean | False | False |
showCallToActionURL | Display the call to action URL once the video has ended | Boolean | False | False |
disableFullscreen | Hide the command that enables the full screen toggling | Boolean | False | False |
playsInline | Plays the video / audio inline on a mobile device, without going full screen | Boolean | False | False |
disablePIP | Hides the picture in picture button on the player | Boolean | False | False |
videoProfile | Video Profile to add to the video. Empty string to skip this configuration | String | False | |
effectProfile | Effect Profile to add to the video. Empty string to skip this configuration | String | False | 0 leaves this field empty -1 defaults to the Org default value |
videoMaxHeight | Max height of the video player | Integer | False | 350 |
showAudioTranscriptionAsSubtitle | Display the audio transcription as subtitles | Boolean | False | False |
streamWidth | Defines the preferred width of the stream for the video | Integer | False | |
showduration | Show / hide the duration of the video, shown before playing it | Boolean | False | True |
enableVault | Enable the Vault actions | Boolean | False | True |
enableVideoDownload | Enable the downloading of a media | Boolean | False | False |
showTranscriptions | Show the transcription of the media in the footer of the player | Boolean | False | |
hideTitle | Hide the title of the video on the player | Boolean | False | |
videoHeight | Preferred height of the video player component | String | False | "auto" vs "full-height" |
tagFilter | Filter the list of medias by a selected tag | String | False | |
enableBoltList | Enable a new generation of video players, bringing a faster, modern and intuitive video player experience | Boolean | False | False |
enableAnnotations | Using 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 comments | Boolean | False | False |
annotationsCompare | Activate the comparison feature | Boolean | False | False |
annotationsAccessLevel | When the annotations are turned on, use this attribute to specify the level of privilege the running user has, in particular: | String | False | readonly |
enableWatermark | Enable the watermarking feature | Boolean | False | False |
watermarkMessage | Define what label the watermark should display | String | False | $User.Email |
watermarkAngle | Angle used to display the watermark | Integer | False | -35 |
watermarkColour | Colour used to display the watermark | String | False | rgb(215,218,233) |
watermarkSecondaryColour | Secondary colour for the watermark | String | False | rgb(0,0,0) |
watermarkColourSteps | Steps to interpolate the two colours | Integer | False | |
watermarkOpacity | Set the opacity of the watermark | Integer | False | |
watermarkFontFamily | Font family used for the watermark | String | False | Helvetica |
watermarkFontSize | Font size used for the watermark | Integer | False | 15 |
watermarkGapHeight | Gap factor to space in height the lines of the watermark | Decimal | False | 1 |
watermarkGapWidth | Gap factor to space in width the lines of the watermark | Decimal | False | 1 |
contextMenuTitle | Title for the context menu | String | False | NativeVideo |
contextMenuLink | Link for the context menu | String | False | https://www.nativevideo.co |
enableTags | Display the tags associated to the media | Boolean | False |