Skip to main content

Video Upload

Facilitates video file uploads with preview and size validation.

Examples

Basic Example

The following example demonstrate some of the available functionality for read_video

from abstra.forms import read_video

file_response = read_video("Upload your video")
file = file_response.file # File object

Parameters

NameDescriptionType
labelThe label to display to the userstr
initial_valueThe initial value to display to the user. Defaults to "".Union[str, io.IOBase]
multipleWhether the user will be allowed to upload multiple files. Defaults to False.bool
max_file_sizeMaximum size allowed to be transfered in total in MB.float
disabledwhether the input is disabled. Defaults to False.bool
requiredWhether the input is required or not eg. "this field is required". Defaults to True.Union[bool, str]
hintA tooltip displayed to the user. Defaults to None.str
full_widthWhether the input should use full screen width. Defaults to False.bool
button_textWhat text to display on the button when the widget is not part of a Page. Defaults to 'Next'.str

Return Values

TypeDescription
Union[FileResponse, List[FileResponse]]A dict containing the video uploaded by the user: FileResponse(path: Path, file: BufferedReader). If the multiple flag is set as True, it might contain a list of FileResponses.