Name | Type | Description | Block | Common to All |
---|---|---|---|---|
agendaFromLivePage | String | “all” - for all livePages“a1a03f6c-…” - agenda id for specific agenda,can be separated using “,” for multiple specific agendas | No | |
autoScrollEnabled | Boolean | false | No | |
autoScrollTimeInterval | String | “4” | No | |
backgroundCoverImage | String | The cover image that you would want to set as default for the block. Eg: “https://files-myxp.s3-ap-southeast-1.amazonaws.com/livestream/default_background/Light_BG_1.png” | Yes | |
backgroundCoverImageDisablePopup | Boolean | Does not allow popup to occur when this field is true. | Yes | |
backgroundCoverImageDistortion | Object | Refer here. | Yes | |
backgroundCoverImageVisibility | Boolean | Only render background image when this field is true. | Yes | |
blockHeight | String | Sets the height of the block, only useful when fitHeightToContent is false. Eg: “200px”, “2rem”Units can be: px, em, rem, %. | Yes | |
blockVisibility | Boolean | Determines if the block visibility should be rendered by default. | Yes | |
blockWidth | String | Only needs to be specified when widthType is “custom”. Eg: “100%”Units can be: px, em, rem, %. | Yes | |
boundingBox | Boolean | Value of true would result in the block being wrapped with a white background. | Yes | |
breakpoints | Object | Refer here. | Yes | |
cardBoundingBox | Boolean | false | No | |
cardDescriptionVisibility | Boolean | false | No | |
cardHeight | String | “338px”
Width to height ratio must be at least 1:1.3
Units can be: px, em, rem, %. | No | |
cardPadding | String | “2px”
Units can be: px, em, rem, %. | No | |
cardTitleVisibility | Boolean | false | No | |
cardWidth | String | 260px
Units can be: px, em, rem, %. | No | |
contentMargin | Array | [“0”, “0”, “0”, “0”, “px”]Last index can be: “px”, “rem”, “em”, “%”, “”. | Yes | |
contentPadding | String | [“0”, “0”, “0”, “0”, “px”]
Last index can be: “px”, “rem”, “em”, “%”, “”. | Yes | |
coverDisplayType | String | “image” | No | |
coverImage | String | “https://files-myxp.gevme.com/…” | No | |
coverLivestreamOrVideo | String | ”” | No | |
ctaColor | String | “#212121”
Must be in hex css format | No | |
description | String | “description” | No | |
descriptionVisibility | Boolean | true | No | |
disableAutoplay | Boolean | true | No | |
disableVideoQualityOptions | Boolean | false | No | |
displayImageWhenNotLive | String | “https://files-myxp.gevme.com/….” | No | |
displaySomethingWhenNotLive | Enum | “image” | | No | |
displayVideoWhenNotLive | String | ”” | No | |
enableBookmark | Boolean | true | No | |
enableCalendar | Boolean | true | No | |
enableItemCTA | Boolean | true | No | |
enableItemIcon | Boolean | true | No | |
enableJoin | Boolean | true | No | |
enableLink | Boolean | true | No | |
endTime | String | Contains a global date and time string“2021-06-28T05:25:51.860Z” | No | |
eventOnGoogle | Boolean | true | No | |
eventOnOffice365 | Boolean | true | No | |
featuredContent | Array | Refer here. | No | |
fitHeightToContent | Boolean | Setting this field to true would result in blockHeight to have a predetermined value. | Yes | |
heading | String | “heading” | Yes | |
headingAlignment | Enum | "center" | "left" | Yes | |
headingVisibility | Boolean | true | Yes | |
html | String | “<p> Insert HTML here </p>” | No | |
images | Array | Refer here. | No | |
isSlideshow | Boolean | false | No | |
joinButtonColor | String | “#d392c0”Must be correct format for hex css | No | |
joinButtonText | String | “Join Show” | No | |
layout | Enum | “inline” | “grid” | No | |
link | String | “https://www.gevme.com/page/…” | No | |
livestreamUrl | String | “https://www.youtube.com/embed/{video_id}”“https://player.vimeo.com/video/{video_id}”“https://vimeo.com/showcase/{list_id}/embed”“https://www.facebook.com/{video_id}”“https://web.microsoftstream.com/video/{video_id}” | No | |
logoHeading | String | “Sponsors” | No | |
logoHeadingVisibility | Boolean | false | No | |
logosVisibility | Boolean | false | No | |
meetingType | String | “meet” | No | |
mode | Enum | “light” | “dark” | No | |
name | String | “rich-16233…” | No | |
openCalendarInNewTab | Boolean | true | No | |
openInNewWindow | Boolean | true | No | |
openJoinInNewTab | Boolean | true | No | |
order | Integer | 1 | Yes | |
resources | Array | Refer here. | No | |
sessionDescriptionVisibility | Boolean | true | No | |
sessionTitleVisibility | Boolean | true | No | |
settings | Object | Refer here. | No | |
showSpeakersType | Enum | “all” | “filtered” | “list” | No | |
sortBy | Enum | “firstname” | “lastname” | “jobTitle” | “company” | No | |
sortOrder | Enum | “ASC” | “DESC” | No | |
spaceBetweenImages | String | “0px”.
Units can be: px, em, rem, %. | No | |
speakerBioVisibility | Boolean | true | No | |
speakerCompanyVisibility | Boolean | true | No | |
speakerJobTitleVisibility | Boolean | true | No | |
speakers | String | ”[]”
Must be a string of Array | No | |
speakersVisibility | Boolean | true | No | |
startTime | String | Contains a global date and time string
“2021-06-28T05:25:51.860Z” | No | |
streamingService | Enum | “gevmelive” | “youtube” | “vimeo” | “facebook” | “msteams” | “customstream” | No | |
textContent | String | HTML elementeg: “<p>This is a paragraph.</p>” | No | |
title | String | “title” | No | |
titleVisibility | Boolean | true | No | |
type | Enum | “HeroContent” | "FeaturedContent" | No | |
widthType | Enum | Renders the block width styling based on the value selected. Only when “custom” is selected, blockWidth needs to be specified. Eg: “full” | “half” | “custom” | “fit-content” | Yes |