General utilities

araviq6.util provides utility classes and functions which are not video pipeline components.

Media controller

araviq6.util.controller provides widget to control media player.

class araviq6.util.controller.ClickableSlider(*args: Any, **kwargs: Any)[source]

Bases: QSlider

QSlider whose groove can be clicked to move to position.

class araviq6.util.controller.SignalProtocol(*args, **kwargs)[source]

Bases: Protocol

class araviq6.util.controller.PlayerProtocol(*args, **kwargs)[source]

Bases: Protocol

class araviq6.util.controller.MediaController(*args: Any, **kwargs: Any)[source]

Bases: QWidget

Widget to control QtMultimedia.QMediaPlayer.

This controller can change the playback state and media position by playButton(), stopButton(), and slider().

setPlayer() sets the player to be controlled by this widget.

player() PlayerProtocol | None[source]

Media player which is controlled by self.

setPlayer(player: PlayerProtocol | None)[source]

Set player() and connect the signals.

Data path

araviq6.util.path provides access to data files at runtime.

araviq6.util.path.get_data_path(*paths: str) str[source]

Get path to data file.

Parameters:
pathsstr

Subpaths under araviq6/data/ directory.

Returns:
path

Absolute path to the data.

Examples

>>> from araviq6 import get_data_path
>>> get_data_path() 
'path/araviq6/data'
>>> get_data_path("hello.jpg") 
'path/araviq6/data/hello.jpg'
araviq6.util.path.get_samples_path(*paths: str) str

Get path to data file.

Parameters:
pathsstr

Subpaths under araviq6/data/ directory.

Returns:
path

Absolute path to the data.

Examples

>>> from araviq6 import get_data_path
>>> get_data_path() 
'path/araviq6/data'
>>> get_data_path("hello.jpg") 
'path/araviq6/data/hello.jpg'