Difference between revisions of "DBus Methods"

From Mumble Wiki
Jump to: navigation, search
 
Line 22: Line 22:
 
=== input parameters ===
 
=== input parameters ===
 
* [int] server_id The specific server
 
* [int] server_id The specific server
 +
 +
== getBootedServers ==
 +
Returns a list of all active servers
 +
=== output parameters ===
 +
* [int]* server_id
 +
 +
== getAllServers ==
 +
Returns a list of all servers
 +
=== output parameters ===
 +
* [int]* server_id
 +
 +
== isBooted ==
 +
check, whether a server is booted
 +
=== input parameters ===
 +
* [int] server_id
 +
=== output parameters ===
 +
* [boolean] is_booted
 +
 +
== getConf ==
 +
receive the configuration of a server by key
 +
=== input parameters ===
 +
* [int] server_id
 +
* [string] key
 +
=== output parameters ===
 +
* [string] value
 +
 +
== getAllConf ==
 +
receive the whole configuration of a server
 +
=== input parameters ===
 +
* [int] server_id
 +
=== output parameters ===
 +
* [string|string]* key->value map
 +
 +
== getDefaultConf ==
 +
receive the default configuration
 +
=== output parameters ===
 +
* [string|string]* key->value map

Revision as of 21:25, 17 March 2008

This is a documentation of the DBus interface. Mostly useful for creating scripts for interacting with murmur.

net.sourceforge.mumble.Meta

start

Starts a virtual server

input parameters

  • [int] server_id The specific server

stop

Stops a virtual server

input parameters

  • [int] server_id The specific server

newServer

Creates a new virtual server

output parameters

  • [int] server_id The id of the new created server

deleteServer

deletes a virtual server

input parameters

  • [int] server_id The specific server

getBootedServers

Returns a list of all active servers

output parameters

  • [int]* server_id

getAllServers

Returns a list of all servers

output parameters

  • [int]* server_id

isBooted

check, whether a server is booted

input parameters

  • [int] server_id

output parameters

  • [boolean] is_booted

getConf

receive the configuration of a server by key

input parameters

  • [int] server_id
  • [string] key

output parameters

  • [string] value

getAllConf

receive the whole configuration of a server

input parameters

  • [int] server_id

output parameters

  • [string|string]* key->value map

getDefaultConf

receive the default configuration

output parameters

  • [string|string]* key->value map