Public Types
enum	Selection { IMAGES = 0 , ALBUMS }

enum	VidBitRate { VBR04 = 0 , VBR05 , VBR10 , VBR12 , VBR15 , VBR20 , VBR25 , VBR30 , VBR40 , VBR45 , VBR50 , VBR60 , VBR80 }

enum	VidCodec { X264 = 0 , MPEG4 , MPEG2 , MJPEG , FLASH , WEBMVP8 , THEORA , WMV7 , WMV8 , WMV9 }

enum	VidFormat { AVI = 0 , MKV , MP4 , MPG }

enum	VidPlayer { NOPLAYER = 0 , INTERNAL , DESKTOP }

enum	VidStd { PAL = 0 , NTSC }

enum	VidType { QVGA = 0 , VCD1 , VCD2 , CVD1 , CVD2 , HVGA , SVCD1 , SDTV1 , SDTV2 , EDTV1 , SVCD2 , EGA , VGA , SDTV3 , EDTV2 , DVD1 , DVD2 , WVGA , SVGA , DVGA , XVGA , HDTV , WXGA1 , WXGA2 , SXGA , SXGAPLUS , WSXGA , HDPLUS , UXGA , WSXGAPLUS , BLUERAY , WUXGA , TXGA , QXGA , UWFHD , WQHD , WQXGA , QSXGA , QSXGAPLUS , WQXGAPLUS , WQSXGA , QUXGA , UHD4K , WQUXGA , HXGA , UHD5K , WHXGA , HSXGA , UHD6K , WHSXGA , HUXGA , UHD8K , WHUXGA , UW10K , UW16K }

Public Member Functions
void	readSettings (KConfigGroup &group)

int	videoBitRate () const
	Return the current video bit rate. More...

QString	videoCodec () const
	Return the current video ffmpeg codec name. More...

QString	videoFormat () const
	Return the current video format extension. More...

qreal	videoFrameRate () const
	Return the current video frame rate. More...

QSize	videoSize () const
	Return the current video size. More...

	VidSlideSettings ()

void	writeSettings (KConfigGroup &group)

	~VidSlideSettings ()

Static Public Member Functions
static bool	isVideoTVFormat (VidType type)
	Return true if type is a video TV format. If false is returned type is computer graphics screen format. More...

static QMap< VidBitRate, QString >	videoBitRateNames ()

static QMap< VidCodec, QString >	videoCodecNames ()

static QMap< VidFormat, QString >	videoFormatNames ()

static QMap< VidPlayer, QString >	videoPlayerNames ()

static QSize	videoSizeFromType (VidType type)
	Return the current size from a type of video. More...

static QMap< VidStd, QString >	videoStdNames ()

static QMap< VidType, QString >	videoTypeNames ()

Public Attributes
int	abitRate
	Encoded Audio stream bit rate in bit/s. More...

FileSaveConflictBox::ConflictRule	conflictRule
	Rule to follow if video file already exists. More...

int	imgFrames
	Amount of frames by image to encode in video (ex: 125 frames = 5 s at 25 img/s). More...

QList< QUrl >	inputAudio
	Soundtracks stream. More...

QList< QUrl >	inputImages
	Images stream. More...

QUrl	outputDir
	Encoded video stream directory. More...

VidPlayer	outputPlayer
	Open video stream in player at end. More...

QString	outputVideo
	Target video file encoded at end. More...

Selection	selMode
	Items selection mode. More...

TransitionMngr::TransType	transition
	Transition type between images. More...

VidBitRate	vbitRate
	Encoded Video stream bit rate in bit/s. More...

VidCodec	vCodec
	Encoded video codec. More...

EffectMngr::EffectType	vEffect
	Encoded video effect while displaying images. More...

VidFormat	vFormat
	Encoded video container format. More...

VidStd	vStandard
	Encoded Video standard => frame rate in img/s. More...

VidType	vType
	Encoded video type. More...

Member Enumeration Documentation

◆ Selection

enum Digikam::VidSlideSettings::Selection

Images selection mode

