plugins:02_infojson
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
plugins:02_infojson [2018/08/19 14:11] – [TCPListen] James Sentman | plugins:02_infojson [2018/08/24 15:14] – [allowBonjour] added info that XTension will take care of it James Sentman | ||
---|---|---|---|
Line 57: | Line 57: | ||
===allowTCP=== | ===allowTCP=== | ||
- | OPTIONAL: (boolean) defaults to True. Allows for the opening of an outgoing | + | OPTIONAL: (boolean) defaults to True. If true then the Outgoing |
+ | |||
+ | You can get the user entered address and port via the XTension.settings object in the plugin using the xtKeyRemoteAddress and xtKeyRemotePort constants like: | ||
< | < | ||
myAddress = xtension.settings.get( xtKeyRemoteAddress) | myAddress = xtension.settings.get( xtKeyRemoteAddress) | ||
Line 63: | Line 65: | ||
</ | </ | ||
- | ==portSelectOutgoing== | + | ===portSelectOutgoing=== |
OPTIONAL: (boolean) if present and True the communications selection popup will be forced to select " | OPTIONAL: (boolean) if present and True the communications selection popup will be forced to select " | ||
Line 88: | Line 90: | ||
==defaultPort== | ==defaultPort== | ||
OPTIONAL: (integer) if present this will be filled in to the port field for the incoming | OPTIONAL: (integer) if present this will be filled in to the port field for the incoming | ||
- | |||
- | ==allowTCP== | ||
- | OPTIONAL: (boolean) defaults to True. If your interface needs to accept incoming TCP communications this should be left out or set to true. | ||
- | |||
- | ==allowUDP== | ||
- | OPTIONAL: (boolean) defaults to False. If your inteface needs to accept UDP packets on the specified port you should include this parameter as True. | ||
==allowBonjour== | ==allowBonjour== | ||
- | OPTIONAL: (boolean) defaults to True. Allows for you to register a bonjour, zero-conf or | + | OPTIONAL: (boolean) defaults to True. Allows for you to register a bonjour, zero-conf or mDNS name on the local network making it easier to find. The actual work of creating the mDNS record is handled by XTension. Your plugin does not have to do anything other than specify that you’d like it to be an option and supply the default service type string. |
==defaultBonjourName== | ==defaultBonjourName== | ||
OPTIONAL: (string) if present this will be offered as the default Bonjour name for the service you are registering. This is the DNS name that other devices will use to find your server. | OPTIONAL: (string) if present this will be offered as the default Bonjour name for the service you are registering. This is the DNS name that other devices will use to find your server. |