Clapper.Discoverer¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/en |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Clapper.Discoverer(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
An optional Discoverer feature to be added to the player.
Clapper.Discoverer
is a feature that wraps aroundGstPbutils.Discoverer
API to automatically discover items within [class`Clapper`.Queue]. Once media is scanned, all extra information of it will be filled within media item, this includes title, duration, chapters, etc.Please note that media items are also discovered during their playback by the player itself.
Clapper.Discoverer
is useful in situations where one wants to present to the user an updated media item before its playback, such as an UI that displays playback queue.Depending on your application, you can select an optimal [enum`Clapper`.DiscovererDiscoveryMode] that best suits your needs.
Use [const`Clapper`.HAVE_DISCOVERER] macro to check if Clapper API was compiled with this feature.
- classmethod new()¶
- Returns:
a new
Clapper.Discoverer
instance.- Return type:
Creates a new
Clapper.Discoverer
instance.
- get_discovery_mode()¶
- Returns:
a currently set
Clapper.DiscovererDiscoveryMode
.- Return type:
Get the [enum`Clapper`.DiscovererDiscoveryMode] of self.
- set_discovery_mode(mode)¶
- Parameters:
mode (
Clapper.DiscovererDiscoveryMode
) – aClapper.DiscovererDiscoveryMode
Set the [enum`Clapper`.DiscovererDiscoveryMode] of self.
Property Details¶
- Clapper.Discoverer.props.discovery_mode¶
- Name:
discovery-mode
- Type:
- Default Value:
- Flags:
Discoverer discovery mode.