Enumerator
IMAGES
ALBUMS

◆ VidBitRate

enum Digikam::VidSlideSettings::VidBitRate

Video rates in bits per seconds.

Enumerator
VBR04	400000
VBR05	500000
VBR10	1000000
VBR12	1200000
VBR15	1500000
VBR20	2000000
VBR25	2500000
VBR30	3000000
VBR40	4000000
VBR45	4500000
VBR50	5000000
VBR60	6000000
VBR80	8000000

◆ VidCodec

enum Digikam::VidSlideSettings::VidCodec

Video Codecs

Enumerator
X264	https://en.wikipedia.org/wiki/X264
MPEG4	https://en.wikipedia.org/wiki/MPEG-4
MPEG2	https://en.wikipedia.org/wiki/MPEG-2
MJPEG	https://en.wikipedia.org/wiki/Motion_JPEG
FLASH	https://en.wikipedia.org/wiki/Adobe_Flash
WEBMVP8	https://en.wikipedia.org/wiki/VP8
THEORA	https://en.wikipedia.org/wiki/Theora
WMV7	https://en.wikipedia.org/wiki/Windows_Media_Video
WMV8	https://en.wikipedia.org/wiki/Windows_Media_Video
WMV9	https://en.wikipedia.org/wiki/Windows_Media_Video

◆ VidFormat

enum Digikam::VidSlideSettings::VidFormat

Video Container Formats

Enumerator
AVI	https://en.wikipedia.org/wiki/Audio_Video_Interleave
MKV	https://en.wikipedia.org/wiki/Matroska
MP4	https://en.wikipedia.org/wiki/MPEG-4_Part_14
MPG	https://en.wikipedia.org/wiki/MPEG-2

◆ VidPlayer

enum Digikam::VidSlideSettings::VidPlayer

Video player to use

Enumerator
NOPLAYER
INTERNAL
DESKTOP

◆ VidStd

enum Digikam::VidSlideSettings::VidStd

Video Standards

Enumerator
PAL	25 FPS
NTSC	29.97 FPS

◆ VidType

enum Digikam::VidSlideSettings::VidType

Video types (size of target screen) See https://en.wikipedia.org/wiki/List_of_common_resolutions#Digital_TV_standards https://en.wikipedia.org/wiki/Aspect_ratio_(image)

