# Interface: PlayerUI
# Table of contents
# Properties
- bottomControlbar
- canvas
- castButtons
- fullscreenButton
- jumpInTime
- panoButton
- panoControls
- panoFullButton
- pictureInPictureButton
- progressControl
- recorderButton
- scoreboard
- seekBarRange
- shareButton
- tags
- timeControls
- timeRangeControls
- topControlbar
- upcomingLiveOverlay
- viewsIndicator
- zoomIndicator
# Properties
# bottomControlbar
• bottomControlbar: HTMLElement
Returns a bottomControlbar element.
# canvas
• Optional
canvas: PlayerCanvas
# castButtons
• Optional
castButtons: CastButtons
Returns an object of available casting buttons.
# fullscreenButton
• fullscreenButton: HTMLElement
Returns a fullscreenButton element.
# jumpInTime
• Optional
jumpInTime: Component
Returns a jumpInTime component.
# panoButton
• Optional
panoButton: Component
Returns a pano button component.
# panoControls
• Optional
panoControls: Object
Returns a panoControls component.
# Type declaration
Name | Type |
---|---|
brushArea | () => any |
component | () => null | Component |
zoomArea | () => any |
# panoFullButton
• Optional
panoFullButton: Component
Returns a pano button component which triggers pano mode between full and restricted.
# pictureInPictureButton
• pictureInPictureButton: null
| HTMLElement
Returns a pictureInPictureButton element.
# progressControl
• progressControl: HTMLElement
Returns a progressControl element.
# recorderButton
• Optional
recorderButton: Component
Returns a recorder button component.
# scoreboard
• Optional
scoreboard: Component
& { setScoreboardData
: (value
: any
) => void
; updateScoresUI
: (value
: any
) => void
}
Returns a scoreboard component.
# seekBarRange
• seekBarRange: HTMLElement
Returns a seekBarRange element.
# shareButton
• Optional
shareButton: Component
& { setSharingData
: (value
: any
) => void
}
Returns social sharing component
# tags
• Optional
tags: PlayerTagsUI
# timeControls
• Optional
timeControls: Component
Returns a time controls component.
# timeRangeControls
• Optional
timeRangeControls: TimeRangeComponent
Returns a time range controls component.
# topControlbar
• topControlbar: HTMLElement
Returns a topControlbar element.
# upcomingLiveOverlay
• Optional
upcomingLiveOverlay: upcomingLiveOverlayComponent
Returns a upcomingLiveOverlay component.
# viewsIndicator
• Optional
viewsIndicator: Component
& { getViews
: () => null
| number
; setViews
: (value
: null
| number
) => void
}
Returns a viewsIndicator component.
# zoomIndicator
• Optional
zoomIndicator: Component
Returns a zoomIndicator component.