MaterialDesktopVideoControls

Desktop-oriented Material video controls.

Inherits: VideoControls

Properties

• automatically_imply_skip_next_button - Whether a skip next button should be displayed if there are more than one videos in the playlist.
• automatically_imply_skip_previous_button - Whether a skip previous button should be displayed if there are more than one videos in the playlist.
• bottom_button_bar - Controls displayed in the bottom button bar.
• bottom_button_bar_margin - Margin around the bottom button bar.
• button_bar_button_color - Color of the button bar buttons.
• button_bar_button_size - Size of the button bar buttons.
• button_bar_height - Height of the button bar.
• controls_hover_duration - Duration after which the controls will be hidden when there is no mouse movement.
• controls_transition_duration - Duration for which the controls will be animated when shown or hidden.
• display_seek_bar - Whether to display seek bar.
• hide_mouse_on_controls_removal - Whether to hide mouse on controls removal.
• modify_volume_on_scroll - Modify volume on mouse scroll.
• padding - Padding around the controls.
• play_and_pause_on_tap - Whether to toggle play and pause on tap.
• primary_button_bar - Controls displayed in the primary button bar.
• seek_bar_buffer_color - Color of the playback buffer section in the seek bar.
• seek_bar_color - Color of the seek bar.
• seek_bar_container_height - Height of the seek bar container.
• seek_bar_height - Height of the seek bar.
• seek_bar_hover_color - Color of the hovered section in the seek bar.
• seek_bar_hover_height - Height of the seek bar when hovered.
• seek_bar_margin - Margin around the seek bar.
• seek_bar_position_color - Color of the playback position section in the seek bar.
• seek_bar_thumb_color - Color of the seek bar thumb.
• seek_bar_thumb_size - Size of the seek bar thumb.
• seek_bar_thumb_transition_duration - Duration for which the seek bar thumb will be animated when the user seeks.
• seek_bar_transition_duration - Duration for which the seek bar will be animated when the user seeks.
• shift_subtitles_on_controls_visibility_change - Whether to shift the subtitles upwards when the controls are visible.
• toggle_fullscreen_on_double_press - Whether to toggle fullscreen on double press.
• top_button_bar - Controls displayed in the top button bar.
• top_button_bar_margin - Margin around the top button bar.
• visible_on_mount - Whether the controls are initially visible.
• volume_bar_active_color - Color of the active region in the volume bar.
• volume_bar_color - Color of the volume bar.
• volume_bar_thumb_color - Color of the volume bar thumb.
• volume_bar_thumb_size - Size of the volume bar thumb.
• volume_bar_transition_duration - Duration for which the volume bar will be animated when the user hovers.

Properties

buildautomatically_imply_skip_next_buttonclass-attributeinstance-attribute

automatically_imply_skip_next_button: bool = True

Whether a skip next button should be displayed if there are more than one videos in the playlist.

buildautomatically_imply_skip_previous_buttonclass-attributeinstance-attribute

automatically_imply_skip_previous_button: bool = True

Whether a skip previous button should be displayed if there are more than one videos in the playlist.

buildbottom_button_barclass-attributeinstance-attribute

bottom_button_bar: (
    list[Control | VideoBarItem] | None
) = None

Controls displayed in the bottom button bar.

Set to a list to replace the bottom button bar, or an empty list to hide it; if None, the native default is:

[
    ftv.VideoSkipPreviousButton(),
    ftv.VideoPlayOrPauseButton(),
    ftv.VideoSkipNextButton(),
    ftv.VideoSpacer(),
    ftv.VideoPositionIndicator(),
    ftv.VideoFullscreenButton(),
    ftv.VideoVolumeButton(),
]

buildbottom_button_bar_marginclass-attributeinstance-attribute

bottom_button_bar_margin: PaddingValue = field(
    default_factory=lambda: Padding.symmetric(
        horizontal=16.0
    )
)

Margin around the bottom button bar.

buildbutton_bar_button_colorclass-attributeinstance-attribute

button_bar_button_color: ColorValue = '#FFFFFFFF'

Color of the button bar buttons.

buildbutton_bar_button_sizeclass-attributeinstance-attribute

button_bar_button_size: Number = 28.0

Size of the button bar buttons.

buildbutton_bar_heightclass-attributeinstance-attribute

button_bar_height: Number = 56.0

Height of the button bar.

buildcontrols_hover_durationclass-attributeinstance-attribute

controls_hover_duration: DurationValue = 3000

Duration after which the controls will be hidden when there is no mouse movement.

buildcontrols_transition_durationclass-attributeinstance-attribute

controls_transition_duration: DurationValue = 150

Duration for which the controls will be animated when shown or hidden.

builddisplay_seek_barclass-attributeinstance-attribute

display_seek_bar: bool = True

Whether to display seek bar.

