GUPnPAV.DIDLLiteResource¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_audio_channels` ()
	`get_bitrate` ()
	`get_bits_per_sample` ()
	`get_cleartext_size` ()
	`get_color_depth` ()
	`get_dlna_namespace` ()
	`get_duration` ()
	`get_height` ()
	`get_import_uri` ()
	`get_protection` ()
	`get_protocol_info` ()
	`get_pv_namespace` ()
	`get_sample_freq` ()
	`get_size` ()
	`get_size64` ()
	`get_subtitle_file_type` ()
	`get_subtitle_file_uri` ()
	`get_track_total` ()
	`get_update_count` ()
	`get_uri` ()
	`get_width` ()
	`get_xml_node` ()
	`set_audio_channels` (n_channels)
	`set_bitrate` (bitrate)
	`set_bits_per_sample` (sample_size)
	`set_cleartext_size` (cleartext_size)
	`set_color_depth` (color_depth)
	`set_duration` (duration)
	`set_height` (height)
	`set_import_uri` (import_uri)
	`set_protection` (protection)
	`set_protocol_info` (info)
	`set_sample_freq` (sample_freq)
	`set_size` (size)
	`set_size64` (size)
	`set_subtitle_file_type` (type)
	`set_subtitle_file_uri` (uri)
	`set_track_total` (track_total)
	`set_update_count` (update_count)
	`set_uri` (uri)
	`set_width` (width)
	`track_total_is_set` ()
	`unset_track_total` ()
	`unset_update_count` ()
	`update_count_is_set` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`audio-channels`	`int`	r/w	The number of audio channels in this resource.
`bitrate`	`int`	r/w	The bitrate of this resource.
`bits-per-sample`	`int`	r/w	The sample size of this resource.
`cleartext-size`	`int`	r/w	The clear text size (in bytes) of this resource.
`color-depth`	`int`	r/w	The color-depth of this image/video resource.
`dlna-namespace`	`int`	r/w/co	Pointer to the DLNA metadata namespace registered with the resource.
`duration`		r/w	The duration (in seconds) of this resource.
`height`	`int`	r/w	The height of this image/video resource.
`import-uri`	`str`	r/w	The import URI associated with this resource
`protection`	`str`	r/w	The protection system used by this resource.
`protocol-info`	`GUPnPAV.ProtocolInfo`	r/w	The protocol info associated with this resource
`pv-namespace`	`int`	r/w/co	Pointer to the PV metadata namespace registered with the resource.
`sample-freq`	`int`	r/w	The sample frequency of this resource.
`size`		r/w	The size (in bytes) of this resource.
`size64`	`int`	r/w	The size (in bytes) of this resource.
`subtitle-file-type`	`str`	r/w	Type of the external subtitle file
`subtitle-file-uri`	`str`	r/w	Uri of the external subtitle file
`track-total`	`int`	r/w	The number of tracks of this resource.
`update-count`	`int`	r/w	The update count of this resource.
`uri`	`str`	r/w	The URI associated with this resource
`width`	`int`	r/w	The width of this image/video resource.
`xml-node`	`int`	r/w/co	The pointer to res node in XML document.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class GUPnPAV.DIDLLiteResource(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GUPnPAV.DIDLLiteResourceClass

get_audio_channels()¶

Returns:: The number of audio channels in the self or -1.
Return type:: int

Get the number of audio channels in the self.

get_bitrate()¶

Returns:: The bitrate (in bytes per second) of the self or -1.
Return type:: int

Get the bitrate (in bytes per second) of the self.

get_bits_per_sample()¶

Returns:: The number of bits per sample of the self or -1.
Return type:: int

Get the sample size of the self.

get_cleartext_size()¶

Returns:: The size (in bytes) of the self or -1.
Return type:: int

Get the size (in bytes) of the self.

get_color_depth()¶

Returns:: The color depth of the self or -1.
Return type:: int

Get the color-depth of this image/video resource.

get_dlna_namespace()¶

Returns:: The pointer to DLNA namespace in XML document.
Return type:: libxml2.NsPtr

Get the pointer to the DLNA metadata namespace registered with the XML document containing this object.

get_duration()¶

Returns:: The duration (in seconds) of the self or -1.
Return type:: int

Get the duration (in seconds) of the self.

get_height()¶

Returns:: The height of the self or -1.
Return type:: int

Get the height of this image/video resource.

get_import_uri()¶

Returns:: The import URI or None.
Return type:: str

Get the import URI associated with the self.

get_protection()¶

Returns:: The protection system in use by the self or None.
Return type:: str

Get the protection system used by the self.

get_protocol_info()¶

Returns:: The protocol info associated with the self or None. The returned object must not be unrefed.
Return type:: GUPnPAV.ProtocolInfo or None

Get the protocol info associated with the self.

get_pv_namespace()¶

Returns:: The pointer to DLNA namespace in XML document.
Return type:: libxml2.NsPtr

Get the pointer to the DLNA metadata namespace registered with the XML document containing this object.

get_sample_freq()¶

Returns:: The sample frequency of the self or -1.
Return type:: int

Get the sample frequency of the self.

get_size()¶

Returns:: The size (in bytes) of the self or -1.
Return type:: int

Get the size (in bytes) of the self.

get_size64()¶

Returns:: The size (in bytes) of the self or -1.
Return type:: int

Get the size (in bytes) of the self.

get_subtitle_file_type()¶

Returns:: The content of the subtitleFileType property or None
Return type:: str

New in version 0.12.4.

get_subtitle_file_uri()¶

Returns:: The content of the subtitleFileUri property or None when not set.
Return type:: str

New in version 0.12.4.

get_track_total()¶

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

Get the total track count of this resource.

get_update_count()¶

Returns:: The update count of the self.
Return type:: int

Get the update count of this resource.

get_uri()¶

Returns:: The of URI the self or None.
Return type:: str or None

Get the URI associated with the self.

get_width()¶

Returns:: The width of this image/video resource or -1.
Return type:: int

Get the width of this image/video resource.

get_xml_node()¶

Returns:: The pointer to res node in XML document.
Return type:: libxml2.Node

Get the pointer to res node in XML document.

set_audio_channels(n_channels)¶

Parameters:: n_channels (int) – The number of channels

Set the number of audio channels in the self. Passing a negative number will unset this property.

set_bitrate(bitrate)¶

Parameters:: bitrate (int) – The bitrate

Set the bitrate (in bytes per second) of the self. Passing a negative number will unset this property.

set_bits_per_sample(sample_size)¶

Parameters:: sample_size (int) – The number of bits per sample

Set the sample size of the self. Passing a negative number will unset this property.

set_cleartext_size(cleartext_size)¶

Parameters:: cleartext_size (int) – The size (in bytes)

Set the size (in bytes) of the self. Passing a negative number will unset this property.

set_color_depth(color_depth)¶

Parameters:: color_depth (int) – The color-depth

Set the color-depth of this image/video resource. Passing a negative number will unset this property.

set_duration(duration)¶

Parameters:: duration (int) – The duration (in seconds)

Set the duration (in seconds) of the self. Passing a negative number will unset this property.

set_height(height)¶

Parameters:: height (int) – The height

Set the height of this image/video resource. Setting both width and height to a negative number will unset the resolution property.

set_import_uri(import_uri)¶

Parameters:: import_uri (str) – The URI as string

Set the import URI associated with the self.

set_protection(protection)¶

Parameters:: protection (str) – The protection system identifier as string

Set the protection system used by the self. Passing a negative number will unset this property.

set_protocol_info(info)¶

Parameters:: info (GUPnPAV.ProtocolInfo) – The protocol string

Set the protocol info associated with the self.

set_sample_freq(sample_freq)¶

Parameters:: sample_freq (int) – The sample frequency

Set the sample frequency of the self. Passing a negative number will unset this property.

set_size(size)¶

Parameters:: size (int) – The size (in bytes)

Set the size (in bytes) of the self. Passing a negative number will unset this property.

set_size64(size)¶

Parameters:: size (int) – The size (in bytes)

Set the size (in bytes) of the self. Passing a negative number will unset this property.

set_subtitle_file_type(type)¶

Parameters:: type (str or None) – An URI to an external subtitle file

Set the type of an external subtitle file, specified via pv:subtitleFileUri using GUPnPAV.DIDLLiteResource.set_subtitle_file_uri().

When type is None the value is removed.

New in version 0.12.4.

set_subtitle_file_uri(uri)¶

Parameters:: uri (str or None) – An URI to an external subtitle file or None to remove.

Set the URI of an external subtitle file to be used with this resource. When uri is None the value is removed.

New in version 0.12.4.

set_track_total(track_total)¶

Parameters:: track_total (int) – The total number of tracks in this resource

Set the total number of tracks in this resource.

set_update_count(update_count)¶

Parameters:: update_count (int) – The update_count

Set the update count of this resource.

set_uri(uri)¶

Parameters:: uri (str) – The URI as string

Set the URI associated with the self.

set_width(width)¶

Parameters:: width (int) – The width

Set the width of this image/video resource. Setting both width and height to a negative number will unset the resolution property.

track_total_is_set()¶

Returns:: True if set, otherwise False.
Return type:: bool

Check whether the total track count property of this resource is set.

unset_track_total()¶: Unset the total track count of this resource.

unset_update_count()¶: Unset the update count of this resource.

update_count_is_set()¶

Returns:: True if set, otherwise False.
Return type:: bool

Check whether the update count property of this resource is set.

Property Details¶

GUPnPAV.DIDLLiteResource.props.audio_channels¶

Name:: audio-channels
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The number of audio channels in this resource.

GUPnPAV.DIDLLiteResource.props.bitrate¶

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

The bitrate of this resource.

GUPnPAV.DIDLLiteResource.props.bits_per_sample¶

Name:: bits-per-sample
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The sample size of this resource.

GUPnPAV.DIDLLiteResource.props.cleartext_size¶

Name:: cleartext-size
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The clear text size (in bytes) of this resource.

GUPnPAV.DIDLLiteResource.props.color_depth¶

Name:: color-depth
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The color-depth of this image/video resource.

GUPnPAV.DIDLLiteResource.props.dlna_namespace¶

Name:: dlna-namespace
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Pointer to the DLNA metadata namespace registered with the resource object.

GUPnPAV.DIDLLiteResource.props.duration¶

Name:: duration
Type:
Default Value:: -1
Flags:: READABLE, WRITABLE

The duration (in seconds) of this resource.

GUPnPAV.DIDLLiteResource.props.height¶

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

The height of this image/video resource.

GUPnPAV.DIDLLiteResource.props.import_uri¶

Name:: import-uri
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The Import URI associated with this resource.

GUPnPAV.DIDLLiteResource.props.protection¶

Name:: protection
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The protection system used for this resource.

GUPnPAV.DIDLLiteResource.props.protocol_info¶

Name:: protocol-info
Type:: GUPnPAV.ProtocolInfo
Default Value:: None
Flags:: READABLE, WRITABLE

The protocol info associated with this resource.

GUPnPAV.DIDLLiteResource.props.pv_namespace¶

Name:: pv-namespace
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Pointer to the PV metadata namespace registered with the resource object.

GUPnPAV.DIDLLiteResource.props.sample_freq¶

Name:: sample-freq
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

The sample frequency of this resource.

GUPnPAV.DIDLLiteResource.props.size¶

Name:: size
Type:
Default Value:: -1
Flags:: READABLE, WRITABLE

The size (in bytes) of this resource.

GUPnPAV.DIDLLiteResource.props.size64¶

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

The size (in bytes) of this resource.

GUPnPAV.DIDLLiteResource.props.subtitle_file_type¶

Name:: subtitle-file-type
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Type of external subtitle file. Usually SRT or SMI.

GUPnPAV.DIDLLiteResource.props.subtitle_file_uri¶

Name:: subtitle-file-uri
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Uri to external subtitle file.

GUPnPAV.DIDLLiteResource.props.track_total¶

Name:: track-total
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Number of tracks in a DIDL_S or DIDL_V resource.

GUPnPAV.DIDLLiteResource.props.update_count¶

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

The update count of this resource.

GUPnPAV.DIDLLiteResource.props.uri¶

Name:: uri
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The URI associated with this resource.

GUPnPAV.DIDLLiteResource.props.width¶

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

The width of this image/video resource.

GUPnPAV.DIDLLiteResource.props.xml_node¶

Name:: xml-node
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The pointer to res node in XML document.