music-commons-fx/net.transgressoft.commons.fx.music.waveform/PlayableWaveformPane

PlayableWaveformPane

class PlayableWaveformPane : Region

Playback-aware waveform visualization component for JavaFX.

Renders audio amplitude data as a two-pass waveform split at the current playback position: bars before progressProperty use playedColorProperty and bars after use waveformColorProperty. A playhead vertical line is drawn at the split position when progress > 0. While amplitude data is being computed asynchronously, a shimmer animation sweeps left-to-right to indicate loading state.

Mouse interaction supports click-to-seek and drag-to-scrub. Visual position updates immediately on press and drag; a SeekEvent fires on mouse release with the final seek ratio clamped to 0.0, 1.0. progressProperty is not mutated during drag.

Consumers bind progressProperty to their player's current time and register a SeekEvent.SEEK handler to relay seek commands to the player.

Constructors

PlayableWaveformPane

constructor()

Properties

var accessibleHelp: String?

var accessibleRole: AccessibleRole?

accessibleRoleDescription

var accessibleRoleDescription: String?

var accessibleText: String?

var background: Background?

backgroundColorProperty

val backgroundColorProperty: ObjectProperty<Color>

open val baselineOffset: Double

var blendMode: BlendMode?

var border: Border?

val boundsInLocal: Bounds?

val boundsInParent: Bounds?

var cacheHint: CacheHint?

childrenUnmodifiable

open val childrenUnmodifiable: ObservableList<Node?>?

var clip: Node?

open val contentBias: Orientation?

open val cssMetaData: List<CssMetaData<out Styleable?, *>?>?

var cursor: Cursor?

var depthTest: DepthTest?

var effect: Effect?

effectiveNodeOrientation

val effectiveNodeOrientation: NodeOrientation?

eventDispatcher

var eventDispatcher: EventDispatcher?

var height: Double

var id: String?

inputMethodRequests

var inputMethodRequests: InputMethodRequests?

val insets: Insets?

var isCache: Boolean

var isCacheShape: Boolean

var isCenterShape: Boolean

var isDisable: Boolean

var isDisabled: Boolean

var isFocused: Boolean

isFocusTraversable

var isFocusTraversable: Boolean

val isFocusVisible: Boolean

val isFocusWithin: Boolean

var isHover: Boolean

var isManaged: Boolean

isMouseTransparent

var isMouseTransparent: Boolean

var isNeedsLayout: Boolean

var isPickOnBounds: Boolean

var isPressed: Boolean

open val isResizable: Boolean

var isScaleShape: Boolean

var isSnapToPixel: Boolean

var isVisible: Boolean

val layoutBounds: Bounds?

var layoutX: Double

var layoutY: Double

localToParentTransform

val localToParentTransform: Transform?

localToSceneTransform

val localToSceneTransform: Transform?

var maxHeight: Double

var maxWidth: Double

var minHeight: Double

var minWidth: Double

nodeOrientation

var nodeOrientation: NodeOrientation?

onContextMenuRequested

var onContextMenuRequested: EventHandler<in ContextMenuEvent?>?

var onDragDetected: EventHandler<in MouseEvent?>?

var onDragDone: EventHandler<in DragEvent?>?

var onDragDropped: EventHandler<in DragEvent?>?

var onDragEntered: EventHandler<in DragEvent?>?

var onDragExited: EventHandler<in DragEvent?>?

var onDragOver: EventHandler<in DragEvent?>?

onInputMethodTextChanged

var onInputMethodTextChanged: EventHandler<in InputMethodEvent?>?

var onKeyPressed: EventHandler<in KeyEvent?>?

var onKeyReleased: EventHandler<in KeyEvent?>?

var onKeyTyped: EventHandler<in KeyEvent?>?

var onMouseClicked: EventHandler<in MouseEvent?>?

onMouseDragEntered

var onMouseDragEntered: EventHandler<in MouseDragEvent?>?

onMouseDragExited

var onMouseDragExited: EventHandler<in MouseDragEvent?>?

var onMouseDragged: EventHandler<in MouseEvent?>?

onMouseDragOver

var onMouseDragOver: EventHandler<in MouseDragEvent?>?

onMouseDragReleased

var onMouseDragReleased: EventHandler<in MouseDragEvent?>?

var onMouseEntered: EventHandler<in MouseEvent?>?

var onMouseExited: EventHandler<in MouseEvent?>?

var onMouseMoved: EventHandler<in MouseEvent?>?

var onMousePressed: EventHandler<in MouseEvent?>?

onMouseReleased

var onMouseReleased: EventHandler<in MouseEvent?>?