Enumerator
QVGA	320 x 180 - 16:9 - Computer Graphics
VCD1	352 x 240 - 7:5 - Digital TV
VCD2	352 x 288 - 6:5 - Digital TV
CVD1	352 x 480 - 11:15 - Digital TV
CVD2	352 x 576 - 11:18 - Digital TV
HVGA	480 x 270 - 16:9 - Computer Graphics
SVCD1	480 x 480 - 1:1 - Digital TV
SDTV1	528 x 480 - 11:10 - Digital TV
SDTV2	544 x 480 - 17:15 - Digital TV
EDTV1	544 x 576 - 17;18 - Digital TV
SVCD2	480 x 576 - 5:6 - Digital TV
EGA	640 x 350 - 16:9 - Computer Graphics
VGA	640 x 480 - 4:3 - Computer Graphics
SDTV3	704 x 480 - 22:15 - Digital TV
EDTV2	704 x 576 - 11;9 - Digital TV
DVD1	720 x 480 - 3:2 - Digital TV
DVD2	720 x 576 - 5:4 - Digital TV
WVGA	800 x 450 - 16:9 - Computer Graphics
SVGA	800 x 600 - 4:3 - Computer Graphics
DVGA	960 x 640 - 3:2 - Computer Graphics
XVGA	1024 x 576 - 16:9 - Computer Graphics
HDTV	1280 x 720 - 16:9 - Digital TV
WXGA1	1280 x 768 - 5:3 - Computer Graphics
WXGA2	1280 x 800 - 8:5 - Computer Graphics
SXGA	1280 x 1024 - 5:4 - Computer Graphics
SXGAPLUS	1400 x 1050 - 4:3 - Computer Graphics
WSXGA	1440 x 900 - 8:5 - Computer Graphics
HDPLUS	1600 x 900 - 16:9 - Digital TV
UXGA	1600 x 1200 - 4:3 - Computer Graphics
WSXGAPLUS	1680 x 1050 - 8:5 - Computer Graphics
BLUERAY	1920 x 1080 - 19:9 - Digital TV
WUXGA	1920 x 1200 - 8:5 - Computer Graphics
TXGA	1920 x 1440 - 7:5 - Computer Graphics
QXGA	2048 x 1536 - 4:3 - Computer Graphics
UWFHD	2560 < 1080 - 21:9 - Computer Graphics
WQHD	2560 x 1440 - 16:9 - Computer Graphics
WQXGA	2560 x 1600 - 8:5 - Computer Graphics
QSXGA	2560 x 2048 - 5:4 - Computer Graphics
QSXGAPLUS	2800 x 2100 - 4:3 - Computer Graphics
WQXGAPLUS	3200 x 1800 - 16:9 - Computer Graphics
WQSXGA	3200 x 2048 - 25:16 - Computer Graphics
QUXGA	3200 x 2400 - 4:3 - Computer Graphics
UHD4K	3840 x 2160 - 19:9 - Digital TV
WQUXGA	3840 x 2400 - 8:5 - Computer Graphics
HXGA	4096 x 3072 - 4:3 - Computer Graphics
UHD5K	5120 x 2880 - 16:9 - Computer Graphics
WHXGA	5120 x 3200 - 8:5 - Computer Graphics
HSXGA	5120 x 4096 - 5:4 - Computer Graphics
UHD6K	6016 x 3384 - 16:9 - Computer Graphics
WHSXGA	6400 x 4096 - 25:16 - Computer Graphics
HUXGA	6400 x 4800 - 4:3 - Computer Graphics
UHD8K	7680 x 4320 - 16:9 - Digital TV
WHUXGA	7680 x 4800 - 8:5 - Computer Graphics
UW10K	10240 x 4320 - 21:9 - Computer Graphics
UW16K	15360 x 8640 - 16:9 - Computer Graphics

Constructor & Destructor Documentation

◆ VidSlideSettings()

Digikam::VidSlideSettings::VidSlideSettings ( )

explicit

◆ ~VidSlideSettings()

Digikam::VidSlideSettings::~VidSlideSettings ( )

Member Function Documentation

◆ isVideoTVFormat()

bool Digikam::VidSlideSettings::isVideoTVFormat ( VidType type )

static

Return true if type is a video TV format. If false is returned type is computer graphics screen format.

References BLUERAY, CVD1, CVD2, DVD1, DVD2, EDTV1, EDTV2, HDTV, SDTV1, SDTV2, SDTV3, SVCD1, SVCD2, UHD4K, UHD8K, VCD1, and VCD2.

◆ readSettings()

void Digikam::VidSlideSettings::readSettings ( KConfigGroup & group )

Read and write settings in config file between sessions.

References abitRate, BLUERAY, conflictRule, IMAGES, imgFrames, INTERNAL, MP4, Digikam::EffectMngr::None, Digikam::TransitionMngr::None, outputDir, outputPlayer, Digikam::FileSaveConflictBox::OVERWRITE, PAL, selMode, transition, vbitRate, VBR12, vCodec, vEffect, vFormat, vStandard, vType, and X264.

◆ videoBitRate()

int Digikam::VidSlideSettings::videoBitRate ( ) const

Return the current video bit rate.

References vbitRate, VBR04, VBR05, VBR10, VBR15, VBR20, VBR25, VBR30, VBR40, VBR45, VBR50, VBR60, and VBR80.

◆ videoBitRateNames()

QMap< VidSlideSettings::VidBitRate, QString > Digikam::VidSlideSettings::videoBitRateNames ( )

static

References VBR04, VBR05, VBR10, VBR12, VBR15, VBR20, VBR25, VBR30, VBR40, VBR45, VBR50, VBR60, and VBR80.

◆ videoCodec()

QString Digikam::VidSlideSettings::videoCodec ( ) const

