node-nicovideo-api

{ "project": {}, "files": { "src/live/CommentProvider.coffee": { "name": "src/live/CommentProvider.coffee", "modules": {}, "classes": { "CommentProvider": 1 }, "fors": {}, "namespaces": {} }, "src/live/NicoLiveApi.coffee": { "name": "src/live/NicoLiveApi.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/live/NicoLiveComment.coffee": { "name": "src/live/NicoLiveComment.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/live/NicoLiveInfo.coffee": { "name": "src/live/NicoLiveInfo.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/live/NsenChannel.coffee": { "name": "src/live/NsenChannel.coffee", "modules": {}, "classes": { "NsenChannel": 1 }, "fors": {}, "namespaces": {} }, "src/mylist/MyList.coffee": { "name": "src/mylist/MyList.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/mylist/MyListItem.coffee": { "name": "src/mylist/MyListItem.coffee", "modules": {}, "classes": { "MyListItem": 1 }, "fors": {}, "namespaces": {} }, "src/mylist/MyListMeta.coffee": { "name": "src/mylist/MyListMeta.coffee", "modules": {}, "classes": { "MyListMeta": 1 }, "fors": {}, "namespaces": {} }, "src/mylist/NicoMyListApi.coffee": { "name": "src/mylist/NicoMyListApi.coffee", "modules": {}, "classes": { "NicoMyListApi": 1 }, "fors": {}, "namespaces": {} }, "src/user/NicoUser.coffee": { "name": "src/user/NicoUser.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/user/NicoUserAPI.coffee": { "name": "src/user/NicoUserAPI.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/video/NicoVideoApi.coffee": { "name": "src/video/NicoVideoApi.coffee", "modules": {}, "classes": { "NicoVideoApi": 1 }, "fors": {}, "namespaces": {} }, "src/video/NicoVideoInfo.coffee": { "name": "src/video/NicoVideoInfo.coffee", "modules": {}, "classes": { "NicoVideoInfo": 1 }, "fors": {}, "namespaces": {} }, "src/APIEndpoints.coffee": { "name": "src/APIEndpoints.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/Emitter.coffee": { "name": "src/Emitter.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/NicoSession.coffee": { "name": "src/NicoSession.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/niconico.coffee": { "name": "src/niconico.coffee", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} } }, "modules": {}, "classes": { "CommentProvider": { "name": "CommentProvider", "shortname": "CommentProvider", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/live/CommentProvider.coffee", "line": 1, "description": "放送中の番組のコメントの取得と投稿を行うクラスです。" }, "NsenChannel": { "name": "NsenChannel", "shortname": "NsenChannel", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/live/NsenChannel.coffee", "line": 1 }, "MyListItem": { "name": "MyListItem", "shortname": "MyListItem", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/mylist/MyListItem.coffee", "line": 1, "description": "マイリストの項目モデルです。\n\nProperties\n getメソッドを通じて第１階層まで取得できます。\n Example. mylistItem.get(\"movie\").title\n\n - id : number -- マイリスト項目ID\n - type : number -- 項目の種類（動画、静画など）\n - description : string -- マイリストコメント\n - createTime : Date -- 追加日\n - updateTime : Date -- 更新日（？）\n - watch : number -- 不明\n - movie : Object -- 動画情報\n - id : string -- 動画ID\n - title : string -- 動画タイトル\n - length : number -- 動画の長さ（秒）\n - thumbnail : string -- サムネイル画像のURL\n\n - groupType : string -- 不明\n - lastResponse : string -- 最近投稿されたコメントの一部\n - isDeleted : boolean -- 削除されているか\n\n - updateTime : Date -- この情報の最終更新日時（？）\n - firtsRetrieve : Date -- 動画投稿日\n\n - count -- カウンタ系の情報が詰められたオブジェクト\n - view : number -- 再生数\n - comments : number -- コメント数\n - mylist : number -- マイリスト数" }, "MyListMeta": { "name": "MyListMeta", "shortname": "MyListMeta", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/mylist/MyListMeta.coffee", "line": 26, "description": "マイリストのメタデータを表すクラスです。\nこのモデルからマイリストを操作することはできません。" }, "NicoMyListApi": { "name": "NicoMyListApi", "shortname": "NicoMyListApi", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/mylist/NicoMyListApi.coffee", "line": 38, "description": "ニコニコ動画のマイリスト操作APIのラッピングを行います。\n（参考: http://efcl.info/wiki/niconicoapi/）", "todo": [ "Manage MyList instances for support dispose." ], "is_constructor": 1, "params": [ { "name": "session", "description": "", "type": "NicoSession" } ] }, "NicoVideoApi": { "name": "NicoVideoApi", "shortname": "NicoVideoApi", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/video/NicoVideoApi.coffee", "line": 18, "description": "ニコニコ動画APIへのアクセスを担当するクラス", "params": [ { "name": "session", "description": "", "type": "NicoSession" } ] }, "NicoVideoInfo": { "name": "NicoVideoInfo", "shortname": "NicoVideoInfo", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "src/video/NicoVideoInfo.coffee", "line": 156, "description": "ニコニコ動画APIの動画情報モデルクラス\n\nProperties\n getメソッドで第１階層まで取得できます。\n Example: NicoVideoInfo.get(\"user\").id", "extends": "EventEmitter2", "is_constructor": 1, "params": [ { "name": "movieId", "description": "動画ID", "type": "String" }, { "name": "_session", "description": "セッション", "type": "NicoSession" } ] } }, "elements": {}, "classitems": [ { "file": "src/live/CommentProvider.coffee", "line": 44, "params": [ { "name": "liveInfo", "description": "", "type": "NicoLiveInfo" } ], "return": { "description": "", "type": "Promise" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 54, "access": "private", "tagname": "", "itemtype": "property", "name": "_live", "type": "NicoLiveInfo", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 60, "access": "private", "tagname": "", "itemtype": "property", "name": "_socket", "type": "net.Socket", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 66, "access": "private", "tagname": "", "itemtype": "property", "name": "_postInfo", "type": "Object", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 75, "itemtype": "property", "name": "isFirstResponseProsessed", "type": "Boolean", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 80, "is_constructor": 1, "params": [ { "name": "_live", "description": "", "type": "NicoLiveInfo" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 94, "description": "このインスタンスが保持しているNicoLiveInfoオブジェクトを取得します。", "itemtype": "method", "name": "getLiveInfo", "return": { "description": "", "type": "NicoLiveInfo" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 103, "access": "private", "tagname": "", "itemtype": "method", "name": "_canContinue", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 113, "description": "[Method for testing] Stream given xml data as socket received data.", "access": "private", "tagname": "", "itemtype": "method", "name": "_pourXMLData", "params": [ { "name": "xml", "description": "", "type": "String" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 123, "description": "コメントサーバーへ接続します。\n\n既に接続済みの場合は接続を行いません。\n再接続する場合は `CommentProvider#reconnect`を利用してください。", "itemtype": "method", "name": "connect", "fires": "CommentProvider#did-connect", "params": [ { "name": "options", "description": "", "type": "Object", "optional": true, "props": [ { "name": "firstGetComments", "description": "接続時に取得するコメント数", "type": "Number", "optional": true, "optdefault": "100" }, { "name": "timeoutMs", "description": "タイムアウトまでのミリ秒", "type": "Number", "optional": true, "optdefault": "5000" } ] } ], "return": { "description": "", "type": "Promise" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 181, "itemtype": "method", "name": "reconnect", "params": [ { "name": "options", "description": "接続設定（connectメソッドと同じ）", "type": "Object" } ], "return": { "description": "", "type": "Promise" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 194, "description": "コメントサーバから切断します。", "itemtype": "method", "name": "disconnect", "fires": "CommentProvider#did-disconnect", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 211, "description": "APIからpostkeyを取得します。", "access": "private", "tagname": "", "itemtype": "method", "name": "_ferchPostKey", "return": { "description": "", "type": "Promise" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 244, "description": "コメントを投稿します。", "itemtype": "method", "name": "postComment", "params": [ { "name": "msg", "description": "投稿するコメント", "type": "String" }, { "name": "command", "description": "コマンド(184, bigなど)", "type": "String|Array.<String>", "optional": true }, { "name": "timeoutMs", "description": "", "type": "Number", "optional": true } ], "return": { "description": "", "type": "Promise" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 329, "description": "インスタンスを破棄します。", "itemtype": "method", "name": "dispose", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 344, "description": "コメント受信処理", "access": "private", "tagname": "", "itemtype": "method", "name": "_didReceiveData", "params": [ { "name": "xml", "description": "", "type": "String" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 394, "description": "コネクション上のエラー処理", "access": "private", "tagname": "", "itemtype": "method", "name": "_didErrorOnSocket", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 404, "description": "コネクションが閉じられた時の処理", "access": "private", "tagname": "", "itemtype": "method", "name": "_didCloseSocket", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 417, "description": "コメントサーバのスレッドID変更を監視するリスナ", "access": "private", "tagname": "", "itemtype": "method", "name": "_didRefreshLiveInfo", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 432, "access": "private", "tagname": "", "itemtype": "event", "name": "CommentProvider#did-receive-post-result", "params": [ { "name": "status", "description": "", "type": "Number" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 437, "access": "private", "tagname": "", "itemtype": "method", "name": "_onDidReceivePostResult", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 447, "description": "Fire on received and processed thread info and comments first", "itemtype": "event", "name": "CommentProvider#did-process-first-response", "params": [ { "name": "UNKNOWN", "description": "", "type": "Array.<NicoLiveComment>" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 452, "itemtype": "method", "name": "onDidProcessFirstResponse", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 461, "description": "Fire on raw response received", "itemtype": "event", "name": "CommentProvider#did-receive-data", "params": [ { "name": "data", "description": "", "type": "String" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 466, "itemtype": "method", "name": "onDidReceiveData", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 475, "description": "Fire on comment received", "itemtype": "event", "name": "CommentProvider#did-receive-comment", "params": [ { "name": "comment", "description": "", "type": "NicoLiveComment" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 480, "itemtype": "method", "name": "onDidReceiveComment", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 489, "description": "Fire on error raised on Connection", "itemtype": "event", "name": "CommentProvider#did-error", "params": [ { "name": "error", "description": "", "type": "Error" } ], "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 494, "itemtype": "method", "name": "onDidError", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 503, "description": "Fire on connection closed", "itemtype": "event", "name": "CommentProvider#did-close-connection", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 507, "itemtype": "method", "name": "onDidCloseConnection", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 516, "description": "Fire on live ended", "itemtype": "event", "name": "CommentProvider#did-end-live", "class": "CommentProvider" }, { "file": "src/live/CommentProvider.coffee", "line": 520, "itemtype": "method", "name": "onDidEndLive", "params": [ { "name": "listener", "description": "", "type": "Function" } ], "return": { "description": "", "type": "Disposable" }, "class": "CommentProvider" }, { "file": "src/live/NicoLiveApi.coffee", "line": 14, "params": [ { "name": "_session", "description": "", "type": "NicoSession" } ], "class": "NsenChannel" }, { "file": "src/live/NicoLiveApi.coffee", "line": 21, "description": "指定された放送の情報を取得します。\n\n番組情報が取得できればNicoLiveInfoオブジェクトとともにresolveされます。\n取得中にエラーが発生した場合、エラーメッセージとともにrejectされます。", "params": [ { "name": "liveId", "description": "放送ID", "type": "String" } ], "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveApi.coffee", "line": 42, "description": "NsenChannelのインスタンスを取得します。", "params": [ { "name": "channel", "description": "", "type": "String" } ], "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveApi.coffee", "line": 68, "description": "現在のインスタンスおよび、関連するオブジェクトを破棄し、利用不能にします。", "class": "NsenChannel" }, { "file": "src/live/NicoLiveComment.coffee", "line": 1, "description": "Properties\n - threadId : number -- コメントサーバー内のスレッドID\n - date : Date -- コメント投稿日時\n - locale : string -- 投稿元国情報(\"ja-jp\", \"jp\"など、詳細不明)\n - command : string -- コメント投稿時に設定されたコマンド(184など)\n - isMyPost : boolean -- 自分で投稿したコメントか\n - user -- 投稿したユーザー情報\n - id : number|string -- ユーザー番号(匿名コメントの場合は文字列）\n - score : number -- このユーザーのNGスコア\n - accountType : number -- アカウント種別(0:一般, 1:プレミアム, 3:配信者)\n - isPremium : boolean -- プレミアム会員かどうか\n - isAnonymous : boolean -- 匿名コメントかどうか", "class": "NsenChannel" }, { "file": "src/live/NicoLiveComment.coffee", "line": 47, "description": "規定の形式のXMLからNicoLiveCommentモデルを生成します。\n\nニコ生サーバーから配信されてくる以下のような形式のコメント（１行）を第１引数に渡してください。\n <chat thread=\"##\" vpos=\"##\" date=\"##\" date_usec=\"##\" user_id=\"##\" premium=\"#\" locale=\"**\">コメント内容</chat>", "params": [ { "name": "xml", "description": "ニコ生コメントサーバーから受信したXMLコメントデータ", "type": "String" }, { "name": "loggedUserId", "description": "現在ログイン中のユーザーのID", "type": "Number" } ], "return": { "description": "", "type": "NicoLiveComment" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 69, "itemtype": "property", "name": "", "type": "Object", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 122, "static": 1, "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 134, "description": "マイリストが最新の内容に更新された時に発火します", "itemtype": "property", "name": "live", "type": "NicoLiveInfo", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 140, "access": "private", "tagname": "", "itemtype": "property", "name": "_commentProvider", "type": "CommentProvider", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 146, "access": "private", "tagname": "", "itemtype": "property", "name": "_session", "type": "NicoSession", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 152, "access": "private", "tagname": "", "itemtype": "property", "name": "_attr", "type": "Object", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 158, "itemtype": "property", "name": "id", "type": "String", "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 163, "params": [ { "name": "session", "description": "認証チケット", "type": "NicoSession" }, { "name": "liveId", "description": "放送ID", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 175, "description": "公式放送か調べます。", "return": { "description": "", "type": "Boolean" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 183, "description": "Nsenのチャンネルか調べます。", "return": { "description": "", "type": "Boolean" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 191, "description": "放送が終了しているか調べます。", "return": { "description": "", "type": "Boolean" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 199, "params": [ { "name": "path", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 206, "description": "この放送に対応するCommentProviderオブジェクトを取得します。", "params": [ { "name": "options", "description": "接続設定", "type": "Object", "props": [ { "name": "firstGetComments", "description": "接続時に取得するコメント数", "type": "Number", "optional": true }, { "name": "timeoutMs", "description": "タイムアウトまでのミリ秒", "type": "Number", "optional": true }, { "name": "connect", "description": "trueを指定するとコネクション確立後にresolveします", "type": "Boolean", "optional": true, "optdefault": "true" } ] } ], "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 230, "description": "APIから取得した情報をパースします。", "access": "private", "tagname": "", "params": [ { "name": "res", "description": "API受信結果", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 310, "description": "番組情報を最新の状態に同期します。", "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NicoLiveInfo.coffee", "line": 326, "description": "現在のインスタンスおよび、関連するオブジェクトを破棄し、利用不能にします。", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 22, "description": "Nsenリクエスト時のエラーコード", "itemtype": "property", "name": "{Object.<String, String>", "final": "", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 50, "return": { "description": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 60, "access": "private", "tagname": "", "itemtype": "property", "name": "_live", "type": "NicoLiveInfo", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 66, "access": "private", "tagname": "", "itemtype": "property", "name": "_commentProvider", "type": "CommentProvider", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 72, "access": "private", "tagname": "", "itemtype": "property", "name": "_session", "type": "NicoSession", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 78, "description": "再生中の動画情報", "access": "private", "tagname": "", "itemtype": "property", "name": "_playingMovie", "type": "NicoLiveInfo", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 85, "description": "最後にリクエストした動画情報", "access": "private", "tagname": "", "itemtype": "property", "name": "_requestedMovie", "type": "NicoVideoInfo", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 92, "description": "最後にスキップした動画のID。\n比較用なので動画IDだけ。", "access": "private", "tagname": "", "itemtype": "property", "name": "_lastSkippedMovieId", "type": "String", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 100, "description": "（午前４時遷移時の）移動先の配信のID", "itemtype": "property", "name": "_nextLiveId", "type": "String", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 107, "params": [ { "name": "liveInfo", "description": "", "type": "NicoLiveInfo" }, { "name": "_session", "description": "", "type": "NicoSession" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 128, "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 164, "description": "チャンネルの種類を取得します。", "return": { "description": "\"vocaloid\", \"toho\"など", "type": "String" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 172, "description": "現在接続中の放送のNicoLiveInfoオブジェクトを取得します。", "return": { "description": "", "type": "NicoLiveInfo" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 180, "description": "現在利用しているCommentProviderインスタンスを取得します。", "return": { "description": "", "type": "CommentProvider?" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 188, "description": "現在再生中の動画情報を取得します。", "return": { "description": "", "type": "NicoVideoInfo?" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 196, "return": { "description": "", "type": "NicoVideoInfo?" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 203, "description": "スキップリクエストを送信可能か確認します。\n基本的には、sendSkipイベント、skipAvailableイベントで\n状態の変更を確認するようにします。", "return": { "description": "{boolean" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 214, "access": "private", "tagname": "", "params": [ { "name": "command", "description": "NicoLive command with \"/\" prefix", "type": "String" }, { "name": "params", "description": "command params", "type": "Array.<String>" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 248, "description": "Processing /nspanel command", "access": "private", "tagname": "", "params": [ { "name": "op", "description": "", "type": "String" }, { "name": "entity", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 290, "description": "サーバー側の情報とインスタンスの情報を同期します。", "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 345, "description": "コメントサーバーに再接続します。", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 365, "description": "リクエストを送信します。", "params": [ { "name": "movie", "description": "リクエストする動画の動画IDかNicoVideoInfoオブジェクト", "type": "NicoVideoInfo|String" } ], "return": { "description": "", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 396, "description": "リクエストをキャンセルします", "return": { "description": "キャンセルに成功すればresolveされます。\n (事前にリクエストが送信されていない場合もresolveされます。）\n リクエストに失敗した時、エラーメッセージつきでrejectされます。", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 424, "description": "Goodを送信します。", "return": { "description": "成功したらresolveされます。\n 失敗した時、エラーメッセージつきでrejectされます。", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 448, "description": "SkipRequestを送信します。", "return": { "description": "成功したらresolveされます。\n 失敗した時、エラーメッセージつきでrejectされます。", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 477, "description": "コメントを投稿します。", "params": [ { "name": "msg", "description": "投稿するコメント", "type": "String" }, { "name": "command", "description": "コマンド(184, bigなど)", "type": "String|Array.<String>", "optional": true }, { "name": "timeoutMs", "description": "", "type": "Number", "optional": true } ], "return": { "description": "投稿に成功すればresolveされ、\n 失敗すればエラーメッセージとともにrejectされます。", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 490, "description": "次のチャンネル情報を受信していれば、その配信へ移動します。", "return": { "description": "移動に成功すればresolveされ、それ以外の時にはrejectされます。", "type": "Promise" }, "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 516, "description": "コメントを受信した時のイベントリスナ。\n\n制御コメントの中からNsen内イベントを通知するコメントを取得して\n関係するイベントを発火させます。", "params": [ { "name": "comment", "description": "", "type": "LiveComment" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 532, "description": "配信情報が更新された時に実行される\n再生中の動画などのデータを取得する", "params": [ { "name": "live", "description": "", "type": "NicoLiveInfo" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 549, "description": "再生中の動画の変更を検知した時に呼ばれるメソッド", "access": "private", "tagname": "", "params": [ { "name": "videoId", "description": "次に再生される動画のID", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 575, "description": "チャンネルの内部放送IDの変更を検知するリスナ", "params": [ { "name": "nextLiveId", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 583, "description": "放送が終了した時のイベントリスナ", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 593, "description": "再生中の動画が変わった時のイベントリスナ", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 607, "itemtype": "event", "name": "NsenChannel#did-receive-comment", "params": [ { "name": "comment", "description": "", "type": "NicoLiveComment" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 615, "itemtype": "event", "name": "NsenChannel#did-receive-good", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 622, "itemtype": "event", "name": "NsenChannel#did-receive-add-mylist", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 629, "itemtype": "event", "name": "NsenChannel#did-push-good", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 636, "itemtype": "event", "name": "NsenChannel#did-push-skip", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 643, "itemtype": "event", "name": "NsenChannel#did-send-request", "params": [ { "name": "movie", "description": "", "type": "NicoVideoInfo" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 651, "itemtype": "event", "name": "NsenChannel#did-cancel-request", "params": [ { "name": "UNKNOWN", "description": "", "type": "NicoVideoInfo" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 659, "itemtype": "event", "name": "NsenChannel#did-change-movie", "params": [ { "name": "nextMovie", "description": "", "type": "NicoVideoInfo" }, { "name": "beforeMovie", "description": "", "type": "NicoVideoInfo" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 668, "itemtype": "event", "name": "NsenChannel#did-available-skip", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 675, "itemtype": "event", "name": "NsenChannel#will-close", "params": [ { "name": "nextLiveId", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 683, "itemtype": "event", "name": "NsenChannel#did-receive-request-state", "params": [ { "name": "newState", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 690, "itemtype": "property", "name": "{Number} tv", "type": "Boolean", "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 709, "itemtype": "event", "name": "NsenChannel#did-receive-tvchan-message", "params": [ { "name": "message", "description": "", "type": "String" } ], "class": "NsenChannel" }, { "file": "src/live/NsenChannel.coffee", "line": 716, "itemtype": "event", "name": "NsenChannel#will-dispose", "class": "NsenChannel" }, { "file": "src/mylist/MyList.coffee", "line": 1, "description": "Properties\n attrメソッドを介して取得します。（とりあえずマイリストの場合、属性は一切設定されません。）\n Example: mylist.attr(\"id\") // -> マイリストIDを取得\n - id : number -- マイリストID\n - name : string -- リスト名\n - description : string -- マイリストの説明\n - public : boolean -- 公開マイリストかどうか\n - iconId : number -- マイリストのアイコンID\n - defaultSort : number -- 標準のソート方法（？）\n - sortOrder : number -- ソート方式（？）\n - userId : n