The VideoPlayerImpl class VideoPlayerImpl is the interface for video player and the impl class is supposed to be used for the video player. More...

#include <VideoPlayerImpl.h>

Inheritance diagram for VideoPlayerImpl:

Public Member Functions
	VideoPlayerImpl ()=default
	Construct a new Video Player Impl object.

	Q_DISABLE_COPY (VideoPlayerImpl)
	Construct a new q disable copy object.

virtual int	total_frame () const =0
	total_frame get the total frame of the video

virtual int	current_frame ()=0
	current_frame get the current frame of the video

virtual bool	rollto_nextFrame (CVImage &container)=0
	rollto_nextFrame roll to the next frame

virtual bool	peek_frame (CVImage &container, int frame_request)=0
	peek_frame peek the frame of the video

virtual VideoPlayerInfo	current_video_info () const =0
	current_video_info get the current video information

virtual void	escapeFrame ()=0
	escapeFrame escape the current frame

virtual void	jumpToFrame (int frame_request)=0
	jumpToFrame jump to the frame of the video

virtual bool	open (const char *filename, VideoPlayerOpenErrorCode &error_code)=0
	open open the video file

virtual bool	isOpened () const =0
	isOpened check if the video is opened

virtual void	close ()=0
	close close the video file

	VideoPlayerImpl ()=default
	Construct a new Video Player Impl object.

	Q_DISABLE_COPY (VideoPlayerImpl)
	Copy is not acceptable for video.

virtual int	total_frame () const =0
	total_frame get the total frame of the video

virtual int	current_frame ()=0
	current_frame get the current frame of the video

virtual bool	rollto_nextFrame (CVImage &container)=0
	rollto_nextFrame roll to the next frame

virtual bool	peek_frame (CVImage &container, int frame_request)=0
	peek_frame peek the frame of the video

virtual VideoPlayerInfo	current_video_info () const =0
	current_video_info get the current video information

virtual void	escapeFrame ()=0
	escapeFrame escape the current frame

virtual void	jumpToFrame (int frame_request)=0
	jumpToFrame jump to the frame of the video

virtual bool	open (const char *filename, VideoPlayerOpenErrorCode &error_code)=0
	open open the video file

virtual bool	isOpened () const =0
	isOpened check if the video is opened

virtual void	close ()=0
	close close the video file

Detailed Description

The VideoPlayerImpl class VideoPlayerImpl is the interface for video player and the impl class is supposed to be used for the video player.

Member Function Documentation

◆ close() [1/2]

virtual void VideoPlayerImpl::close ( )

pure virtual

close close the video file

Note: in syntax level, it means making the resources un-available (disabled the resources, shutdown this)

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ close() [2/2]

virtual void VideoPlayerImpl::close ( )

pure virtual

close close the video file

Note: in syntax level, it means making the resources un-available (disabled the resources, shutdown this)

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ current_frame() [1/2]

virtual int VideoPlayerImpl::current_frame ( )

pure virtual

current_frame get the current frame of the video

Returns: the current frame of the video

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ current_frame() [2/2]

virtual int VideoPlayerImpl::current_frame ( )

pure virtual

current_frame get the current frame of the video

Returns: the current frame of the video

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ current_video_info() [1/2]

virtual VideoPlayerInfo VideoPlayerImpl::current_video_info ( ) const

pure virtual

current_video_info get the current video information

Returns: the current video information

Note: for upper level widgets, we need to get from the info

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ current_video_info() [2/2]

virtual VideoPlayerInfo VideoPlayerImpl::current_video_info ( ) const

pure virtual

current_video_info get the current video information

Returns: the current video information

Note: for upper level widgets, we need to get from the info

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ escapeFrame() [1/2]

virtual void VideoPlayerImpl::escapeFrame ( )

pure virtual

escapeFrame escape the current frame

Note: frame is supposed to abolished, pointer should be moved forward

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ escapeFrame() [2/2]

virtual void VideoPlayerImpl::escapeFrame ( )

pure virtual

escapeFrame escape the current frame

Note: frame is supposed to abolished, pointer should be moved forward

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ isOpened() [1/2]

virtual bool VideoPlayerImpl::isOpened ( ) const

pure virtual

isOpened check if the video is opened

