Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: 6b7b83659a
Fetching contributors…

Cannot retrieve contributors at this time

616 lines (376 sloc) 24.372 kB
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
<title>Module: VideoLibrary4</title>
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
<script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
</head>
<body id="top" class="module">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./index.html#classes">Classes</a>
<a href="./index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="./app/helpers/xbmc/apis/api_4/api4_video_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="app/helpers/xbmc/apis/api_4/api4_video.rb">app/helpers/xbmc/apis/api_4/api4_video.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-i-clean">#clean</a></li>
<li><a href="#method-i-get_episodes">#get_episodes</a></li>
<li><a href="#method-i-get_movie_thumb">#get_movie_thumb</a></li>
<li><a href="#method-i-get_movies">#get_movies</a></li>
<li><a href="#method-i-get_seasons">#get_seasons</a></li>
<li><a href="#method-i-get_tv_shows">#get_tv_shows</a></li>
<li><a href="#method-i-scan">#scan</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="./LICENSE.html">LICENSE</a></li>
<li class="file"><a href="./Rakefile.html">Rakefile</a></li>
<li class="file"><a href="./app/helpers/xbmc/xbmc-client-LICENSE.html">xbmc-client-LICENSE</a></li>
<li class="file"><a href="./public/images/IUI_LICENSE_txt.html">IUI_LICENSE.txt</a></li>
<li class="file"><a href="./public/jquery-toastmessage-plugin/LICENSE.html">LICENSE</a></li>
<li class="file"><a href="./public/jquery-toastmessage-plugin/NOTICE.html">NOTICE</a></li>
<li class="file"><a href="./rhoconfig_txt.html">rhoconfig.txt</a></li>
<li class="file"><a href="./rholog_txt.html">rholog.txt</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class/Module Index
<span class="search-toggle"><img src="./images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="./ApiV4.html">ApiV4</a></li>
<li><a href="./ApiV4/Application.html">ApiV4::Application</a></li>
<li><a href="./ApiV4/Input.html">ApiV4::Input</a></li>
<li><a href="./ApiV4/Playback.html">ApiV4::Playback</a></li>
<li><a href="./ApiV4/Playlist.html">ApiV4::Playlist</a></li>
<li><a href="./ApiV4/VideoLibrary.html">ApiV4::VideoLibrary</a></li>
<li><a href="./Api.html">Api</a></li>
<li><a href="./Api/V2.html">Api::V2</a></li>
<li><a href="./Api/V4.html">Api::V4</a></li>
<li><a href="./ApiV2.html">ApiV2</a></li>
<li><a href="./ApiV2/Playback.html">ApiV2::Playback</a></li>
<li><a href="./ApiV2/VideoLibrary.html">ApiV2::VideoLibrary</a></li>
<li><a href="./XbmcConnect.html">XbmcConnect</a></li>
<li><a href="./XbmcConnect/Command.html">XbmcConnect::Command</a></li>
<li><a href="./AppApplication.html">AppApplication</a></li>
<li><a href="./Application4.html">Application4</a></li>
<li><a href="./ApplicationHelper.html">ApplicationHelper</a></li>
<li><a href="./BarcodeScanController.html">BarcodeScanController</a></li>
<li><a href="./BrowserHelper.html">BrowserHelper</a></li>
<li><a href="./CommandsController.html">CommandsController</a></li>
<li><a href="./CommandsHelper.html">CommandsHelper</a></li>
<li><a href="./Control2.html">Control2</a></li>
<li><a href="./Control4.html">Control4</a></li>
<li><a href="./Controls.html">Controls</a></li>
<li><a href="./ControlsController.html">ControlsController</a></li>
<li><a href="./DownloadHelper.html">DownloadHelper</a></li>
<li><a href="./ErrorHelper.html">ErrorHelper</a></li>
<li><a href="./GeoController.html">GeoController</a></li>
<li><a href="./GeoHelper.html">GeoHelper</a></li>
<li><a href="./Input4.html">Input4</a></li>
<li><a href="./MethodHelper.html">MethodHelper</a></li>
<li><a href="./MoreController.html">MoreController</a></li>
<li><a href="./Movie.html">Movie</a></li>
<li><a href="./MovieController.html">MovieController</a></li>
<li><a href="./MovieHelper.html">MovieHelper</a></li>
<li><a href="./ObjHelper.html">ObjHelper</a></li>
<li><a href="./Object.html">Object</a></li>
<li><a href="./Playlist4.html">Playlist4</a></li>
<li><a href="./PlaylistController.html">PlaylistController</a></li>
<li><a href="./PlaylistHelper.html">PlaylistHelper</a></li>
<li><a href="./Product.html">Product</a></li>
<li><a href="./ProductController.html">ProductController</a></li>
<li><a href="./ProductHelper.html">ProductHelper</a></li>
<li><a href="./SpecRunner.html">SpecRunner</a></li>
<li><a href="./SpecRunnerController.html">SpecRunnerController</a></li>
<li><a href="./TempClass.html">TempClass</a></li>
<li><a href="./TvEpisodeHelper.html">TvEpisodeHelper</a></li>
<li><a href="./TvSeasonHelper.html">TvSeasonHelper</a></li>
<li><a href="./TvShowHelper.html">TvShowHelper</a></li>
<li><a href="./Tvepisode.html">Tvepisode</a></li>
<li><a href="./TvepisodeController.html">TvepisodeController</a></li>
<li><a href="./Tvseason.html">Tvseason</a></li>
<li><a href="./TvseasonController.html">TvseasonController</a></li>
<li><a href="./Tvshow.html">Tvshow</a></li>
<li><a href="./TvshowController.html">TvshowController</a></li>
<li><a href="./VideoLibrary2.html">VideoLibrary2</a></li>
<li><a href="./VideoLibrary4.html">VideoLibrary4</a></li>
<li><a href="./XbmcAppHelper.html">XbmcAppHelper</a></li>
<li><a href="./XbmcConfig.html">XbmcConfig</a></li>
<li><a href="./XbmcConfigController.html">XbmcConfigController</a></li>
<li><a href="./XbmcConfigHelper.html">XbmcConfigHelper</a></li>
<li><a href="./XbmcController.html">XbmcController</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="module">VideoLibrary4</h1>
<div id="description" class="description">
<p>Module that contains VideoLibrary commands for XBMC JSON RPC API Version 4</p>
</div><!-- description -->
<div id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="clean-method" class="method-detail ">
<a name="method-i-clean"></a>
<div class="method-heading">
<span class="method-name">clean</span><span
class="method-args">(callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to clean the Video Library</p>
<div class="method-source-code" id="clean-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">clean</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">clean</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- clean-source -->
</div>
</div><!-- clean-method -->
<div id="get_episodes-method" class="method-detail ">
<a name="method-i-get_episodes"></a>
<div class="method-heading">
<span class="method-name">get_episodes</span><span
class="method-args">(callback, tvshowid, seasonid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to send the complete list of TV Seasons stored. TV Season
information requested is: title, plot, rating, firstaired, playcount,
runtime, season, episode, fanart, thumbnail, tvshowid</p>
<div class="method-source-code" id="get_episodes-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_episodes</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">tvshowid</span>, <span class="ruby-identifier">seasonid</span>)
<span class="ruby-identifier">params</span> = {
<span class="ruby-value">:tvshowid</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">tvshowid</span>.<span class="ruby-identifier">to_i</span>,
<span class="ruby-value">:season</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">seasonid</span>.<span class="ruby-identifier">to_i</span>,
<span class="ruby-value">:properties</span> =<span class="ruby-operator">&gt;</span> [
<span class="ruby-string">&quot;title&quot;</span>,
<span class="ruby-string">&quot;plot&quot;</span>,
<span class="ruby-string">&quot;rating&quot;</span>,
<span class="ruby-string">&quot;firstaired&quot;</span>,
<span class="ruby-string">&quot;playcount&quot;</span>,
<span class="ruby-string">&quot;runtime&quot;</span>,
<span class="ruby-string">&quot;season&quot;</span>,
<span class="ruby-string">&quot;episode&quot;</span>,
<span class="ruby-string">&quot;fanart&quot;</span>,
<span class="ruby-string">&quot;thumbnail&quot;</span>,
<span class="ruby-string">&quot;tvshowid&quot;</span>
]
}
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">get_episodes</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- get_episodes-source -->
</div>
</div><!-- get_episodes-method -->
<div id="get_movie_thumb-method" class="method-detail ">
<a name="method-i-get_movie_thumb"></a>
<div class="method-heading">
<span class="method-name">get_movie_thumb</span><span
class="method-args">(callback, movieid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Gets the more recent Thumbnail from the XBMC Server.</p>
<div class="method-source-code" id="get_movie_thumb-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_movie_thumb</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">movieid</span>)
<span class="ruby-identifier">params</span> = {
<span class="ruby-value">:movieid</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">movieid</span>.<span class="ruby-identifier">to_i</span>,
<span class="ruby-value">:properties</span> =<span class="ruby-operator">&gt;</span> [
<span class="ruby-string">&quot;thumbnail&quot;</span>
]
}
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">get_movie_details</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- get_movie_thumb-source -->
</div>
</div><!-- get_movie_thumb-method -->
<div id="get_movies-method" class="method-detail ">
<a name="method-i-get_movies"></a>
<div class="method-heading">
<span class="method-name">get_movies</span><span
class="method-args">(callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to send the complete list of Movies stored. <a
href="Movie.html">Movie</a> information requested is: year, genre, studio,
sorttitle, rating, trailer, imdbnumber, plotoutline, tagline, director,
file, playcount, fanart, thumbnail, plot, title</p>
<div class="method-source-code" id="get_movies-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_movies</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-identifier">params</span> = {
<span class="ruby-value">:properties</span> =<span class="ruby-operator">&gt;</span> [
<span class="ruby-string">&quot;year&quot;</span>,
<span class="ruby-string">&quot;genre&quot;</span>,
<span class="ruby-string">&quot;studio&quot;</span>,
<span class="ruby-string">&quot;sorttitle&quot;</span>,
<span class="ruby-string">&quot;rating&quot;</span>,
<span class="ruby-string">&quot;trailer&quot;</span>,
<span class="ruby-string">&quot;imdbnumber&quot;</span>,
<span class="ruby-string">&quot;plotoutline&quot;</span>,
<span class="ruby-string">&quot;tagline&quot;</span>,
<span class="ruby-string">&quot;director&quot;</span>,
<span class="ruby-string">&quot;file&quot;</span>,
<span class="ruby-string">&quot;playcount&quot;</span>,
<span class="ruby-string">&quot;fanart&quot;</span>,
<span class="ruby-string">&quot;thumbnail&quot;</span>,
<span class="ruby-string">&quot;plot&quot;</span>,
<span class="ruby-string">&quot;title&quot;</span>
]
}
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">get_movies</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- get_movies-source -->
</div>
</div><!-- get_movies-method -->
<div id="get_seasons-method" class="method-detail ">
<a name="method-i-get_seasons"></a>
<div class="method-heading">
<span class="method-name">get_seasons</span><span
class="method-args">(callback, tvshowid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to send the complete list of TV Seasons stored. TV Season
information requested is: season, showtitle, playcount, episode, fanart,
thumbnail, tvshowid</p>
<div class="method-source-code" id="get_seasons-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_seasons</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">tvshowid</span>)
<span class="ruby-identifier">params</span> = {
<span class="ruby-value">:tvshowid</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">tvshowid</span>.<span class="ruby-identifier">to_i</span>,
<span class="ruby-value">:properties</span> =<span class="ruby-operator">&gt;</span> [
<span class="ruby-string">&quot;season&quot;</span>,
<span class="ruby-string">&quot;showtitle&quot;</span>,
<span class="ruby-string">&quot;playcount&quot;</span>,
<span class="ruby-string">&quot;episode&quot;</span>,
<span class="ruby-string">&quot;fanart&quot;</span>,
<span class="ruby-string">&quot;thumbnail&quot;</span>,
<span class="ruby-string">&quot;tvshowid&quot;</span>
]
}
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">get_seasons</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- get_seasons-source -->
</div>
</div><!-- get_seasons-method -->
<div id="get_tv_shows-method" class="method-detail ">
<a name="method-i-get_tv_shows"></a>
<div class="method-heading">
<span class="method-name">get_tv_shows</span><span
class="method-args">(callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to send the complete list of TV Shows stored. TV Show
information requested is: title, genre, year, rating, plot, studio,
playcount, episode, imdbnumber, premiered, votes, lastplayed, fanart,
thumbnail, file, originaltitle, sorttitle, episodeguide</p>
<div class="method-source-code" id="get_tv_shows-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_tv_shows</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-identifier">params</span> = {
<span class="ruby-value">:properties</span> =<span class="ruby-operator">&gt;</span> [
<span class="ruby-string">&quot;title&quot;</span>,
<span class="ruby-string">&quot;genre&quot;</span>,
<span class="ruby-string">&quot;year&quot;</span>,
<span class="ruby-string">&quot;rating&quot;</span>,
<span class="ruby-string">&quot;plot&quot;</span>,
<span class="ruby-string">&quot;studio&quot;</span>,
<span class="ruby-string">&quot;playcount&quot;</span>,
<span class="ruby-string">&quot;episode&quot;</span>,
<span class="ruby-string">&quot;imdbnumber&quot;</span>,
<span class="ruby-string">&quot;premiered&quot;</span>,
<span class="ruby-string">&quot;votes&quot;</span>,
<span class="ruby-string">&quot;lastplayed&quot;</span>,
<span class="ruby-string">&quot;fanart&quot;</span>,
<span class="ruby-string">&quot;thumbnail&quot;</span>,
<span class="ruby-string">&quot;file&quot;</span>,
<span class="ruby-string">&quot;originaltitle&quot;</span>,
<span class="ruby-string">&quot;sorttitle&quot;</span>,
<span class="ruby-string">&quot;episodeguide&quot;</span>
]
}
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">get_tv_shows</span>(<span class="ruby-identifier">callback</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- get_tv_shows-source -->
</div>
</div><!-- get_tv_shows-method -->
<div id="scan-method" class="method-detail ">
<a name="method-i-scan"></a>
<div class="method-heading">
<span class="method-name">scan</span><span
class="method-args">(callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests XBMC to scan the Video Library</p>
<div class="method-source-code" id="scan-source">
<pre>
<span class="ruby-comment"># File app/helpers/xbmc/apis/api_4/api4_video.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">scan</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-constant">XbmcConnect</span><span class="ruby-operator">::</span><span class="ruby-constant">VideoLibrary</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-identifier">callback</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- scan-source -->
</div>
</div><!-- scan-method -->
</div><!-- public-instance-method-details -->
</div><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 2</small>.</p>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.