Video

Video

Bases: ConstrainedControl

A control that displays a video from a playlist.

RAISES	DESCRIPTION
AssertionError	If the volume is not between 0.0 and 100.0 (inclusive).

alignment

alignment: Alignment = field(default_factory=lambda: CENTER)

Defines the Alignment of the viewport.

animate_offset

animate_offset: AnimationValue | None = None

Setting control's animate_offset to either True, number or an instance of animation.Animation class enables implicit animation of Control.offset property.

offset property is an instance of transform.Offset class which specifies horizontal x and vertical y offset of a control scaled to control's size. For example, an offset transform.Offset(-0.25, 0) will result in a horizontal translation of one quarter the width of the control.

Offset animation is used for various sliding effects:

import flet as ft

def main(page: ft.Page):

    c = ft.Container(
        width=150,
        height=150,
        bgcolor="blue",
        border_radius=10,
        offset=ft.transform.Offset(-2, 0),
        animate_offset=ft.animation.Animation(1000),
    )

    def animate(e):
        c.offset = ft.transform.Offset(0, 0)
        c.update()

    page.add(
        c,
        ft.ElevatedButton("Reveal!", on_click=animate),
    )

ft.run(main)

animate_opacity

animate_opacity: AnimationValue | None = None

Setting control's animate_opacity to either True, number or an instance of animation.Animation class enables implicit animation of Control.opacity property.

import flet as ft

def main(page: ft.Page):

    c = ft.Container(
        width=150,
        height=150,
        bgcolor="blue",
        border_radius=10,
        animate_opacity=300,
    )

    def animate_opacity(e):
        c.opacity = 0 if c.opacity == 1 else 1
        c.update()

    page.add(
        c,
        ft.ElevatedButton(
            "Animate opacity",
            on_click=animate_opacity,
        ),
    )

ft.app(main)

animate_position

animate_position: AnimationValue | None = None

Setting control's animate_position to either True, number or an instance of animation.Animation class (see above) enables implicit animation of Control's left, top, right and bottom properties.

Please note Control position works inside Stack control only.

import flet as ft

def main(page: ft.Page):

    c1 = ft.Container(width=50, height=50, bgcolor="red", animate_position=1000)

    c2 = ft.Container(
        width=50, height=50, bgcolor="green", top=60, left=0, animate_position=500
    )

    c3 = ft.Container(
        width=50, height=50, bgcolor="blue", top=120, left=0, animate_position=1000
    )

    def animate_container(e):
        c1.top = 20
        c1.left = 200
        c2.top = 100
        c2.left = 40
        c3.top = 180
        c3.left = 100
        page.update()

    page.add(
        ft.Stack([c1, c2, c3], height=250),
        ft.ElevatedButton("Animate!", on_click=animate_container),
    )

ft.run(main)

animate_rotation

animate_rotation: AnimationValue | None = None

Setting control's animate_rotation to either True, number or an instance of animation.Animation class enables implicit animation of Control.rotate property.

from math import pi
import flet as ft

def main(page: ft.Page):

    c = ft.Container(
        width=100,
        height=70,
        bgcolor="blue",
        border_radius=5,
        rotate=ft.transform.Rotate(0, alignment=ft.Alignment.CENTER),
        animate_rotation=ft.animation.Animation(300, ft.AnimationCurve.BOUNCE_OUT),
    )

    def animate(e):
        c.rotate.angle += pi / 2
        page.update()

    page.vertical_alignment = ft.MainAxisAlignment.CENTER
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
    page.spacing = 30
    page.add(
        c,
        ft.ElevatedButton("Animate!", on_click=animate),
    )

ft.run(main)

animate_scale

animate_scale: AnimationValue | None = None

Setting control's animate_scale to either True, number or an instance of animation.Animation class enables implicit animation of Control.scale property.

import flet as ft

def main(page: ft.Page):

    c = ft.Container(
        width=100,
        height=100,
        bgcolor="blue",
        border_radius=5,
        scale=ft.transform.Scale(scale=1),
        animate_scale=ft.animation.Animation(600, ft.AnimationCurve.BOUNCE_OUT),
    )

    def animate(e):
        c.scale = 2
        page.update()

    page.vertical_alignment = ft.MainAxisAlignment.CENTER
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
    page.spacing = 30
    page.add(
        c,
        ft.ElevatedButton("Animate!", on_click=animate),
    )

ft.run(main)

