Myth Service

From MythTV Official Wiki
Revision as of 07:02, 14 August 2013 by Jyavenard (Talk | contribs)

Jump to: navigation, search

What is this?

See Services API


Myth Service API List

API Command POST Required? Description
AddStorageGroupDir Yes TBD
BackupDatabase Yes TBD
ChangePassword Yes TBD
CheckDatabase Yes TBD
AddStorageGroupDir Yes TBD
BackupDatabase Yes TBD
GetConnectionInfo No TBD
GetHostName No TBD
GetHosts Yes TBD
GetKeys No TBD
GetLogs No TBD
GetSettings No TBD
GetStorageGroupDirs No TBD
GetTimeZone Yes TBD
ProfileDelete Yes TBD
ProfileSubmit Yes TBD
ProfileText Yes TBD
ProfileURL Yes TBD
ProfileUpdated No TBD
PutSetting Yes TBD
RemoveStorageGroupDir Yes TBD
SendMessage No Send a message to one or more frontends, which will appear as a popup message on the screen.
SendNotification No Send a notification to one or more frontends which will appear in the Notification Center.
TestDBSettings Yes TBD

Myth APIs

SendMessage

The SendMessage API takes the following arguments:

Message (Required)
Parameter Type: String
The message to appear on the frontend popup.
Timeout (Optional)
Parameter Type: Integer
how long the message will be displayed for, if 0 or not set, user will have to dismiss it manually
Address (Optional)
Parameter Type: String
Broadcast address
udpPort (Optional)
Parameter Type: Integer
UDP port to be used in combination with broadcast addres

Example Query:

http://BackendIP:6544/Frontend/SendMessage?Message=Hello World

Example Return:

Boolean return. Returns true if the message was sent, false if the message failed.

<bool>true</bool>

SendNotification

The SendNotification API takes the following arguments:

Message (Required)
Parameter Type: String
The message to appear on the frontend notification center.
Error ("Optional")
Parameter Type: Boolean
The notification will be set as an error
Origin (Optional)
Parameter Type: String
The notification's origin
Description (Optional)
Parameter Type: String
The description to be sent in the notification
Image (Optional)
Parameter Type: String
The path or URL to image to be displayed in notification
Extra (Optional)
Parameter Type: String
The extra text to be sent in the notification
Progress (Optional)
Parameter Type: Float
A value between 0 and 1 (inclusive) indicating the progressiong percentage (1 is 100%).
- a negative value indicates not to display a progress bar
ProgressText (Optional)
Parameter Type: String
The text to be shown alongside the progress bar (if visible)
Timeout (Optional)
Parameter Type: Integer
The number of seconds the notification will be displayed for
Note that a notification can't be displayed for less than 5s
Fullscreen (Optional)
Parameter Type: Boolean
Display the notification in full screen mode
Visibility (Optional)
Parameter Type: Unsigned Integer
A bitmask value setting the visibility of the notification
(bit 0: video playback, bit 1: settings, bit 2: setup wizard, bit 3: video library
bit 4: music, bit 5: recordings library)
Priority (Optional)
Parameter Type: Unsigned Integer
The priority level of the notification
0 = default, 1 = low, 2 = medium, 3 = high, 4 = higher, 5 = highest
Type (Optional)
Parameter Type: String
The type of notification, valid values are:
normal, error, warning, check, busy.
this value is ignored if Error is set
Address (Optional)
Parameter Type: String
Broadcast address
udpPort (Optional)
Parameter Type: Integer
UDP port to be used in combination with broadcast addres

Example Query:

http://BackendIP:6544/Frontend/SendNotification?Message=Hello World

Example Return:

Boolean return. Returns true if the notification was sent, false if the notification failed.

<bool>true</bool>