GUPnPAV.MediaCollection

g GObject.Object GObject.Object GUPnPAV.MediaCollection GUPnPAV.MediaCollection GObject.Object->GUPnPAV.MediaCollection

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

class

new_from_string (data)

add_item ()

get_author ()

get_items ()

get_mutable ()

get_string ()

get_title ()

set_author (author)

set_title (title)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

author

str

r/w/c

The author of this collection

data

str

w/co

Data to construct the playlist from

mutable

bool

r

The mutability of this collection

title

str

r/w/c

The title of this collection

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

GObject.Object

r

Class Details

class GUPnPAV.MediaCollection(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

GUPnPAV.MediaCollectionClass

classmethod new()
Returns:

A new GUPnPAV.MediaCollection.

Return type:

GUPnPAV.MediaCollection

Create a new writable media collection.

classmethod new_from_string(data)
Parameters:

data (str) – XML string.

Returns:

A new GUPnPAV.MediaCollection.

Return type:

GUPnPAV.MediaCollection

Parse a new GUPnPAV.MediaCollection from a block of XML data.

add_item()
Returns:

A new GUPnPAV.DIDLLiteItem object. Unref after use.

Return type:

GUPnPAV.DIDLLiteItem

get_author()
Returns:

The author of this media collection or None if not set.

Return type:

str

get_items()
Returns:

A GLib.List containing the elemens of this collection, in proper order. Unref all items and free the list after use.

Return type:

[GUPnPAV.DIDLLiteItem]

get_mutable()
Returns:

True if the collections is modifiable, False otherwise.

Return type:

bool

get_string()
Returns:

XML string representing this media collection. GLib.free() after use. If the colleciton is not mutable, returns a copy of the original string.

Return type:

str

get_title()
Returns:

The title of this media collection or None if not set.

Return type:

str or None

set_author(author)
Parameters:

author (str) – New author of this media collection.

Set the author of the media collection

set_title(title)
Parameters:

title (str) – New Title of this collection;

Set the title of a GUPnPAV.MediaCollection.

Property Details

GUPnPAV.MediaCollection.props.author
Name:

author

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The author of this media collection.

GUPnPAV.MediaCollection.props.data
Name:

data

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

Block of data to parse a collection from. If data is set upon construction it will override the other properties and create a unmutable collection parsed from data.

GUPnPAV.MediaCollection.props.mutable
Name:

mutable

Type:

bool

Default Value:

False

Flags:

READABLE

Whether this media collation is modifyable or not.

GUPnPAV.MediaCollection.props.title
Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The title of this media collection.