VirtualConfig

data class VirtualConfig(showWaitingRoomVideo: Boolean, waitingRoomYouTubeVideoId: String?, vimeoURL: String?) : Parcelable

Contains various values that are optionally customizable, and are specific to the Virtual Visit experience.

Parameters

showWaitingRoomVideo

Whether or not to display a YouTube video on the virtual waiting room screen. Defaults to true. This must be explicitly overridden in order to hide the waiting room, otherwise it will always show.

waitingRoomYouTubeVideoId

The id of the YouTube video that should display on the waiting room screen. This can be retrieved from a YouTube video's URL. If the video's URL is https://www.youtube.com/watch?v=2woiLsEG2zo, this value should be 2woiLsEG2zo.

vimeoURL

The URL to the vimeo video. If the URL is https://player.vimeo.com/external/761626618.mpd?s=766354878172a5984fea102e9323a5d3f91cf2f7, the value should be 761626618.mpd?s=766354878172a5984fea102e9323a5d3f91cf2f7.

If no vimeo URL or youtube video are provided this default vimeo video will play https://player.vimeo.com/external/761626618.mpd?s=766354878172a5984fea102e9323a5d3f91cf2f7 In the case where both vimeo and youtube URLs are provided, the youtube video will take precedence

Constructors

VirtualConfig
Link copied to clipboard
fun VirtualConfig(showWaitingRoomVideo: Boolean = true, waitingRoomYouTubeVideoId: String? = null, vimeoURL: String? = null)
Whether or not to display a YouTube video on the virtual waiting room screen.

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

showWaitingRoomVideo
Link copied to clipboard
val showWaitingRoomVideo: Boolean = true
Whether or not to display a YouTube video on the virtual waiting room screen.
vimeoURL
Link copied to clipboard
val vimeoURL: String? = null
The URL to the vimeo video.
waitingRoomYouTubeVideoId
Link copied to clipboard
val waitingRoomYouTubeVideoId: String? = null
The id of the YouTube video that should display on the waiting room screen.