Dmap.Share¶

Subclasses:: Dmap.AvShare, Dmap.ControlShare, Dmap.ImageShare

Methods¶

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

class	`free_filter` (filter)
	`publish` ()
	`serve` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_content_codes` (message, path)
	`do_ctrl_int` (message, path, query)
	`do_databases` (server, message, path, query)
	`do_databases_browse_xxx` (msg, path, query)
	`do_databases_items_xxx` (server, msg, path)
	`do_get_desired_port` ()
	`do_get_meta_data_map` ()
	`do_get_type_of_service` ()
	`do_login` (message, path, query)
	`do_logout` (message, path, query)
	`do_message_add_standard_headers` (msg)
	`do_name_collision` (publisher, name)
	`do_published` (publisher, name)
	`do_server_info` (message, path)
	`do_update` (message, path, query)

Properties¶

Name	Type	Flags	Short Description
`auth-method`	`int`	r/w	Authentication method
`container-db`	`Dmap.ContainerDb`	r/w/co	Container DB object
`db`	`Dmap.Db`	r/w/co	DB object
`name`	`str`	r/w	Share Name
`password`	`str`	r/w	Authentication password
`revision-number`	`int`	r/w	Revision number
`server`	`Soup.Server`	r	Soup server
`transcode-mimetype`	`str`	r/w/co	Set mimetype of stream after transcoding
`txt-records`	[`str`]	r/w	Set TXT-Records used for MDNS publishing

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`error`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Dmap.Share(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Dmap.ShareClass

classmethod free_filter(filter)¶

Parameters:: filter ([[object]]) – The filter list to free.

Free the given filter list.

publish()¶

Raises:: GLib.Error
Returns:: True if publishing succeeds, else False.
Return type:: bool

Publish the availability of the given share using mDNS-SD.

serve()¶

Raises:: GLib.Error
Returns:: True if serving succeeds, else False with error set.
Return type:: bool

Begin serving the service defined by share. A program will normally also call Dmap.Share.publish.

do_content_codes(message, path) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –

do_ctrl_int(message, path, query) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

do_databases(server, message, path, query) virtual¶

Parameters:

server (Soup.Server) –
message (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

do_databases_browse_xxx(msg, path, query) virtual¶

Parameters:

msg (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

do_databases_items_xxx(server, msg, path) virtual¶

Parameters:

server (Soup.Server) –
msg (Soup.ServerMessage) –
path (str) –

do_get_desired_port() virtual¶

Return type:: int

do_get_meta_data_map() virtual¶

Return type:: object or None

do_get_type_of_service() virtual¶

Return type:: str

do_login(message, path, query) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

do_logout(message, path, query) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

do_message_add_standard_headers(msg) virtual¶

Parameters:: msg (Soup.ServerMessage) –

do_name_collision(publisher, name) virtual¶

Parameters:

publisher (Dmap.MdnsPublisher) –
name (str) –

do_published(publisher, name) virtual¶

Parameters:

publisher (Dmap.MdnsPublisher) –
name (str) –

do_server_info(message, path) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –

do_update(message, path, query) virtual¶

Parameters:

message (Soup.ServerMessage) –
path (str) –
query ({object: object}) –

Signal Details¶

Dmap.Share.signals.error(share, object)¶

Signal Name:

error

Flags:

RUN_FIRST

Parameters:

share (Dmap.Share) – The object which received the signal
object (object or None) –

Property Details¶

Dmap.Share.props.auth_method¶

Name:: auth-method
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Authentication method

Dmap.Share.props.container_db¶

Name:: container-db
Type:: Dmap.ContainerDb
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Container DB object

Dmap.Share.props.db¶

Name:: db
Type:: Dmap.Db
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

DB object

Dmap.Share.props.name¶

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

Share Name

Dmap.Share.props.password¶

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

Authentication password

Dmap.Share.props.revision_number¶

Name:: revision-number
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Revision number

Dmap.Share.props.server¶

Name:: server
Type:: Soup.Server
Default Value:: None
Flags:: READABLE

Soup server

Dmap.Share.props.transcode_mimetype¶

Name:: transcode-mimetype
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Set mimetype of stream after transcoding

Dmap.Share.props.txt_records¶

Name:: txt-records
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE

Set TXT-Records used for MDNS publishing