「メソッド」(2009/04/29 (水) 00:06:16) の最新版変更点
追加された行は緑色になります。
削除された行は赤色になります。
#contents()
*概要
メソッドとは動画情報ウィンドウを拡張する際にHTML内のJavaScriptから使用する関数のことです。
メソッドを使用することで次のような内容が可能になります。
-NicoPlayerから情報を取得
-NicoPlayerに処理をさせる(コマンドの送信)
-NicoPlayerからイベントの通知を受ける
実体はvar np = new npbase();として作成されているので np.メソッド名() と言う形で使用します。
また、プロパティはnp.プロパティ名として値の取得,設定が行えます。
実体の定義は ./videoinfo/nicoplayer.js にあります。
*メソッド
メソッド名、引数,戻り値,詳細,使用例など。
それぞれの項にある一番上の内容はメソッド,プロパティの定義です。
**NicoPlayerからイベントの通知を受ける
***onChangeMediaState : メディアの再生状態が変更された後に呼び出される
onChangeMediaState : function( state )
|引数|state|再生状態( "Stopped", "Paused", "Running", "" )|
空文字の場合はファイルが何も再生されていないことを表します
***onReceiveComment : 最新コメントを受信した後に呼び出される
onReceiveComment : function( view, comment, mylist )
|引数|view|再生数|
||comment|コメント数|
||mylist|マイリスト数|
最新コメントが見つからない場合や再生数などの情報に変化がない時でも呼び出されます
***onChangePlayList : プレイリストが変更されたときに呼び出される
onChangePlayList : function()
***onNotifyPostComment : コメントの投稿が完了したときに呼び出される
onNotifyPostComment : function( result )
|引数|result|コメントの投稿結果を表す真理値|
***onNotify : NicoPlayerから通知メッセージが送られたときに呼び出される
onNotify : function( message )
|引数|message|通知メッセージ|
このメソッドは内部で使われるため通常使用する必要はありません
**NicoPlayerに処理をさせる
***execApp : ファイルを実行
execApp : function( file, arg )
|引数|file|実行するファイルパス|
||arg|ファイルに渡す引数|
WinAPIのShellExecute()を使用しファイルを実行します。
argにパスを渡す場合はアプリケーションによって""で括る必要があります。
***addMessage : 情報ウィンドウにメッセージを追加
addMessage : function( msg )
|引数|msg|メッセージ|
***execCmd : NicoPlayerにコマンドを処理させる
execCmd : function( cmd )
|引数|cmd|コマンド文字列|
コマンドは[[起動オプション]]と同等の内容が指定できます。
またこのメソッドはNicoPlayerを操作する全てのメソッドから呼び出されます。
***postComment : コメントを投稿する
postComment : function( comment, command, vpos, id )
|引数|comment|コメント|
||command|コマンド|
||vpos|動画上の位置(1/100秒)|
||id|動画ID(省略すると現在再生中の動画が指定されます)|
コメント投稿の実行結果はnp.onNotifyPostComment()によって通知されます
NicoPlayerで現在再生中の時間に投稿する場合はvposの値にMath.floor( np.getTime() / 10 )を使用して下さい。
***readFile : ローカルのテキストファイルを読み込む
readFile : function( path )
|引数|path|ファイルパス|
|戻り値||テキストデータ|
◆削除検討中のメソッドです
***writeFile : ローカルのテキストファイルに書き込む
writeFile : function( path, data )
|引数|path|ファイルパス|
||data|書き込むテキストデータ|
◆削除検討中のメソッドです
**NicoPlayerから情報を取得する
***getVersion : NicoPlayerのバージョンを取得
getVersion : function()
|戻り値||バージョンナンバー("x.xx")|
***getSoftDir : NicoPlayerがあるフォルダパスを取得
getSoftDir : function()
|戻り値||ファイルパス|
***getPlayFile : 再生開始時に指定したファイルを取得
getPlayFile : function()
|戻り値||ファイルパス|
***getMediaFile : 再生中のメディアファイルを取得
getMediaFile : function()
|戻り値||ファイルパス|
***getCommentFile : 再生中のコメントファイルを取得
getCommentFile : function()
|戻り値||ファイルパス|
***getInfoFile : 再生中のメディアファイルに対応する動画情報ファイルを取得
getInfoFile : function()
|戻り値||ファイルパス|
***getTime : 現在の再生時間を取得
getTime : function()
|戻り値||再生時間(ms)|
***getLength : メディアの長さを取得
getLength : function()
|戻り値||メディアの長さ(ms)|
***getMediaState : メディアの再生状態を取得
getMediaState : function()
|戻り値||再生状態( "Stopped", "Paused", "Running", "" )|
空文字の場合はファイルが何も再生されていないことを表します
***getPlayList : プレイリストのデータを取得
getPlayList : function()
|戻り値||プレイリストデータのオブジェクト配列|
オブジェクトのプロパティ
・name : ファイル名
・path : ファイルパス
例：
var list = np.getPlayList();
for( var i = 0 ; i < list.name.length ; i++ )
{
document.write( list.name[i] + "<br>" );
document.write( list.path[i] + "<br>" );
}
***getNavigateMode : ページ移動時の動作を取得
getNavigateMode : function()
|戻り値||戻り値 : ページ移動時の動作( "Inside", "Outside" )|
"Inside" : 動画情報ウィンドウ内で開く
"Outside" : 外部ブラウザで開く
**NicoPlayerの情報を設定するメソッド
***setNavigateMode : ページ移動時の動作を設定
setNavigateMode : function( mode )
|引数|mode|ページ移動時の動作( "Inside", "Outside" )|
"Inside" : 動画情報ウィンドウ内で開く
"Outside" : 外部ブラウザで開く
**その他
***getThumbnailSource : サムネイルのソースを取得
getThumbnailSource : function( idMovie, pathThumbnail )
|引数|idMovie|動画ID|
||pathThumbnail|サムネイルパス|
|戻り値||サムネイルパス|
***drawThumbnail : サムネイルを表示
drawThumbnail : function( srcThumbnail )
|引数|srcThumbnail|サムネイルソース|
***encloseString : 文字列を""で括る
encloseString : function( str )
|引数|str|対象となる文字列|
|戻り値||""で括られた文字列|
既に""で括られている場合は引数をそのまま返します
**プロパティ
***lib_version : ライブラリバージョン
lib_version : "x.xx"
***debug : デバッグモード
debug : false
trueにするとNicoPlayerに渡されたコマンド内容を情報ウィンドウに表示します
例：
np.debug = true;
var time = np.getMediaState(); // ここで情報ウィンドウにコマンド内容が表示される
#contents()
*概要
メソッドとは動画情報ウィンドウを拡張する際にHTML内のJavaScriptから使用する関数のことです。
メソッドを使用することで次のような内容が可能になります。
-NicoPlayerから情報を取得
-NicoPlayerに処理をさせる(コマンドの送信)
-NicoPlayerからイベントの通知を受ける
実体はvar np = new npbase();として作成されているので np.メソッド名() と言う形で使用します。
また、プロパティはnp.プロパティ名として値の取得,設定が行えます。
実体の定義は ./videoinfo/nicoplayer.js にあります。
*メソッド
メソッド名、引数,戻り値,詳細,使用例など。
それぞれの項にある一番上の内容はメソッド,プロパティの定義です。
**NicoPlayerからイベントの通知を受ける
***onChangeMediaState : メディアの再生状態が変更された後に呼び出される
onChangeMediaState : function( state )
|引数|state|再生状態( "Stopped", "Paused", "Running", "" )|
空文字の場合はファイルが何も再生されていないことを表します
***onReceiveComment : 最新コメントを受信した後に呼び出される
onReceiveComment : function( view, comment, mylist )
|引数|view|再生数|
||comment|コメント数|
||mylist|マイリスト数|
最新コメントが見つからない場合や再生数などの情報に変化がない時でも呼び出されます
***onChangePlayList : プレイリストが変更されたときに呼び出される
onChangePlayList : function()
***onPlayCM : ユーザーニコ割(@CM)の再生設定がされている場合に呼び出される
onPlayCM : function( path )
|引数|path|ユーザーニコ割ファイルのパス|
***onNotifyPostComment : コメントの投稿が完了したときに呼び出される
onNotifyPostComment : function( result )
|引数|result|コメントの投稿結果を表す真理値|
***onNotify : NicoPlayerから通知メッセージが送られたときに呼び出される
onNotify : function( message )
|引数|message|通知メッセージ|
このメソッドは内部で使われるため通常使用する必要はありません
**NicoPlayerに処理をさせる
***execApp : ファイルを実行
execApp : function( file, arg )
|引数|file|実行するファイルパス|
||arg|ファイルに渡す引数|
WinAPIのShellExecute()を使用しファイルを実行します。
argにパスを渡す場合はアプリケーションによって""で括る必要があります。
***addMessage : 情報ウィンドウにメッセージを追加
addMessage : function( msg )
|引数|msg|メッセージ|
***execCmd : NicoPlayerにコマンドを処理させる
execCmd : function( cmd )
|引数|cmd|コマンド文字列|
コマンドは[[起動オプション]]と同等の内容が指定できます。
またこのメソッドはNicoPlayerを操作する全てのメソッドから呼び出されます。
***postComment : コメントを投稿する
postComment : function( comment, command, vpos, id )
|引数|comment|コメント|
||command|コマンド|
||vpos|動画上の位置(1/100秒)|
||id|動画ID(省略すると現在再生中の動画が指定されます)|
コメント投稿の実行結果はnp.onNotifyPostComment()によって通知されます
NicoPlayerで現在再生中の時間に投稿する場合はvposの値にMath.floor( np.getTime() / 10 )を使用して下さい。
***readFile : ローカルのテキストファイルを読み込む
readFile : function( path )
|引数|path|ファイルパス|
|戻り値||テキストデータ|
◆削除検討中のメソッドです
***writeFile : ローカルのテキストファイルに書き込む
writeFile : function( path, data )
|引数|path|ファイルパス|
||data|書き込むテキストデータ|
◆削除検討中のメソッドです
**NicoPlayerから情報を取得する
***getVersion : NicoPlayerのバージョンを取得
getVersion : function()
|戻り値||バージョンナンバー("x.xx")|
***getSoftDir : NicoPlayerがあるフォルダパスを取得
getSoftDir : function()
|戻り値||ファイルパス|
***getPlayFile : 再生開始時に指定したファイルを取得
getPlayFile : function()
|戻り値||ファイルパス|
***getMediaFile : 再生中のメディアファイルを取得
getMediaFile : function()
|戻り値||ファイルパス|
***getCommentFile : 再生中のコメントファイルを取得
getCommentFile : function()
|戻り値||ファイルパス|
***getInfoFile : 再生中のメディアファイルに対応する動画情報ファイルを取得
getInfoFile : function()
|戻り値||ファイルパス|
***getTime : 現在の再生時間を取得
getTime : function()
|戻り値||再生時間(ms)|
***getLength : メディアの長さを取得
getLength : function()
|戻り値||メディアの長さ(ms)|
***getMediaState : メディアの再生状態を取得
getMediaState : function()
|戻り値||再生状態( "Stopped", "Paused", "Running", "" )|
空文字の場合はファイルが何も再生されていないことを表します
***getPlayList : プレイリストのデータを取得
getPlayList : function()
|戻り値||プレイリストデータのオブジェクト配列|
オブジェクトのプロパティ
・name : ファイル名
・path : ファイルパス
例：
var list = np.getPlayList();
for( var i = 0 ; i < list.name.length ; i++ )
{
document.write( list.name[i] + "<br>" );
document.write( list.path[i] + "<br>" );
}
***getNavigateMode : ページ移動時の動作を取得
getNavigateMode : function()
|戻り値||戻り値 : ページ移動時の動作( "Inside", "Outside" )|
"Inside" : 動画情報ウィンドウ内で開く
"Outside" : 外部ブラウザで開く
**NicoPlayerの情報を設定するメソッド
***setNavigateMode : ページ移動時の動作を設定
setNavigateMode : function( mode )
|引数|mode|ページ移動時の動作( "Inside", "Outside" )|
"Inside" : 動画情報ウィンドウ内で開く
"Outside" : 外部ブラウザで開く
**その他
***getThumbnailSource : サムネイルのソースを取得
getThumbnailSource : function( idMovie, pathThumbnail )
|引数|idMovie|動画ID|
||pathThumbnail|サムネイルパス|
|戻り値||サムネイルパス|
***drawThumbnail : サムネイルを表示
drawThumbnail : function( srcThumbnail )
|引数|srcThumbnail|サムネイルソース|
***encloseString : 文字列を""で括る
encloseString : function( str )
|引数|str|対象となる文字列|
|戻り値||""で括られた文字列|
既に""で括られている場合は引数をそのまま返します
**プロパティ
***lib_version : ライブラリバージョン
lib_version : "x.xx"
***debug : デバッグモード
debug : false
trueにするとNicoPlayerに渡されたコマンド内容を情報ウィンドウに表示します
例：
np.debug = true;
var time = np.getMediaState(); // ここで情報ウィンドウにコマンド内容が表示される
表示オプション
横に並べて表示：
変化行の前後のみ表示：