Return the current video ffmpeg codec name.

References FLASH, MJPEG, MPEG2, MPEG4, THEORA, vCodec, WEBMVP8, WMV7, WMV8, and WMV9.

Referenced by DigikamGenericVideoSlideShowPlugin::VidSlideVideoPage::VidSlideVideoPage().

◆ videoCodecNames()

QMap< VidSlideSettings::VidCodec, QString > Digikam::VidSlideSettings::videoCodecNames ( )

static

References MPEG2, MPEG4, and X264.

◆ videoFormat()

QString Digikam::VidSlideSettings::videoFormat ( ) const

Return the current video format extension.

References AVI, MKV, MPG, and vFormat.

Referenced by DigikamGenericVideoSlideShowPlugin::VidSlideOutputPage::VidSlideOutputPage().

◆ videoFormatNames()

QMap< VidSlideSettings::VidFormat, QString > Digikam::VidSlideSettings::videoFormatNames ( )

static

References AVI, MKV, MP4, and MPG.

◆ videoFrameRate()

qreal Digikam::VidSlideSettings::videoFrameRate ( ) const

Return the current video frame rate.

References NTSC, and vStandard.

◆ videoPlayerNames()

QMap< VidSlideSettings::VidPlayer, QString > Digikam::VidSlideSettings::videoPlayerNames ( )

static

References DESKTOP, INTERNAL, and NOPLAYER.

◆ videoSize()

QSize Digikam::VidSlideSettings::videoSize ( ) const

Return the current video size.

References videoSizeFromType(), and vType.

◆ videoSizeFromType()

QSize Digikam::VidSlideSettings::videoSizeFromType ( VidType type )

static

Return the current size from a type of video.

References CVD1, CVD2, DVD1, DVD2, DVGA, EDTV1, EDTV2, EGA, HDPLUS, HDTV, HSXGA, HUXGA, HVGA, HXGA, QSXGA, QSXGAPLUS, QUXGA, QVGA, QXGA, SDTV1, SDTV2, SDTV3, SVCD1, SVCD2, SVGA, SXGA, SXGAPLUS, TXGA, UHD4K, UHD5K, UHD6K, UHD8K, UW10K, UW16K, UWFHD, UXGA, VCD1, VCD2, VGA, WHSXGA, WHUXGA, WHXGA, WQHD, WQSXGA, WQUXGA, WQXGA, WQXGAPLUS, WSXGA, WSXGAPLUS, WUXGA, WVGA, WXGA1, WXGA2, and XVGA.

Referenced by videoSize().

◆ videoStdNames()

QMap< VidSlideSettings::VidStd, QString > Digikam::VidSlideSettings::videoStdNames ( )

static

References NTSC, and PAL.

◆ videoTypeNames()

QMap< VidSlideSettings::VidType, QString > Digikam::VidSlideSettings::videoTypeNames ( )

static

Helper methods to fill combobox from GUI.

References BLUERAY, CVD1, CVD2, DVD1, DVD2, DVGA, EDTV1, EDTV2, EGA, HDPLUS, HDTV, HSXGA, HUXGA, HVGA, HXGA, QSXGA, QSXGAPLUS, QUXGA, QVGA, QXGA, SDTV1, SDTV2, SDTV3, SVCD1, SVCD2, SVGA, SXGA, SXGAPLUS, TXGA, UHD4K, UHD5K, UHD6K, UHD8K, UW10K, UW16K, UWFHD, UXGA, VCD1, VCD2, VGA, WHSXGA, WHUXGA, WHXGA, WQHD, WQSXGA, WQUXGA, WQXGA, WQXGAPLUS, WSXGA, WSXGAPLUS, WUXGA, WVGA, WXGA1, WXGA2, and XVGA.

◆ writeSettings()

void Digikam::VidSlideSettings::writeSettings ( KConfigGroup & group )

References abitRate, conflictRule, imgFrames, outputDir, outputPlayer, selMode, transition, vbitRate, vCodec, vEffect, vFormat, vStandard, and vType.