animate_size

animate_size: AnimationValue | None = None

TBD

aspect_ratio

aspect_ratio: OptionalNumber = None

TBD

autoplay

autoplay: bool = False

Whether the video should start playing automatically.

badge

badge: BadgeValue | None = None

The badge property supports both strings and Badge objects.

bottom

bottom: OptionalNumber = None

Effective inside Stack only. The distance that the child's bottom edge is inset from the bottom of the stack.

col

col: ResponsiveNumber = 12

If a parent of the control is ResponsiveRow, col property is used to determine how many virtual columns of a screen the control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}. Breakpoints are named dimension ranges:

Breakpoint	Dimension
xs	<576px
sm	≥576px
md	≥768px
lg	≥992px
xl	≥1200px
xxl	≥1400px

If col property is not specified, it spans the maximum number of columns (12).

configuration

configuration: VideoConfiguration = field(
    default_factory=lambda: VideoConfiguration()
)

Additional configuration for the video player.

data

data: Any = skip_field()

Arbitrary data of any type that can be attached to a control.

disabled

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled. disabled property is mostly used with data entry controls like TextField, Dropdown, Checkbox, buttons. However, disabled could be set to a parent control and its value will be propagated down to all children recursively.

For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

c = ft.Column(controls=[
    ft.TextField(),
    ft.TextField()
])
c.disabled = True
page.add(c)

expand

expand: bool | int | None = None

When a child Control is placed into a Column or a Row you can "expand" it to fill the available space. expand property could be a boolean value (True - expand control to fill all available space) or an integer - an "expand factor" specifying how to divide a free space with other expanded child controls.

For more information and examples about expand property see "Expanding children" sections in Column or Row.

Here is an example of expand being used in action for both Column and Row:

import flet as ft

def main(page: ft.Page):
    page.spacing = 0
    page.padding = 0
    page.add(
        ft.Column(
            controls=[
                ft.Row(
                    [
                        ft.Card(
                            content=ft.Text("Card_1"),
                            color=ft.Colors.ORANGE_300,
                            expand=True,
                            height=page.height,
                            margin=0,
                        ),
                        ft.Card(
                            content=ft.Text("Card_2"),
                            color=ft.Colors.GREEN_100,
                            expand=True,
                            height=page.height,
                            margin=0,
                        ),
                    ],
                    expand=True,
                    spacing=0,
                ),
            ],
            expand=True,
            spacing=0,
        ),
    )

ft.app(main)

expand_loose

expand_loose: bool | None = None

Effective only if expand is True.

If expand_loose is True, the child control of a Column or a Row will be given the flexibility to expand to fill the available space in the main axis (e.g., horizontally for a Row or vertically for a Column), but will not be required to fill the available space.

The default value is False.

Here is the example of Containers placed in Rows with expand_loose = True:

import flet as ft


class Message(ft.Container):
    def __init__(self, author, body):
        super().__init__()
        self.content = ft.Column(
            controls=[
                ft.Text(author, weight=ft.FontWeight.BOLD),
                ft.Text(body),
            ],
        )
        self.border = ft.border.all(1, ft.Colors.BLACK)
        self.border_radius = ft.border_radius.all(10)
        self.bgcolor = ft.Colors.GREEN_200
        self.padding = 10
        self.expand = True
        self.expand_loose = True


def main(page: ft.Page):
    chat = ft.ListView(
        padding=10,
        spacing=10,
        controls=[
            ft.Row(
                alignment=ft.MainAxisAlignment.START,
                controls=[
                    Message(
                        author="John",
                        body="Hi, how are you?",
                    ),
                ],
            ),
            ft.Row(
                alignment=ft.MainAxisAlignment.END,
                controls=[
                    Message(
                        author="Jake",
                        body="Hi I am good thanks, how about you?",
                    ),
                ],
            ),
            ft.Row(
                alignment=ft.MainAxisAlignment.START,
                controls=[
                    Message(
                        author="John",
                        body="Lorem Ipsum is simply dummy text of the printing and 
                        typesetting industry. Lorem Ipsum has been the industry's 
                        standard dummy text ever since the 1500s, when an unknown 
                        printer took a galley of type and scrambled it to make a 
                        type specimen book.",
                    ),
                ],
            ),
            ft.Row(
                alignment=ft.MainAxisAlignment.END,
                controls=[
                    Message(
                        author="Jake",
                        body="Thank you!",
                    ),
                ],
            ),
        ],
    )

    page.window.width = 393
    page.window.height = 600
    page.window.always_on_top = False

    page.add(chat)