buildhide_mouse_on_controls_removalclass-attributeinstance-attribute

hide_mouse_on_controls_removal: bool = False

Whether to hide mouse on controls removal.

Note

On most platforms, the mouse must move before it becomes hidden. It works on macOS without moving the mouse.

buildmodify_volume_on_scrollclass-attributeinstance-attribute

modify_volume_on_scroll: bool = True

Modify volume on mouse scroll.

buildpaddingclass-attributeinstance-attribute

padding: PaddingValue | None = None

Padding around the controls.

buildplay_and_pause_on_tapclass-attributeinstance-attribute

play_and_pause_on_tap: bool = False

Whether to toggle play and pause on tap.

buildprimary_button_barclass-attributeinstance-attribute

primary_button_bar: (
    list[Control | VideoBarItem] | None
) = None

Controls displayed in the primary button bar.

Set to a list to replace the primary button bar, or an empty list to hide it; if None, the native default is an empty list.

buildseek_bar_buffer_colorclass-attributeinstance-attribute

seek_bar_buffer_color: ColorValue = '#3DFFFFFF'

Color of the playback buffer section in the seek bar.

buildseek_bar_colorclass-attributeinstance-attribute

seek_bar_color: ColorValue = '#3DFFFFFF'

Color of the seek bar.

buildseek_bar_container_heightclass-attributeinstance-attribute

seek_bar_container_height: Number = 36.0

Height of the seek bar container.

buildseek_bar_heightclass-attributeinstance-attribute

seek_bar_height: Number = 3.2

Height of the seek bar.

buildseek_bar_hover_colorclass-attributeinstance-attribute

seek_bar_hover_color: ColorValue = '#3DFFFFFF'

Color of the hovered section in the seek bar.

buildseek_bar_hover_heightclass-attributeinstance-attribute

seek_bar_hover_height: Number = 5.6

Height of the seek bar when hovered.

buildseek_bar_marginclass-attributeinstance-attribute

seek_bar_margin: PaddingValue = field(
    default_factory=lambda: Padding.symmetric(
        horizontal=16.0
    )
)

Margin around the seek bar.

buildseek_bar_position_colorclass-attributeinstance-attribute

seek_bar_position_color: ColorValue = '#FFFF0000'

Color of the playback position section in the seek bar.

buildseek_bar_thumb_colorclass-attributeinstance-attribute

seek_bar_thumb_color: ColorValue = '#FFFF0000'

Color of the seek bar thumb.

buildseek_bar_thumb_sizeclass-attributeinstance-attribute

seek_bar_thumb_size: Number = 12.0

Size of the seek bar thumb.

buildseek_bar_thumb_transition_durationclass-attributeinstance-attribute

seek_bar_thumb_transition_duration: DurationValue = 150

Duration for which the seek bar thumb will be animated when the user seeks.

buildseek_bar_transition_durationclass-attributeinstance-attribute

seek_bar_transition_duration: DurationValue = 300

Duration for which the seek bar will be animated when the user seeks.

buildshift_subtitles_on_controls_visibility_changeclass-attributeinstance-attribute

shift_subtitles_on_controls_visibility_change: bool = True

Whether to shift the subtitles upwards when the controls are visible.

buildtoggle_fullscreen_on_double_pressclass-attributeinstance-attribute

toggle_fullscreen_on_double_press: bool = True

Whether to toggle fullscreen on double press.

buildtop_button_barclass-attributeinstance-attribute

top_button_bar: list[Control | VideoBarItem] | None = (
    None
)

Controls displayed in the top button bar.

Set to a list to replace the top button bar, or an empty list to hide it; if None, the native default is an empty list.

buildtop_button_bar_marginclass-attributeinstance-attribute

top_button_bar_margin: PaddingValue = field(
    default_factory=lambda: Padding.symmetric(
        horizontal=16.0
    )
)

Margin around the top button bar.

buildvisible_on_mountclass-attributeinstance-attribute

visible_on_mount: bool = False

Whether the controls are initially visible.

buildvolume_bar_active_colorclass-attributeinstance-attribute

volume_bar_active_color: ColorValue = '#FFFFFFFF'

Color of the active region in the volume bar.

buildvolume_bar_colorclass-attributeinstance-attribute

volume_bar_color: ColorValue = '#3DFFFFFF'

Color of the volume bar.

buildvolume_bar_thumb_colorclass-attributeinstance-attribute

volume_bar_thumb_color: ColorValue = '#FFFFFFFF'

Color of the volume bar thumb.

buildvolume_bar_thumb_sizeclass-attributeinstance-attribute

volume_bar_thumb_size: Number = 12.0

Size of the volume bar thumb.

buildvolume_bar_transition_durationclass-attributeinstance-attribute

volume_bar_transition_duration: DurationValue = 150

Duration for which the volume bar will be animated when the user hovers.