MediaIndexerControl QML Type

Provides an interface to control the media indexer. More...

Import Statement:	import QtInterfaceFramework.Media 1.0
In C++:	QIfMediaIndexerControl
Inherits:	AbstractFeature

List of all members, including inherited members

Properties

backendUpdatesEnabled : bool
configurationId : string
discoveryMode : enumeration
discoveryResult : enumeration
isInitialized : bool
isValid : bool
preferredBackends : list<string>
progress : real
serviceObject : ServiceObject
state : enumeration

Methods

pause()
resume()
enumeration startAutoDiscovery()

Detailed Description

The MediaIndexerControl controls the media indexer. It provides a way to temporarily pause the indexing and resume it, as well as to inquire about the current state and progress of the indexing operation.

The MediaIndexerControl expects a single backend to be available. It is recommended to use it with discoveryMode set to AbstractFeature.AutoDiscovery.

Uses qtifmedia as configurationId for InterfaceFrameworkConfiguration based settings.

Property Documentation

backendUpdatesEnabled : bool

configurationId : string

discoveryMode : enumeration

discoveryResult : enumeration [read-only]

isInitialized : bool [read-only]

isValid : bool [read-only]

preferredBackends : list<string>

progress : real [read-only]

Holds the progress of the indexing operation.

The value is between 0 and 1.

serviceObject : ServiceObject

state : enumeration [read-only]

Holds the current state of the indexer.

It can be one of the following values:

Constant	Description
`Idle`	The indexer is currently idle and is waiting for new files to be indexed.
`Active`	The indexer is currently busy with indexing.
`Paused`	The indexer is paused, due to a call to pause().
`Error`	An error has occurred during the indexing operation.

Method Documentation

pause()

Pauses the currently ongoing indexing operation.

See also resume() and state.

resume()

Resumes from the Paused state and resumes the indexing operation.

See also pause() and state.

enumeration startAutoDiscovery()

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.