Member Data Documentation

◆ abitRate

int Digikam::VidSlideSettings::abitRate

Encoded Audio stream bit rate in bit/s.

Referenced by readSettings(), and writeSettings().

◆ conflictRule

FileSaveConflictBox::ConflictRule Digikam::VidSlideSettings::conflictRule

Rule to follow if video file already exists.

Referenced by readSettings(), and writeSettings().

◆ imgFrames

int Digikam::VidSlideSettings::imgFrames

Amount of frames by image to encode in video (ex: 125 frames = 5 s at 25 img/s).

Referenced by readSettings(), and writeSettings().

◆ inputAudio

QList<QUrl> Digikam::VidSlideSettings::inputAudio

Soundtracks stream.

◆ inputImages

QList<QUrl> Digikam::VidSlideSettings::inputImages

Images stream.

◆ outputDir

QUrl Digikam::VidSlideSettings::outputDir

Encoded video stream directory.

Referenced by readSettings(), and writeSettings().

◆ outputPlayer

VidPlayer Digikam::VidSlideSettings::outputPlayer

Open video stream in player at end.

Referenced by readSettings(), and writeSettings().

◆ outputVideo

QString Digikam::VidSlideSettings::outputVideo

Target video file encoded at end.

◆ selMode

Selection Digikam::VidSlideSettings::selMode

Items selection mode.

Referenced by readSettings(), and writeSettings().

◆ transition

TransitionMngr::TransType Digikam::VidSlideSettings::transition

Transition type between images.

Referenced by readSettings(), and writeSettings().

◆ vbitRate

VidBitRate Digikam::VidSlideSettings::vbitRate

Encoded Video stream bit rate in bit/s.

Referenced by readSettings(), videoBitRate(), and writeSettings().

◆ vCodec

VidCodec Digikam::VidSlideSettings::vCodec

Encoded video codec.

Referenced by readSettings(), videoCodec(), DigikamGenericVideoSlideShowPlugin::VidSlideVideoPage::VidSlideVideoPage(), and writeSettings().

◆ vEffect

EffectMngr::EffectType Digikam::VidSlideSettings::vEffect

Encoded video effect while displaying images.

Referenced by readSettings(), and writeSettings().

◆ vFormat

VidFormat Digikam::VidSlideSettings::vFormat

Encoded video container format.

Referenced by readSettings(), videoFormat(), DigikamGenericVideoSlideShowPlugin::VidSlideOutputPage::VidSlideOutputPage(), and writeSettings().

◆ vStandard

VidStd Digikam::VidSlideSettings::vStandard

Encoded Video standard => frame rate in img/s.

Referenced by readSettings(), videoFrameRate(), and writeSettings().

◆ vType

VidType Digikam::VidSlideSettings::vType

Encoded video type.

Referenced by readSettings(), videoSize(), and writeSettings().

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

core/libs/video/manager/vidslidesettings.h
core/libs/video/manager/vidslidesettings.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Enumeration Documentation

◆ Selection

◆ VidBitRate

◆ VidCodec

◆ VidFormat

◆ VidPlayer

◆ VidStd

◆ VidType

Constructor & Destructor Documentation

◆ VidSlideSettings()

◆ ~VidSlideSettings()

Member Function Documentation

◆ isVideoTVFormat()

◆ readSettings()

◆ videoBitRate()

◆ videoBitRateNames()

◆ videoCodec()

◆ videoCodecNames()

◆ videoFormat()

◆ videoFormatNames()

◆ videoFrameRate()

◆ videoPlayerNames()

◆ videoSize()

◆ videoSizeFromType()

◆ videoStdNames()

◆ videoTypeNames()

◆ writeSettings()

Member Data Documentation

◆ abitRate

◆ conflictRule

◆ imgFrames

◆ inputAudio

◆ inputImages

◆ outputDir

◆ outputPlayer

◆ outputVideo

◆ selMode

◆ transition

◆ vbitRate

◆ vCodec

◆ vEffect

◆ vFormat

◆ vStandard

◆ vType