ft.run(main)

fill_color

fill_color: ColorValue = BLACK

Defines the color used to fill the video background.

filter_quality

filter_quality: FilterQuality = LOW

Filter quality of the texture used to render the video output.

Note

Android was reported to show blurry images when using FilterQuality.HIGH. Prefer the usage of FilterQuality.MEDIUM on this platform.

fit

fit: BoxFit = CONTAIN

The box fit to use for the video.

height

height: OptionalNumber = None

Imposed Control height in virtual pixels.

key

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

left

left: OptionalNumber = None

Effective inside Stack only. The distance that the child's left edge is inset from the left of the stack.

muted

muted: bool = False

Defines whether the video player should be started in muted state.

offset

offset: OffsetValue | None = None

Applies a translation transformation before painting the control.

The translation is expressed as a transform.Offset scaled to the control's size. For example, an Offset with a x of 0.25 will result in a horizontal translation of one quarter the width of the control.

The following example displays container at 0, 0 top left corner of a stack as transform applies -1 * 100, -1 * 100 (offset * control_size) horizontal and vertical translations to the control:

import flet as ft

def main(page: ft.Page):

    page.add(
        ft.Stack(
            [
                ft.Container(
                    bgcolor="red",
                    width=100,
                    height=100,
                    left=100,
                    top=100,
                    offset=ft.transform.Offset(-1, -1),
                )
            ],
            width=1000,
            height=1000,
        )
    )

ft.run(main)

on_animation_end

on_animation_end: OptionalControlEventHandler[
    ConstrainedControl
] = None

All controls with animate_* properties have on_animation_end event handler which is called when animation complete and can be used to chain multiple animations.

Event's object data field contains the name of animation:

• opacity
• rotation
• scale
• offset
• position
• container

For example:

c = ft.Container(
        ft.Text("Animate me!"),
        # ...
        animate=ft.animation.Animation(1000, "bounceOut"),
        on_animation_end=lambda e: print("Container animation end:", e.data)
    )

on_complete

on_complete: ControlEventHandler[Video] | None = None

Fires when a video player completes.

on_enter_fullscreen

on_enter_fullscreen: ControlEventHandler[Video] | None = (
    None
)

Fires when the video player enters fullscreen.

on_error

on_error: ControlEventHandler[Video] | None = None

Fires when an error occurs.

Event handler argument's data property contains information about the error.

on_exit_fullscreen

on_exit_fullscreen: ControlEventHandler[Video] | None = None

Fires when the video player exits fullscreen

on_load

on_load: ControlEventHandler[Video] | None = None

Fires when the video player is initialized and ready for playback.

on_track_change

on_track_change: ControlEventHandler[Video] | None = None

Fires when a video track changes.

Event handler argument's data property contains the index of the new track.

opacity

opacity: Number = 1.0

Defines the transparency of the control.

Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque without any transparency) and defaults to 1.0.

page

page: Page | PageView | None

The page (of type Page or PageView) to which this control belongs to.

parent

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

pause_upon_entering_background_mode

pause_upon_entering_background_mode: bool = True

Whether to pause the video when application enters background mode.

pitch

pitch: Number = 1.0

Defines the relative pitch of the video player.

playback_rate

playback_rate: Number = 1.0

Defines the playback rate of the video player.

playlist

playlist: list[VideoMedia] = field(default_factory=list)

A list of VideoMedias representing the video files to be played.

playlist_mode

playlist_mode: PlaylistMode | None = None

Represents the mode of playback for the playlist.

resume_upon_entering_foreground_mode

resume_upon_entering_foreground_mode: bool = False

Whether to resume the video when application enters foreground mode. Has effect only if pause_upon_entering_background_mode is also set to True.

right

right: OptionalNumber = None

Effective inside Stack only. The distance that the child's right edge is inset from the right of the stack.

rotate

rotate: RotateValue | None = None

Transforms control using a rotation around the center.

The value of rotate property could be one of the following types:

• number - a rotation in clockwise radians. Full circle 360° is math.pi * 2 radians, 90° is pi / 2, 45° is pi / 4, etc.
• transform.Rotate - allows to specify rotation angle as well as alignment - the location of rotation center.

For example:

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT)
)

rtl

rtl: bool = False

True to set text direction to right-to-left.