var onRotate: EventHandler<in RotateEvent?>?

onRotationFinished

var onRotationFinished: EventHandler<in RotateEvent?>?

onRotationStarted

var onRotationStarted: EventHandler<in RotateEvent?>?

var onScroll: EventHandler<in ScrollEvent?>?

onScrollFinished

var onScrollFinished: EventHandler<in ScrollEvent?>?

onScrollStarted

var onScrollStarted: EventHandler<in ScrollEvent?>?

var onSwipeDown: EventHandler<in SwipeEvent?>?

var onSwipeLeft: EventHandler<in SwipeEvent?>?

var onSwipeRight: EventHandler<in SwipeEvent?>?

var onSwipeUp: EventHandler<in SwipeEvent?>?

var onTouchMoved: EventHandler<in TouchEvent?>?

var onTouchPressed: EventHandler<in TouchEvent?>?

onTouchReleased

var onTouchReleased: EventHandler<in TouchEvent?>?

onTouchStationary

var onTouchStationary: EventHandler<in TouchEvent?>?

var onZoom: EventHandler<in ZoomEvent?>?

var onZoomFinished: EventHandler<in ZoomEvent?>?

var onZoomStarted: EventHandler<in ZoomEvent?>?

var opacity: Double

var opaqueInsets: Insets?

var padding: Insets?

var parent: Parent?

playedColorProperty

val playedColorProperty: SimpleObjectProperty<Color?>

var prefHeight: Double

var prefWidth: Double

progressProperty

val progressProperty: SimpleDoubleProperty

val properties: ObservableMap<Any?, Any?>?

pseudoClassStates

val pseudoClassStates: ObservableSet<PseudoClass?>?

var rotate: Double

var rotationAxis: Point3D?

var scaleX: Double

var scaleY: Double

var scaleZ: Double

val scene: Scene?

var shape: Shape?

var style: String?

open val styleableNode: Node?

styleableParent

open val styleableParent: Styleable?

val styleClass: ObservableList<String?>?

val stylesheets: ObservableList<String?>?

val transforms: ObservableList<Transform?>?

var translateX: Double

var translateY: Double

var translateZ: Double

open val typeSelector: String?

userAgentStylesheet

open val userAgentStylesheet: String?

open var userData: Any?

var viewOrder: Double

waveformColorProperty

val waveformColorProperty: SimpleObjectProperty<Color?>

var width: Double

Functions

accessibleHelpProperty

fun accessibleHelpProperty(): ObjectProperty<String?>?

accessibleRoleDescriptionProperty

fun accessibleRoleDescriptionProperty(): ObjectProperty<String?>?

accessibleRoleProperty

fun accessibleRoleProperty(): ObjectProperty<AccessibleRole?>?

accessibleTextProperty

fun accessibleTextProperty(): ObjectProperty<String?>?

fun <T : Event?> addEventFilter(p0: EventType<T?>?, p1: EventHandler<in T?>?)

addEventHandler

fun <T : Event?> addEventHandler(p0: EventType<T?>?, p1: EventHandler<in T?>?)

backgroundProperty

fun backgroundProperty(): ObjectProperty<Background?>?

blendModeProperty

fun blendModeProperty(): ObjectProperty<BlendMode?>?

fun borderProperty(): ObjectProperty<Border?>?

boundsInLocalProperty

fun boundsInLocalProperty(): ReadOnlyObjectProperty<Bounds?>?

boundsInParentProperty

fun boundsInParentProperty(): ReadOnlyObjectProperty<Bounds?>?

buildEventDispatchChain

open fun buildEventDispatchChain(p0: EventDispatchChain?): EventDispatchChain?

cacheHintProperty

fun cacheHintProperty(): ObjectProperty<CacheHint?>?

fun cacheProperty(): BooleanProperty?

cacheShapeProperty

fun cacheShapeProperty(): BooleanProperty?

centerShapeProperty

fun centerShapeProperty(): BooleanProperty?

fun clipProperty(): ObjectProperty<Node?>?

computeAreaInScreen

open fun computeAreaInScreen(): Double

open operator fun contains(p0: Point2D?): Boolean

open fun contains(p0: Double, p1: Double): Boolean

fun cursorProperty(): ObjectProperty<Cursor?>?

depthTestProperty

fun depthTestProperty(): ObjectProperty<DepthTest?>?

disabledProperty

fun disabledProperty(): ReadOnlyBooleanProperty?

disableProperty

fun disableProperty(): BooleanProperty?

Cancels the shimmer animation and the coroutine scope. Must be called when the component is no longer needed to release resources.

effectiveNodeOrientationProperty

