Update API docs

jellyfin · Oct 27, 2023 · cacabcc · cacabcc
1 parent 00a6858
commit cacabcc
Show file tree

Hide file tree

Showing 273 changed files with 2,578 additions and 809 deletions.
diff --git a/docs/api/components_ButtonGroupHoriz.brs.html b/docs/api/components_ButtonGroupHoriz.brs.html
@@ -138,7 +138,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_Buttons_JFButtons.brs.html b/docs/api/components_Buttons_JFButtons.brs.html
@@ -235,7 +235,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_Buttons_TextSizeTask.brs.html b/docs/api/components_Buttons_TextSizeTask.brs.html
@@ -134,7 +134,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_GetNextEpisodeTask.brs.html b/docs/api/components_GetNextEpisodeTask.brs.html
@@ -129,7 +129,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_GetPlaybackInfoTask.brs.html b/docs/api/components_GetPlaybackInfoTask.brs.html
@@ -283,7 +283,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_GetShuffleEpisodesTask.brs.html b/docs/api/components_GetShuffleEpisodesTask.brs.html
@@ -129,7 +129,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_IconButton.brs.html b/docs/api/components_IconButton.brs.html
@@ -194,7 +194,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_Alpha.brs.html b/docs/api/components_ItemGrid_Alpha.brs.html
@@ -156,7 +156,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_FavoriteItemsTask.brs.html b/docs/api/components_ItemGrid_FavoriteItemsTask.brs.html
@@ -132,7 +132,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_GridItem.brs.html b/docs/api/components_ItemGrid_GridItem.brs.html
@@ -284,7 +284,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_GridItemSmall.brs.html b/docs/api/components_ItemGrid_GridItemSmall.brs.html
@@ -184,7 +184,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_ItemGrid.brs.html b/docs/api/components_ItemGrid_ItemGrid.brs.html
@@ -988,7 +988,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_ItemGridOptions.brs.html b/docs/api/components_ItemGrid_ItemGridOptions.brs.html
@@ -501,7 +501,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_LoadItemsTask2.brs.html b/docs/api/components_ItemGrid_LoadItemsTask2.brs.html
@@ -378,7 +378,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_LoadVideoContentTask.brs.html b/docs/api/components_ItemGrid_LoadVideoContentTask.brs.html
@@ -1024,7 +1024,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_MovieLibraryView.brs.html b/docs/api/components_ItemGrid_MovieLibraryView.brs.html
@@ -1050,7 +1050,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_MusicArtistGridItem.brs.html b/docs/api/components_ItemGrid_MusicArtistGridItem.brs.html
@@ -196,7 +196,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ItemGrid_MusicLibraryView.brs.html b/docs/api/components_ItemGrid_MusicLibraryView.brs.html
@@ -908,7 +908,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFButton.brs.html b/docs/api/components_JFButton.brs.html
@@ -137,7 +137,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFGroup.brs.html b/docs/api/components_JFGroup.brs.html
@@ -121,7 +121,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFMessageDialog.brs.html b/docs/api/components_JFMessageDialog.brs.html
@@ -186,7 +186,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFOverhang.brs.html b/docs/api/components_JFOverhang.brs.html
@@ -260,7 +260,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFScene.brs.html b/docs/api/components_JFScene.brs.html
@@ -139,7 +139,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFScreen.brs.html b/docs/api/components_JFScreen.brs.html
@@ -137,7 +137,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_JFVideo.brs.html b/docs/api/components_JFVideo.brs.html
@@ -410,7 +410,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_ListPoster.brs.html b/docs/api/components_ListPoster.brs.html
@@ -229,7 +229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_OverviewDialog.bs.html b/docs/api/components_OverviewDialog.bs.html
@@ -130,7 +130,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_PersonDetails.brs.html b/docs/api/components_PersonDetails.brs.html
@@ -287,7 +287,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_PlaybackDialog.brs.html b/docs/api/components_PlaybackDialog.brs.html
@@ -122,7 +122,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_PlayedCheckmark.brs.html b/docs/api/components_PlayedCheckmark.brs.html
@@ -117,7 +117,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_PlaystateTask.brs.html b/docs/api/components_PlaystateTask.brs.html
@@ -167,7 +167,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_RadioDialog.brs.html b/docs/api/components_RadioDialog.brs.html
@@ -251,7 +251,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_SearchBox.brs.html b/docs/api/components_SearchBox.brs.html
@@ -146,7 +146,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_Spinner.brs.html b/docs/api/components_Spinner.brs.html
@@ -119,7 +119,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_StandardDialog.brs.html b/docs/api/components_StandardDialog.brs.html
@@ -149,7 +149,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_WhatsNewDialog.brs.html b/docs/api/components_WhatsNewDialog.brs.html
@@ -159,7 +159,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_captionTask.brs.html b/docs/api/components_captionTask.brs.html
@@ -263,7 +263,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_config_ConfigData.brs.html b/docs/api/components_config_ConfigData.brs.html
@@ -115,7 +115,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_config_ConfigItem.brs.html b/docs/api/components_config_ConfigItem.brs.html
@@ -150,7 +150,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_config_ConfigList.brs.html b/docs/api/components_config_ConfigList.brs.html
@@ -99,7 +99,7 @@ <h1 class="page-title">Source: components/config/ConfigList.brs</h1>
     i = m.top.itemSelected
     itemField = m.top.content.getchild(i)
 
-    show_dialog(itemField)
+    configListShowDialog(itemField)
 end sub
 
 function onDialogButton()
@@ -118,7 +118,7 @@ <h1 class="page-title">Source: components/config/ConfigList.brs</h1>
 end function
 
 
-sub show_dialog(configField)
+sub configListShowDialog(configField)
     dialog = createObject("roSGNode", "StandardKeyboardDialog")
     m.configField = configField
     dialog.title = configField.label
@@ -189,7 +189,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_config_JFServer.brs.html b/docs/api/components_config_JFServer.brs.html
@@ -147,7 +147,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/api/components_config_LoginScene.brs.html b/docs/api/components_config_LoginScene.brs.html
@@ -159,7 +159,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
 
-		on Oct 16th 2023
+		on Oct 27th 2023
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>