jf-roku/docs/api/components_config_ServerDiscoveryTask.bs.html

174 lines
43 KiB
HTML
Raw Normal View History

2023-11-11 13:41:20 +00:00
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: components/config/ServerDiscoveryTask.bs</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://jellyfin.github.io/jellyfin-roku/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d=
2023-10-06 03:18:36 +00:00
'
' Task used to discover jellyfin servers on the local network
'
sub init()
m.log = log.Logger("ServerDiscoveryTask")
m.top.functionName = "execute"
end sub
sub execute()
m.servers = []
m.serverUrlMap = {}
m.locationUrlMap = {}
'send both requests at the same time
SendSSDPBroadcast()
SendClientDiscoveryBroadcast()
ts = CreateObject("roTimespan")
maxTimeMs = 2200
'monitor each port and collect messages
while True
elapsed = ts.TotalMilliseconds()
if elapsed >= maxTimeMs
exit while
end if
msg = Wait(100, m.ssdp.port)
if msg &lt;> invalid
ProcessSSDPResponse(msg)
end if
msg = Wait(100, m.clientDiscovery.port)
if msg &lt;> invalid
ProcessClientDiscoveryResponse(msg)
end if
end while
m.top.content = m.servers
m.log.debug("Jellyfin servers found", m.servers[0], m.servers[1], m.servers[2])
end sub
sub AddServer(server)
if m.serverUrlMap[server.baseUrl] = invalid
m.serverUrlMap[server.baseUrl] = true
m.servers.push(server)
end if
end sub
sub SendClientDiscoveryBroadcast()
m.clientDiscovery = {
port: CreateObject("roMessagePort"),
address: CreateObject("roSocketAddress"),
socket: CreateObject("roDatagramSocket"),
urlTransfer: CreateObject("roUrlTransfer")
}
m.clientDiscovery.address.SetAddress("255.255.255.255:7359")
m.clientDiscovery.urlTransfer.SetPort(m.clientDiscoveryPort)
m.clientDiscovery.socket.SetMessagePort(m.clientDiscovery.port)
m.clientDiscovery.socket.SetSendToAddress(m.clientDiscovery.address)
m.clientDiscovery.socket.NotifyReadable(true)
m.clientDiscovery.socket.SetBroadcast(true)
m.clientDiscovery.socket.SendStr("Who is JellyfinServer?")
end sub
sub ProcessClientDiscoveryResponse(message)
if Type(message) = "roSocketEvent" and message.GetSocketId() = m.clientDiscovery.socket.GetId() and m.clientDiscovery.socket.IsReadable()
try
responseJson = m.clientDiscovery.socket.ReceiveStr(4096)
server = ParseJson(responseJson)
AddServer({
name: server.Name,
baseUrl: server.Address,
'hardcoded icon since this service doesn't include them
iconUrl: "pkg:/images/logo-icon120.jpg",
iconWidth: 120,
iconHeight: 120
})
m.log.info("Found Jellyfin server using client discovery", server.Address)
catch e
m.log.error("Error scanning for jellyfin server", message)
end try
end if
end sub
sub SendSSDPBroadcast()
m.ssdp = {
port: CreateObject("roMessagePort"),
address: CreateObject("roSocketAddress"),
socket: CreateObject("roDatagramSocket"),
urlTransfer: CreateObject("roUrlTransfer")
}
m.ssdp.address.SetAddress("239.255.255.250:1900")
m.ssdp.socket.SetMessagePort(m.ssdp.port)
m.ssdp.socket.SetSendToAddress(m.ssdp.address)
m.ssdp.socket.NotifyReadable(true)
m.ssdp.urlTransfer.SetPort(m.ssdp.port)
'brightscript can't escape characters in strings, so create a few vars here so we can use them in the strings below
Q = Chr(34)
CRLF = Chr(13) + Chr(10)
ssdpStr = "M-SEARCH * HTTP/1.1" + CRLF
ssdpStr += "HOST: 239.255.255.250:1900" + CRLF
ssdpStr += "MAN: " + Q + "ssdp:discover" + Q + CRLF
ssdpStr += "ST:urn:schemas-upnp-org:device:MediaServer:1" + CRLF
ssdpStr += "MX: 2" + CRLF
ssdpStr += CRLF
m.ssdp.socket.SendStr(ssdpStr)
end sub
sub ProcessSSDPResponse(message)
locationUrl = invalid
if Type (message) = "roSocketEvent" and message.GetSocketId() = m.ssdp.socket.GetId() and m.ssdp.socket.IsReadable()
recvStr = m.ssdp.socket.ReceiveStr(4096)
match = CreateObject("roRegex", "\r\nLocation:\s*(.*?)\s*\r\n", "i").Match(recvStr)
if match.Count() = 2
locationUrl = match[1]
end if
end if
if locationUrl = invalid
return
else if m.locationUrlMap[locationUrl] &lt;> invalid
m.log.warn("Already discovered this location", locationUrl)
return
end if
m.locationUrlMap[locationUrl] = true
http = CreateObject("roUrlTransfer")
http.SetUrl(locationUrl)
responseText = http.GetToString()
xml = CreateObject("roXMLElement")
'if we successfully parsed the response, process it
if xml.Parse(responseText)
deviceNode = xml.GetNamedElementsCi("device")[0]
manufacturer = deviceNode.GetNamedElementsCi("manufacturer").GetText()
'only process jellyfin servers
if lcase(manufacturer) = "jellyfin"
'find the largest icon
width = 0
server = invalid
icons = deviceNode.GetNamedElementsCi("iconList")[0].GetNamedElementsCi("icon")
for each iconNode in icons
iconUrl = iconNode.GetNamedElementsCi("url").GetText()
baseUrl = invalid
match = CreateObject("roRegex", "(.*?)\/dlna\/", "i").Match(iconUrl)
if match.Count() = 2
baseUrl = match[1]
end if
loopResult = {
name: deviceNode.GetNamedElementsCi("friendlyName").GetText(),
baseUrl: baseUrl,
iconUrl: iconUrl,
iconWidth: iconNode.GetNamedElementsCi("width")[0].GetText().ToInt(),
iconHeight: iconNode.GetNamedElementsCi("height")[0].GetText().ToInt()
}
if baseUrl &lt;> invalid and loopResult.iconWidth > width
width = loopResult.iconWidth
server = loopResult
end if
end for
AddServer(server)
m.log.info("Found jellyfin server using SSDP and DLNA", server.baseUrl)
end if
end if
end sub
2023-11-11 13:41:20 +00:00
</code></pre></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper"><span class="jsdoc-message">Automatically generated using <a href="https://github.com/jsdoc/jsdoc" target="_blank">JSDoc</a> and the <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme" target="_blank">clean-jsdoc-theme</a>.</span></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">jellyfin-roku Code Documentation</a><div class="mobile-nav-links"><div class="external-link navbar-item"><a id="jellyfin-link-mobile" href="https://jellyfin.org/" target="_blank">Jellyfin</a></div><div class="external-link navbar-item"><a id="github-link-mobile" href="https://github.com/jellyfin/jellyfin-roku" target="_blank">GitHub</a></div><div class="external-link navbar-item"><a id="forum-link-mobile" href="https://forum.jellyfin.org/f-roku-development" target="_blank">Forum</a></div><div class="external-link navbar-item"><a id="matrix-link-mobile" href="https://matrix.to/#/#jellyfin-dev-roku:matrix.org" target="_blank">Matrix</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-AlbumData.html">AlbumData</a></div><div class="sidebar-section-children"><a href="module-AlbumGrid.html">AlbumGrid</a></div><div class="sidebar-section-children"><a href="module-AlbumTrackList.html">AlbumTrackList</a></div><div class="sidebar-section-children"><a href="module-AlbumView.html">AlbumView</a></div><div class="sidebar-section-children"><a href="module-Alpha.html">Alpha</a></div><div class="sidebar-section-children"><a href="module-ArtistView.html">ArtistView</a></div><div class="sidebar-section-children"><a href="module-AudioPlayer.html">AudioPlayer</a></div><div class="sidebar-section-children"><a href="module-AudioPlayerView.html">AudioPlayerView</a></div><div class="sidebar-section-children"><a href="module-AudioTrackListItem.html">AudioTrackListItem</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupHoriz.html">ButtonGroupHoriz</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupVert.html">ButtonGroupVert</a></div><div class="sidebar-section-children"><a href="module-ChannelData.html">ChannelData</a></div><div class="sidebar-section-children"><a href="module-Clock.html">Clock</a></div><div class="sidebar-section-children"><a href="module-CollectionData.html">CollectionData</a></div><div class="sidebar-section-children"><a href="module-ConfigData.html">ConfigData</a></div><div class="sidebar-section-children"><a href="module-ConfigItem.html">ConfigItem</a></div><div class="sidebar-section-children"><a href="module-ConfigList.html">ConfigList</a></div><div class="sidebar-section-children"><a href="module-ExtrasItem.html">ExtrasItem</a></div><div class="sidebar-section-children"><a href="module-ExtrasRowList.html">ExtrasRowList</a></div><div class="sidebar-section-children"><a href="module-FavoriteItemsTask.html">FavoriteItemsTask</a></div><div class="sidebar-section-children"><a href="module-Folder