Image Service

From MythTV Official Wiki
Jump to: navigation, search

What is this?

See Services API


Image Service API List

API Command POST Required? Description
CreateThumbnail Yes TBC
GetImageInfo No TBC
GetImageInfoList No TBC
GetSyncStatus No TBC.
RemoveImage Yes TBC.
RenameImage Yes TBC.
StartSync Yes TBC.
StopSync Yes TBC.

Image APIs

CreateThumbnail

The CreateThumbnail API takes the following arguments:

Id (Required)
Parameter Type: Int
The image ID of the image to create a thumbnail


Example Query:

http://BackendServerIP:6544/Image/CreateThumbnail?Id=100

Example Return:


GetImageInfo

The GetImageInfo API takes the following arguments:

Id (Required)
Parameter Type: Integer
TBC.
Tag (Required)
Parameter Type: String
TBC.

Example Query:

http://BackendServerIP:6544/Image/GetImageInfo?Id=100&Tag=??????

Example Return:


GetImageInfoList

The GetImageInfoList API takes the following arguments:

Id (Required)
Parameter Type: Int
TBC


Example Query:

http://BackendServerIP:6544/Image/GetImageInfoList?Id=100

Example Return:


GetSyncStatus

The GetSyncStatus API takes no parameters:


Example Query:

http://BackendServerIP:6544/Image/GetSyncStatus

Example Return:


RemoveImage

The RemoveImage API takes the following arguments:

Id (Required)
Parameter Type: Int
The image ID of the image to remove


Example Query:

http://BackendServerIP:6544/Image/RemoveImage?Id=100

Example Return:


RenameImage

The RenameImage API takes the following arguments:

Id (Required)
Parameter Type: Int
The image ID of the image to create a thumbnail
NewName (Required)
Parameter Type: String
The name to use.

Example Query:

http://BackendServerIP:6544/Image/RenameImage?Id=100&NewName=New_Image_Name

Example Return:


StartSync

The StartSync API takes no parameters:


Example Query:

http://BackendServerIP:6544/Image/StartSync

Example Return:


StopSync

The StopSync API takes no parameters:


Example Query:

http://BackendServerIP:6544/Image/StopSync

Example Return: