zoraxy/mod/aroz/doc.txt
2022-11-01 10:54:02 +08:00

31 lines
2.7 KiB
Plaintext


package aroz // import "imuslab.com/aroz_online/subservice/demo/aroz"
FUNCTIONS
func HandleFlagCapture(info ServiceInfo) string
This function will request the required flag from the startup paramters and
parse it to the need of the arozos.
TYPES
type ServiceInfo struct {
Name string //Name of this module. e.g. "Audio"
Desc string //Description for this module
Group string //Group of the module, e.g. "system" / "media" etc
IconPath string //Module icon image path e.g. "Audio/img/function_icon.png"
Version string //Version of the module. Format: [0-9]*.[0-9][0-9].[0-9]
StartDir string //Default starting dir, e.g. "Audio/index.html"
SupportFW bool //Support floatWindow. If yes, floatWindow dir will be loaded
LaunchFWDir string //This link will be launched instead of 'StartDir' if fw mode
SupportEmb bool //Support embedded mode
LaunchEmb string //This link will be launched instead of StartDir / Fw if a file is opened with this module
InitFWSize []int //Floatwindow init size. [0] => Width, [1] => Height
InitEmbSize []int //Embedded mode init size. [0] => Width, [1] => Height
SupportedExt []string //Supported File Extensions. e.g. ".mp3", ".flac", ".wav"
}
Information required for registering this subservice to arozos