scale

scale: ScaleValue | None = None

Scale control along the 2D plane. Default scale factor is 1.0 - control is not scaled. 0.5 - the control is twice smaller, 2.0 - the control is twice larger.

Different scale multipliers can be specified for x and y axis, but setting Control.scale property to an instance of transform.Scale class.

Either scale or scale_x and scale_y could be specified, but not all of them, for example:

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    scale=Scale(scale_x=2, scale_y=0.5)
)

show_controls

show_controls: bool = True

Whether to show the video player controls.

shuffle_playlist

shuffle_playlist: bool = False

Defines whether the playlist should be shuffled.

subtitle_configuration

subtitle_configuration: VideoSubtitleConfiguration = field(
    default_factory=lambda: VideoSubtitleConfiguration()
)

Defines the subtitle configuration for the video player.

subtitle_track

subtitle_track: VideoSubtitleTrack | None = None

Defines the subtitle track for the video player.

title

title: str = 'flet-video'

Defines the name of the underlying window & process for native backend. This is visible inside the windows' volume mixer.

tooltip

tooltip: TooltipValue | None = None

The tooltip property supports both strings and Tooltip objects.

top

top: OptionalNumber = None

Effective inside Stack only. The distance that the child's top edge is inset from the top of the stack.

visible

visible: bool = True

Every control has visible property which is True by default - control is rendered on the page. Setting visible to False completely prevents control (and all its children if any) from rendering on a page canvas. Hidden controls cannot be focused or selected with a keyboard or mouse and they do not emit any events.

volume

volume: Number = 100.0

Defines the volume of the video player.

Note

It's value ranges between 0.0 to 100.0 (inclusive), where 0.0 is muted and 100.0 is the maximum volume. An exception will be raised if the value is outside this range.

wakelock

wakelock: bool = True

Whether to acquire wake lock while playing the video. When True, device's display will not go to standby/sleep while the video is playing.

width

width: OptionalNumber = None

Imposed Control width in virtual pixels.

before_event

before_event(e: ControlEvent)

before_update

before_update()

clean

clean() -> None

did_mount

did_mount()

get_current_position_async

get_current_position_async() -> Duration

RETURNS	DESCRIPTION
Duration	The current position of the currently playing media.

get_duration_async

get_duration_async() -> Duration

RETURNS	DESCRIPTION
Duration	The duration of the currently playing media.

init

init()

is_completed_async

is_completed_async() -> bool

RETURNS	DESCRIPTION
bool	True if video player has reached the end of the currently playing media, False otherwise.

is_isolated

is_isolated()

is_playing_async

is_playing_async() -> bool

RETURNS	DESCRIPTION
bool	True if the video player is currently playing, False otherwise.

jump_to

jump_to(media_index: int)

Jumps to the VideoMedia at the specified media_index in the playlist.

jump_to_async

jump_to_async(media_index: int)

Jumps to the VideoMedia at the specified media_index in the playlist.

next

next()

Jumps to the next VideoMedia in the playlist.

next_async

next_async()

Jumps to the next VideoMedia in the playlist.

pause

pause()

Pauses the video player.

pause_async

pause_async()

Pauses the video player.

play

play()

Starts playing the video.

play_async

play_async()

Starts playing the video.

play_or_pause

play_or_pause()

Cycles between play and pause states of the video player, i.e., plays if paused and pauses if playing.

play_or_pause_async

play_or_pause_async()

Cycles between play and pause states of the video player, i.e., plays if paused and pauses if playing.

playlist_add

playlist_add(media: VideoMedia)

Appends/Adds the provided media to the playlist.

playlist_add_async

playlist_add_async(media: VideoMedia)

Appends/Adds the provided media to the playlist.

playlist_remove

playlist_remove(media_index: int)

Removes the provided media from the playlist.

playlist_remove_async

playlist_remove_async(media_index: int)

Removes the provided media from the playlist.

previous

previous()

Jumps to the previous VideoMedia in the playlist.

previous_async

previous_async()

Jumps to the previous VideoMedia in the playlist.

seek

seek(position: DurationValue)

Seeks the currently playing VideoMedia from the playlist at the specified position.

seek_async

seek_async(position: DurationValue)

Seeks the currently playing VideoMedia from the playlist at the specified position.

stop

stop()

Stops the video player.

stop_async

stop_async()

Stops the video player.

update

update() -> None

will_unmount

will_unmount()