fun effectiveNodeOrientationProperty(): ReadOnlyObjectProperty<NodeOrientation?>?

fun effectProperty(): ObjectProperty<Effect?>?

eventDispatcherProperty

fun eventDispatcherProperty(): ObjectProperty<EventDispatcher?>?

executeAccessibleAction

open fun executeAccessibleAction(p0: AccessibleAction?, vararg p1: Any?)

fun fireEvent(p0: Event?)

focusedProperty

fun focusedProperty(): ReadOnlyBooleanProperty?

focusTraversableProperty

fun focusTraversableProperty(): BooleanProperty?

focusVisibleProperty

fun focusVisibleProperty(): ReadOnlyBooleanProperty?

focusWithinProperty

fun focusWithinProperty(): ReadOnlyBooleanProperty?

open fun hasProperties(): Boolean

fun heightProperty(): ReadOnlyDoubleProperty?

fun hoverProperty(): ReadOnlyBooleanProperty?

fun idProperty(): StringProperty?

inputMethodRequestsProperty

fun inputMethodRequestsProperty(): ObjectProperty<InputMethodRequests?>?

fun insetsProperty(): ReadOnlyObjectProperty<Insets?>?

open fun intersects(p0: Bounds?): Boolean

open fun intersects(p0: Double, p1: Double, p2: Double, p3: Double): Boolean

fun layout()

layoutBoundsProperty

fun layoutBoundsProperty(): ReadOnlyObjectProperty<Bounds?>?

layoutXProperty

fun layoutXProperty(): DoubleProperty?

layoutYProperty

fun layoutYProperty(): DoubleProperty?

fun loadWaveform(waveform: AudioWaveform)

Loads the given waveform asynchronously. A shimmer animation starts immediately; it stops and the waveform is drawn when amplitude data arrives.

open fun localToParent(p0: Bounds?): Bounds?

open fun localToParent(p0: Point2D?): Point2D?

open fun localToParent(p0: Point3D?): Point3D?

open fun localToParent(p0: Double, p1: Double): Point2D?

open fun localToParent(p0: Double, p1: Double, p2: Double): Point3D?

localToParentTransformProperty

fun localToParentTransformProperty(): ReadOnlyObjectProperty<Transform?>?

open fun localToScene(p0: Bounds?): Bounds?

open fun localToScene(p0: Point2D?): Point2D?

open fun localToScene(p0: Point3D?): Point3D?

open fun localToScene(p0: Bounds?, p1: Boolean): Bounds?

open fun localToScene(p0: Point2D?, p1: Boolean): Point2D?

open fun localToScene(p0: Point3D?, p1: Boolean): Point3D?

open fun localToScene(p0: Double, p1: Double): Point2D?

open fun localToScene(p0: Double, p1: Double, p2: Boolean): Point2D?

open fun localToScene(p0: Double, p1: Double, p2: Double): Point3D?

open fun localToScene(p0: Double, p1: Double, p2: Double, p3: Boolean): Point3D?

localToSceneTransformProperty

fun localToSceneTransformProperty(): ReadOnlyObjectProperty<Transform?>?

open fun localToScreen(p0: Bounds?): Bounds?

open fun localToScreen(p0: Point2D?): Point2D?

open fun localToScreen(p0: Point3D?): Point2D?

open fun localToScreen(p0: Double, p1: Double): Point2D?

open fun localToScreen(p0: Double, p1: Double, p2: Double): Point2D?

open fun lookup(p0: String?): Node?

open fun lookupAll(p0: String?): Set<Node?>?

managedProperty

fun managedProperty(): BooleanProperty?

fun maxHeight(p0: Double): Double

maxHeightProperty

fun maxHeightProperty(): DoubleProperty?

fun maxWidth(p0: Double): Double

maxWidthProperty

fun maxWidthProperty(): DoubleProperty?

fun minHeight(p0: Double): Double

minHeightProperty

fun minHeightProperty(): DoubleProperty?

fun minWidth(p0: Double): Double

minWidthProperty

fun minWidthProperty(): DoubleProperty?

mouseTransparentProperty

fun mouseTransparentProperty(): BooleanProperty?

needsLayoutProperty

fun needsLayoutProperty(): ReadOnlyBooleanProperty?

nodeOrientationProperty

fun nodeOrientationProperty(): ObjectProperty<NodeOrientation?>?

notifyAccessibleAttributeChanged

fun notifyAccessibleAttributeChanged(p0: AccessibleAttribute?)

onContextMenuRequestedProperty

fun onContextMenuRequestedProperty(): ObjectProperty<EventHandler<in ContextMenuEvent?>?>?

onDragDetectedProperty

fun onDragDetectedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onDragDoneProperty

