GUPnPAV.DIDLLiteContainer¶

Subclasses:: None

Methods¶

Inherited:: GUPnPAV.DIDLLiteObject (63), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`add_create_class` (create_class)
	`add_create_class_full` (create_class, include_derived)
	`add_search_class` (search_class)
	`add_search_class_full` (search_class, include_derived)
	`container_update_id_is_set` ()
	`get_child_count` ()
	`get_container_update_id` ()
	`get_create_classes` ()
	`get_create_classes_full` ()
	`get_search_classes` ()
	`get_searchable` ()
	`get_storage_used` ()
	`get_total_deleted_child_count` ()
	`set_child_count` (child_count)
	`set_container_update_id` (update_id)
	`set_searchable` (searchable)
	`set_storage_used` (storage_used)
	`set_total_deleted_child_count` (count)
	`total_deleted_child_count_is_set` ()
	`unset_container_update_id` ()
	`unset_total_deleted_child_count` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: GUPnPAV.DIDLLiteObject (22)

Name	Type	Flags	Short Description
`child-count`	`int`	r/w	The child count of this container.
`container-update-id`	`int`	r/w	Update ID of this container.
`searchable`	`bool`	r/w	Whether this container is searchable.
`storage-used`	`int`	r/w	The Number of bytes used by all child items of this container.
`total-deleted-child-count`	`int`	r/w	Total deleted child count of this container.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GUPnPAV.DIDLLiteObject`	r

Class Details¶

class GUPnPAV.DIDLLiteContainer(**kwargs)¶

Bases:: GUPnPAV.DIDLLiteObject
Abstract:: No
Structure:: GUPnPAV.DIDLLiteContainerClass

add_create_class(create_class)¶

Parameters:: create_class (str) – The createClass to add.

Add a new create class to the self. includeDerived defaults to “0”.

add_create_class_full(create_class, include_derived)¶

Parameters:

create_class (str) – The createClass to add.
include_derived (bool) – Whether object with dervied classes may be created in this container or not.

Add a new create class to the self.

add_search_class(search_class)¶

Parameters:: search_class (str) – The searchClass to add.

Add a new search class to the self.

add_search_class_full(search_class, include_derived)¶

Parameters:

search_class (str) – The searchClass to add.
include_derived (bool) – includeDerived attribute of the DIDL

Add a new search class to the self.

container_update_id_is_set()¶

Returns:: True if update ID is set, otherwise False
Return type:: bool

Get whether the container update ID of the self is set.

get_child_count()¶

Returns:: The child count of the self, or -1 if it is unknown.
Return type:: int

Get the child count of the self. If the child count is unknown, -1 is returned.

get_container_update_id()¶

Returns:: The container update ID of the self.
Return type:: int

Get the container update ID of the self.

get_create_classes()¶

Returns:: The list of create classes belonging to self, or None. #g_list_free the returned list after usage and GLib.free each string in it.
Return type:: [str]

Gets the list of create classes of the self.

get_create_classes_full()¶

Returns:: The list of create classes belonging to self, or None. #g_list_free the returned list after usage and unref each object in it.
Return type:: [GUPnPAV.DIDLLiteCreateClass]

Gets the list of create classes of the self.

get_search_classes()¶

Returns:: The list of search classes belonging to self, or None. #g_list_free the returned list after usage and GLib.free each string in it.
Return type:: [str]

Gets the list of search classes of the self.

get_searchable()¶

Returns:: True if self is searchable.
Return type:: bool

Checks whether self is searchable.

get_storage_used()¶

Returns:: The number of bytes used by all children of the self, or -1 if it is unknown.
Return type:: int

Get the number of bytes used by all child items of the self. If storage used is unknown, -1 is returned.

get_total_deleted_child_count()¶

Returns:: The total deleted child count of the self.
Return type:: int

Get the total deleted child count of the self.

set_child_count(child_count)¶

Parameters:: child_count (int) – The child count

Set the child count of the self.

set_container_update_id(update_id)¶

Parameters:: update_id (int) – The container update ID

Set the container update ID of the self.

set_searchable(searchable)¶

Parameters:: searchable (bool) – The searchibility

(Un)set the searchibility of self.

set_storage_used(storage_used)¶

Parameters:: storage_used (int) – The number of bytes used by all child items of the self or -1 if unknown.

Set the number of bytes used by all child items of the self.

set_total_deleted_child_count(count)¶

Parameters:: count (int) – The container update ID

Set the container update ID of the self.

total_deleted_child_count_is_set()¶

Returns:: True if property is set, otherwise False
Return type:: bool

Get whether the total deleted child conut of the self is set.

unset_container_update_id()¶: Unset the container update ID property of the self.

unset_total_deleted_child_count()¶: Unset the total deleted child count property of the self.

Property Details¶

GUPnPAV.DIDLLiteContainer.props.child_count¶

Name:: child-count
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The child count of this container.

GUPnPAV.DIDLLiteContainer.props.container_update_id¶

Name:: container-update-id
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Update ID of this container.

GUPnPAV.DIDLLiteContainer.props.searchable¶

Name:: searchable
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether this container is searchable.

GUPnPAV.DIDLLiteContainer.props.storage_used¶

Name:: storage-used
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The number of bytes used by all child items of this container.

GUPnPAV.DIDLLiteContainer.props.total_deleted_child_count¶

Name:: total-deleted-child-count
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Total deleted child count of this container.