UNPKG

node-nicovideo-api

Version:

nicovideo api (video, live, etc..) wrapper package for node.js

1,083 lines (646 loc) 36.7 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>NsenChannel</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: </em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/CommentProvider.html">CommentProvider</a></li> <li><a href="../classes/MyListItem.html">MyListItem</a></li> <li><a href="../classes/MyListMeta.html">MyListMeta</a></li> <li><a href="../classes/NicoMyListApi.html">NicoMyListApi</a></li> <li><a href="../classes/NicoVideoApi.html">NicoVideoApi</a></li> <li><a href="../classes/NicoVideoInfo.html">NicoVideoInfo</a></li> <li><a href="../classes/NsenChannel.html">NsenChannel</a></li> </ul> <ul id="api-modules" class="apis modules"> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>NsenChannel Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/src_live_NsenChannel.coffee.html#l1"><code>src&#x2F;live&#x2F;NsenChannel.coffee:1</code></a> </div> </div> <div class="box intro"> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> <li class="api-class-tab events"><a href="#events">Events</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property private"> <a href="#property__live">_live</a> </li> <li class="index-item property"> <a href="#property_"></a> </li> <li class="index-item property private"> <a href="#property__commentProvider">_commentProvider</a> </li> <li class="index-item property private"> <a href="#property__session">_session</a> </li> <li class="index-item property private"> <a href="#property__attr">_attr</a> </li> <li class="index-item property"> <a href="#property_id">id</a> </li> <li class="index-item property"> <a href="#property_{Object.&lt;String, String&gt;">{Object.&lt;String, String&gt;</a> </li> <li class="index-item property"> <a href="#property_live">live</a> </li> <li class="index-item property private"> <a href="#property__commentProvider">_commentProvider</a> </li> <li class="index-item property private"> <a href="#property__session">_session</a> </li> <li class="index-item property private"> <a href="#property__playingMovie">_playingMovie</a> </li> <li class="index-item property private"> <a href="#property__requestedMovie">_requestedMovie</a> </li> <li class="index-item property private"> <a href="#property__lastSkippedMovieId">_lastSkippedMovieId</a> </li> <li class="index-item property"> <a href="#property__nextLiveId">_nextLiveId</a> </li> <li class="index-item property"> <a href="#property_{Number} tv">{Number} tv</a> </li> </ul> </div> <div class="index-section events"> <h3>Events</h3> <ul class="index-list events"> <li class="index-item event"> <a href="#event_NsenChannel#did-available-skip">NsenChannel#did-available-skip</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-cancel-request">NsenChannel#did-cancel-request</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-change-movie">NsenChannel#did-change-movie</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-push-good">NsenChannel#did-push-good</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-push-skip">NsenChannel#did-push-skip</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-receive-add-mylist">NsenChannel#did-receive-add-mylist</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-receive-comment">NsenChannel#did-receive-comment</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-receive-good">NsenChannel#did-receive-good</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-receive-request-state">NsenChannel#did-receive-request-state</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-receive-tvchan-message">NsenChannel#did-receive-tvchan-message</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#did-send-request">NsenChannel#did-send-request</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#will-close">NsenChannel#will-close</a> </li> <li class="index-item event"> <a href="#event_NsenChannel#will-dispose">NsenChannel#will-dispose</a> </li> </ul> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property__live" class="property item private"> <h3 class="name"><code>_live</code></h3> <span class="type">NicoLiveInfo</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l60"><code>src&#x2F;live&#x2F;NsenChannel.coffee:60</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_" class="property item"> <h3 class="name"><code></code></h3> <span class="type">Object</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l69"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:69</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__commentProvider" class="property item private"> <h3 class="name"><code>_commentProvider</code></h3> <span class="type"><a href="../classes/CommentProvider.html" class="crosslink">CommentProvider</a></span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l140"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:140</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__session" class="property item private"> <h3 class="name"><code>_session</code></h3> <span class="type">NicoSession</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l146"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:146</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__attr" class="property item private"> <h3 class="name"><code>_attr</code></h3> <span class="type">Object</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l152"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:152</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_id" class="property item"> <h3 class="name"><code>id</code></h3> <span class="type">String</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l158"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:158</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_{Object.&lt;String, String&gt;" class="property item"> <h3 class="name"><code>{Object.&lt;String, String&gt;</code></h3> <span class="type">Unknown</span> <span class="flag final">final</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l22"><code>src&#x2F;live&#x2F;NsenChannel.coffee:22</code></a> </p> </div> <div class="description"> <p>Nsenリクエスト時のエラーコード</p> </div> </div> <div id="property_live" class="property item"> <h3 class="name"><code>live</code></h3> <span class="type">NicoLiveInfo</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NicoLiveInfo.coffee.html#l134"><code>src&#x2F;live&#x2F;NicoLiveInfo.coffee:134</code></a> </p> </div> <div class="description"> <p>マイリストが最新の内容に更新された時に発火します</p> </div> </div> <div id="property__commentProvider" class="property item private"> <h3 class="name"><code>_commentProvider</code></h3> <span class="type"><a href="../classes/CommentProvider.html" class="crosslink">CommentProvider</a></span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l66"><code>src&#x2F;live&#x2F;NsenChannel.coffee:66</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__session" class="property item private"> <h3 class="name"><code>_session</code></h3> <span class="type">NicoSession</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l72"><code>src&#x2F;live&#x2F;NsenChannel.coffee:72</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__playingMovie" class="property item private"> <h3 class="name"><code>_playingMovie</code></h3> <span class="type">NicoLiveInfo</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l78"><code>src&#x2F;live&#x2F;NsenChannel.coffee:78</code></a> </p> </div> <div class="description"> <p>再生中の動画情報</p> </div> </div> <div id="property__requestedMovie" class="property item private"> <h3 class="name"><code>_requestedMovie</code></h3> <span class="type"><a href="../classes/NicoVideoInfo.html" class="crosslink">NicoVideoInfo</a></span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l85"><code>src&#x2F;live&#x2F;NsenChannel.coffee:85</code></a> </p> </div> <div class="description"> <p>最後にリクエストした動画情報</p> </div> </div> <div id="property__lastSkippedMovieId" class="property item private"> <h3 class="name"><code>_lastSkippedMovieId</code></h3> <span class="type">String</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l92"><code>src&#x2F;live&#x2F;NsenChannel.coffee:92</code></a> </p> </div> <div class="description"> <p>最後にスキップした動画のID。 比較用なので動画IDだけ。</p> </div> </div> <div id="property__nextLiveId" class="property item"> <h3 class="name"><code>_nextLiveId</code></h3> <span class="type">String</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l100"><code>src&#x2F;live&#x2F;NsenChannel.coffee:100</code></a> </p> </div> <div class="description"> <p>(午前4時遷移時の)移動先の配信のID</p> </div> </div> <div id="property_{Number} tv" class="property item"> <h3 class="name"><code>{Number} tv</code></h3> <span class="type">Boolean</span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l690"><code>src&#x2F;live&#x2F;NsenChannel.coffee:690</code></a> </p> </div> <div class="description"> </div> </div> </div> <div id="events" class="api-class-tabpanel"> <h2 class="off-left">Events</h2> <div id="event_NsenChannel#did-available-skip" class="events item"> <h3 class="name"><code>NsenChannel#did-available-skip</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l668"><code>src&#x2F;live&#x2F;NsenChannel.coffee:668</code></a> </p> </div> <div class="description"> </div> </div> <div id="event_NsenChannel#did-cancel-request" class="events item"> <h3 class="name"><code>NsenChannel#did-cancel-request</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l651"><code>src&#x2F;live&#x2F;NsenChannel.coffee:651</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">UNKNOWN</code> <span class="type"><a href="../classes/NicoVideoInfo.html" class="crosslink">NicoVideoInfo</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#did-change-movie" class="events item"> <h3 class="name"><code>NsenChannel#did-change-movie</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l659"><code>src&#x2F;live&#x2F;NsenChannel.coffee:659</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">nextMovie</code> <span class="type"><a href="../classes/NicoVideoInfo.html" class="crosslink">NicoVideoInfo</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">beforeMovie</code> <span class="type"><a href="../classes/NicoVideoInfo.html" class="crosslink">NicoVideoInfo</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#did-push-good" class="events item"> <h3 class="name"><code>NsenChannel#did-push-good</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l629"><code>src&#x2F;live&#x2F;NsenChannel.coffee:629</code></a> </p> </div> <div class="description"> </div> </div> <div id="event_NsenChannel#did-push-skip" class="events item"> <h3 class="name"><code>NsenChannel#did-push-skip</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l636"><code>src&#x2F;live&#x2F;NsenChannel.coffee:636</code></a> </p> </div> <div class="description"> </div> </div> <div id="event_NsenChannel#did-receive-add-mylist" class="events item"> <h3 class="name"><code>NsenChannel#did-receive-add-mylist</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l622"><code>src&#x2F;live&#x2F;NsenChannel.coffee:622</code></a> </p> </div> <div class="description"> </div> </div> <div id="event_NsenChannel#did-receive-comment" class="events item"> <h3 class="name"><code>NsenChannel#did-receive-comment</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l607"><code>src&#x2F;live&#x2F;NsenChannel.coffee:607</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">comment</code> <span class="type">NicoLiveComment</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#did-receive-good" class="events item"> <h3 class="name"><code>NsenChannel#did-receive-good</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l615"><code>src&#x2F;live&#x2F;NsenChannel.coffee:615</code></a> </p> </div> <div class="description"> </div> </div> <div id="event_NsenChannel#did-receive-request-state" class="events item"> <h3 class="name"><code>NsenChannel#did-receive-request-state</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l683"><code>src&#x2F;live&#x2F;NsenChannel.coffee:683</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">newState</code> <span class="type">String</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#did-receive-tvchan-message" class="events item"> <h3 class="name"><code>NsenChannel#did-receive-tvchan-message</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l709"><code>src&#x2F;live&#x2F;NsenChannel.coffee:709</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">message</code> <span class="type">String</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#did-send-request" class="events item"> <h3 class="name"><code>NsenChannel#did-send-request</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l643"><code>src&#x2F;live&#x2F;NsenChannel.coffee:643</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">movie</code> <span class="type"><a href="../classes/NicoVideoInfo.html" class="crosslink">NicoVideoInfo</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#will-close" class="events item"> <h3 class="name"><code>NsenChannel#will-close</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l675"><code>src&#x2F;live&#x2F;NsenChannel.coffee:675</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Event Payload:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">nextLiveId</code> <span class="type">String</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="event_NsenChannel#will-dispose" class="events item"> <h3 class="name"><code>NsenChannel#will-dispose</code></h3> <span class="type"></span> <div class="meta"> <p> Defined in <a href="../files/src_live_NsenChannel.coffee.html#l716"><code>src&#x2F;live&#x2F;NsenChannel.coffee:716</code></a> </p> </div> <div class="description"> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>