fun onDragDoneProperty(): ObjectProperty<EventHandler<in DragEvent?>?>?

onDragDroppedProperty

fun onDragDroppedProperty(): ObjectProperty<EventHandler<in DragEvent?>?>?

onDragEnteredProperty

fun onDragEnteredProperty(): ObjectProperty<EventHandler<in DragEvent?>?>?

onDragExitedProperty

fun onDragExitedProperty(): ObjectProperty<EventHandler<in DragEvent?>?>?

onDragOverProperty

fun onDragOverProperty(): ObjectProperty<EventHandler<in DragEvent?>?>?

onInputMethodTextChangedProperty

fun onInputMethodTextChangedProperty(): ObjectProperty<EventHandler<in InputMethodEvent?>?>?

onKeyPressedProperty

fun onKeyPressedProperty(): ObjectProperty<EventHandler<in KeyEvent?>?>?

onKeyReleasedProperty

fun onKeyReleasedProperty(): ObjectProperty<EventHandler<in KeyEvent?>?>?

onKeyTypedProperty

fun onKeyTypedProperty(): ObjectProperty<EventHandler<in KeyEvent?>?>?

onMouseClickedProperty

fun onMouseClickedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMouseDragEnteredProperty

fun onMouseDragEnteredProperty(): ObjectProperty<EventHandler<in MouseDragEvent?>?>?

onMouseDragExitedProperty

fun onMouseDragExitedProperty(): ObjectProperty<EventHandler<in MouseDragEvent?>?>?

onMouseDraggedProperty

fun onMouseDraggedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMouseDragOverProperty

fun onMouseDragOverProperty(): ObjectProperty<EventHandler<in MouseDragEvent?>?>?

onMouseDragReleasedProperty

fun onMouseDragReleasedProperty(): ObjectProperty<EventHandler<in MouseDragEvent?>?>?

onMouseEnteredProperty

fun onMouseEnteredProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMouseExitedProperty

fun onMouseExitedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMouseMovedProperty

fun onMouseMovedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMousePressedProperty

fun onMousePressedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onMouseReleasedProperty

fun onMouseReleasedProperty(): ObjectProperty<EventHandler<in MouseEvent?>?>?

onRotateProperty

fun onRotateProperty(): ObjectProperty<EventHandler<in RotateEvent?>?>?

onRotationFinishedProperty

fun onRotationFinishedProperty(): ObjectProperty<EventHandler<in RotateEvent?>?>?

onRotationStartedProperty

fun onRotationStartedProperty(): ObjectProperty<EventHandler<in RotateEvent?>?>?

onScrollFinishedProperty

fun onScrollFinishedProperty(): ObjectProperty<EventHandler<in ScrollEvent?>?>?

onScrollProperty

fun onScrollProperty(): ObjectProperty<EventHandler<in ScrollEvent?>?>?

onScrollStartedProperty

fun onScrollStartedProperty(): ObjectProperty<EventHandler<in ScrollEvent?>?>?

onSwipeDownProperty

fun onSwipeDownProperty(): ObjectProperty<EventHandler<in SwipeEvent?>?>?

onSwipeLeftProperty

fun onSwipeLeftProperty(): ObjectProperty<EventHandler<in SwipeEvent?>?>?

onSwipeRightProperty

fun onSwipeRightProperty(): ObjectProperty<EventHandler<in SwipeEvent?>?>?

onSwipeUpProperty

fun onSwipeUpProperty(): ObjectProperty<EventHandler<in SwipeEvent?>?>?

onTouchMovedProperty

fun onTouchMovedProperty(): ObjectProperty<EventHandler<in TouchEvent?>?>?

onTouchPressedProperty

fun onTouchPressedProperty(): ObjectProperty<EventHandler<in TouchEvent?>?>?

onTouchReleasedProperty

fun onTouchReleasedProperty(): ObjectProperty<EventHandler<in TouchEvent?>?>?

onTouchStationaryProperty

fun onTouchStationaryProperty(): ObjectProperty<EventHandler<in TouchEvent?>?>?

onZoomFinishedProperty

fun onZoomFinishedProperty(): ObjectProperty<EventHandler<in ZoomEvent?>?>?

fun onZoomProperty(): ObjectProperty<EventHandler<in ZoomEvent?>?>?

onZoomStartedProperty

fun onZoomStartedProperty(): ObjectProperty<EventHandler<in ZoomEvent?>?>?

opacityProperty

fun opacityProperty(): DoubleProperty?

opaqueInsetsProperty

fun opaqueInsetsProperty(): ObjectProperty<Insets?>?

paddingProperty

