API Reference#

This page contains the API reference for the mne-videobrowser package.

Main Functions#

`browse_raw_with_video`	Synchronize MNE raw data browser(s) with a video browser.
`browse_raw_with_audio`	Synchronize MNE raw data browser(s) with an audio browser.
`browse_raw_with_video_and_audio`	Synchronize MNE raw data browser(s) with both video and audio browsers.

Timestamp Alignment#

`TimestampAligner`	Maps indices between two arrays of timestamps bidirectionally.
`compute_raw_timestamps`	Get the timestamps from raw data having Helsinki VideoMEG timing channel.

Media Classes#

Video#

`VideoFileCV2`	Video file reader for video files supported by OpenCV.
`VideoFileHelsinkiVideoMEG`	Video file reader for video files in Helsinki VideoMEG project format.

Audio#

AudioFileHelsinkiVideoMEG

Read an audio file in the Helsinki VideoMEG project format.

Browser Components#

These do not have to be interacted with if using any of the main functions above. However, they are useful if:

You want to browse just video or audio without MEG/EEG data (requires manual management of Qt application loop, see examples).
You want to extend this package with new browser types.
You want to build something custom using the browsers.

`AudioBrowser`	Qt widget for browsing audio with playback controls.
`VideoBrowser`	A browser for viewing video frames from one or more video files.
`SyncableBrowser`	Abstract base interface for browser widgets that can be synchronized.
`SyncableBrowserObject`	A helper class to combine SyncableBrowser and QObject.
`SyncableBrowserWidget`	A helper class to combine SyncableBrowser and QWidget.
`RawBrowserManager`	Manager for raw browser instance tailored for time syncing with video.