Returns: true if the video is opened

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ isOpened() [2/2]

virtual bool VideoPlayerImpl::isOpened ( ) const

pure virtual

isOpened check if the video is opened

Returns: true if the video is opened

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ jumpToFrame() [1/2]

virtual void VideoPlayerImpl::jumpToFrame ( int frame_request )

pure virtual

jumpToFrame jump to the frame of the video

Parameters

frame_request the frame requested

Note: this function should jump to the frame sync,

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ jumpToFrame() [2/2]

virtual void VideoPlayerImpl::jumpToFrame ( int frame_request )

pure virtual

jumpToFrame jump to the frame of the video

Parameters

frame_request the frame requested

Note: this function should jump to the frame sync,

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ open() [1/2]

virtual bool VideoPlayerImpl::open	(	const char *	filename,
		VideoPlayerOpenErrorCode &	error_code
	)

pure virtual

open open the video file

Parameters

filename	the file name to open
error_code	the error code

Returns: true if the video is opened successfully

Note: in syntax level, it means making the resources available

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ open() [2/2]

virtual bool VideoPlayerImpl::open	(	const char *	filename,
		VideoPlayerOpenErrorCode &	error_code
	)

pure virtual

open open the video file

Parameters

filename	the file name to open
error_code	the error code

Returns: true if the video is opened successfully

Note: in syntax level, it means making the resources available

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ peek_frame() [1/2]

virtual bool VideoPlayerImpl::peek_frame	(	CVImage &	container,
		int	frame_request
	)

pure virtual

peek_frame peek the frame of the video

Parameters

container	the container to store the frame
frame_request	the frame requested

Returns: true if the frame is peeked successfully

Note: the video will not be rolled, and the target frame will be request and if success, install to the container

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ peek_frame() [2/2]

virtual bool VideoPlayerImpl::peek_frame	(	CVImage &	container,
		int	frame_request
	)

pure virtual

peek_frame peek the frame of the video

Parameters

container	the container to store the frame
frame_request	the frame requested

Returns: true if the frame is peeked successfully

Note: the video will not be rolled, and the target frame will be request and if success, install to the container

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ rollto_nextFrame() [1/2]

virtual bool VideoPlayerImpl::rollto_nextFrame ( CVImage & container )

pure virtual

rollto_nextFrame roll to the next frame

Parameters

container the container to store the frame

Returns: true if the frame is rolled successfully

Note: this function should peek the frame sync, with the video is supposed to roll the next level

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ rollto_nextFrame() [2/2]

virtual bool VideoPlayerImpl::rollto_nextFrame ( CVImage & container )

pure virtual

rollto_nextFrame roll to the next frame

Parameters

container the container to store the frame

Returns: true if the frame is rolled successfully

Note: this function should peek the frame sync, with the video is supposed to roll the next level

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ total_frame() [1/2]

virtual int VideoPlayerImpl::total_frame ( ) const

pure virtual

total_frame get the total frame of the video

Returns: the total frame of the video

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

◆ total_frame() [2/2]

virtual int VideoPlayerImpl::total_frame ( ) const

pure virtual

total_frame get the total frame of the video

Returns: the total frame of the video

Implemented in VideoPlayerOpencvImpl, and VideoPlayerOpencvImpl.

The documentation for this class was generated from the following files:

extern_app/MediaPlayer/base/VideoPlayerImpl.h
extern_app/professionals/library/OpencvQtAdapter/core_library/videoplayer/VideoPlayerImpl.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ close() [1/2]

◆ close() [2/2]

◆ current_frame() [1/2]

◆ current_frame() [2/2]

◆ current_video_info() [1/2]

◆ current_video_info() [2/2]

◆ escapeFrame() [1/2]

◆ escapeFrame() [2/2]

◆ isOpened() [1/2]

◆ isOpened() [2/2]

◆ jumpToFrame() [1/2]

◆ jumpToFrame() [2/2]

◆ open() [1/2]

◆ open() [2/2]

◆ peek_frame() [1/2]

◆ peek_frame() [2/2]

◆ rollto_nextFrame() [1/2]

◆ rollto_nextFrame() [2/2]

◆ total_frame() [1/2]

◆ total_frame() [2/2]