fun paddingProperty(): ObjectProperty<Insets?>?

fun parentProperty(): ReadOnlyObjectProperty<Parent?>?

open fun parentToLocal(p0: Bounds?): Bounds?

open fun parentToLocal(p0: Point2D?): Point2D?

open fun parentToLocal(p0: Point3D?): Point3D?

open fun parentToLocal(p0: Double, p1: Double): Point2D?

open fun parentToLocal(p0: Double, p1: Double, p2: Double): Point3D?

pickOnBoundsProperty

fun pickOnBoundsProperty(): BooleanProperty?

fun prefHeight(p0: Double): Double

prefHeightProperty

fun prefHeightProperty(): DoubleProperty?

fun prefWidth(p0: Double): Double

prefWidthProperty

fun prefWidthProperty(): DoubleProperty?

pressedProperty

fun pressedProperty(): ReadOnlyBooleanProperty?

pseudoClassStateChanged

fun pseudoClassStateChanged(p0: PseudoClass?, p1: Boolean)

queryAccessibleAttribute

open fun queryAccessibleAttribute(p0: AccessibleAttribute?, vararg p1: Any?): Any?

open fun relocate(p0: Double, p1: Double)

removeEventFilter

fun <T : Event?> removeEventFilter(p0: EventType<T?>?, p1: EventHandler<in T?>?)

removeEventHandler

fun <T : Event?> removeEventHandler(p0: EventType<T?>?, p1: EventHandler<in T?>?)

open fun requestFocus()

open fun requestLayout()

open fun resize(p0: Double, p1: Double)

open fun resizeRelocate(p0: Double, p1: Double, p2: Double, p3: Double)

fun rotateProperty(): DoubleProperty?

rotationAxisProperty

fun rotationAxisProperty(): ObjectProperty<Point3D?>?

scaleShapeProperty

fun scaleShapeProperty(): BooleanProperty?

fun scaleXProperty(): DoubleProperty?

fun scaleYProperty(): DoubleProperty?

fun scaleZProperty(): DoubleProperty?

fun sceneProperty(): ReadOnlyObjectProperty<Scene?>?

open fun sceneToLocal(p0: Bounds?): Bounds?

open fun sceneToLocal(p0: Point2D?): Point2D?

open fun sceneToLocal(p0: Point3D?): Point3D?

open fun sceneToLocal(p0: Bounds?, p1: Boolean): Bounds?

open fun sceneToLocal(p0: Point2D?, p1: Boolean): Point2D?

open fun sceneToLocal(p0: Double, p1: Double): Point2D?

open fun sceneToLocal(p0: Double, p1: Double, p2: Boolean): Point2D?

open fun sceneToLocal(p0: Double, p1: Double, p2: Double): Point3D?

open fun screenToLocal(p0: Bounds?): Bounds?

open fun screenToLocal(p0: Point2D?): Point2D?

open fun screenToLocal(p0: Double, p1: Double): Point2D?

open fun setMaxSize(p0: Double, p1: Double)

open fun setMinSize(p0: Double, p1: Double)

open fun setPrefSize(p0: Double, p1: Double)

fun shapeProperty(): ObjectProperty<Shape?>?

snappedBottomInset

fun snappedBottomInset(): Double

snappedLeftInset

fun snappedLeftInset(): Double

snappedRightInset

fun snappedRightInset(): Double

snappedTopInset

fun snappedTopInset(): Double

open fun snapPositionX(p0: Double): Double

open fun snapPositionY(p0: Double): Double

open fun snapshot(p0: SnapshotParameters?, p1: WritableImage?): WritableImage?

open fun snapshot(p0: Callback<SnapshotResult?, Void?>?, p1: SnapshotParameters?, p2: WritableImage?)

open fun snapSizeX(p0: Double): Double

open fun snapSizeY(p0: Double): Double

open fun snapSpaceX(p0: Double): Double

open fun snapSpaceY(p0: Double): Double

snapToPixelProperty

fun snapToPixelProperty(): BooleanProperty?

startDragAndDrop

open fun startDragAndDrop(vararg p0: TransferMode?): Dragboard?

open fun startFullDrag()

fun styleProperty(): StringProperty?

open fun toBack()

open fun toFront()

translateXProperty

fun translateXProperty(): DoubleProperty?

translateYProperty

fun translateYProperty(): DoubleProperty?

translateZProperty

fun translateZProperty(): DoubleProperty?

open fun usesMirroring(): Boolean

viewOrderProperty

fun viewOrderProperty(): DoubleProperty?

visibleProperty

fun visibleProperty(): BooleanProperty?

fun widthProperty(): ReadOnlyDoubleProperty?