Version

Quick search

Video

The Video widget is used to display video files and streams. Depending on your Video core provider, platform, and plugins, you will be able to play different formats. For example, gstreamer is more versatile, and can read many video containers and codecs such as MKV, OGV, AVI, MOV, FLV (if the correct gstreamer plugins are installed). Our VideoBase implementation is used under the hood.

Video loading is asynchronous - many properties are not available until the video is loaded (when the texture is created):

def on_position_change(instance, value):
    print('The position in the video is', value)

def on_duration_change(instance, value):
    print('The duration of the video is', value)

video = Video(source='PandaSneezes.avi')
video.bind(
    position=on_position_change,
    duration=on_duration_change
)

One can define a preview image which gets displayed until the video is started/loaded by passing preview to the constructor:

video = Video(
    source='PandaSneezes.avi',
    preview='PandaSneezes_preview.png'
)

One can display the placeholder image when the video stops by reacting on eos:

def on_eos_change(self, inst, val):
    if val and self.preview:
        self.set_texture_from_resource(self.preview)

video.bind(eos=on_eos_change)
class kivy.uix.video.Video(**kwargs)

Bases: kivy.uix.image.Image

Video class. See module documentation for more information.

seek(percent, precise=True)
Change the position to a percentage (strictly, a proportion)

of duration.

Parameters:
percent: float or int

Position to seek as a proportion of the total duration, must be between 0-1.

precise: bool, defaults to True

Precise seeking is slower, but seeks to exact requested percent.

Warning

Calling seek() before the video is loaded has no effect.

New in version 1.2.0.

Changed in version 1.10.1: The precise keyword argument has been added.

unload()

Unload the video. The playback will be stopped.

New in version 1.8.0.