Skip to content

API ​

NiconiComments ​

class NiconiComments(canvas:HTMLCanvasElement | IRenderer, data:inputFormat, options:InitOptions)

このライブラリの本体です

パラメータ ​

canvas ​

canvas:HTMLCanvasElement | IRenderer

コメント描画用のCanvasElementか、 IRenderer に適合するクラス、オブジェクトなどを渡してください

デフォルトで使用される CanvasRender は NiconiComments.internal.renderer.CanvasRenderer から使用することができます

コメントのレイアウトは1920x1080(16:9)のステージを基準とし、キャンバスの高さがステージの高さに一致するように拡大縮小されます

キャンバスのアスペクト比は16:9でなくても構いません。表示範囲はキャンバスのアスペクト比で決まり、ステージは常に中央に配置されます

  • 16:9より横長の場合: 表示範囲が左右に広がり、流れるコメントは広がった範囲にも描画されます
  • 16:9より縦長の場合: ステージの左右が切り取られます

canvas.width / canvas.heightを直接変更しても検知されません。初期化後にサイズを変更する場合は、CanvasRendererなどのレンダラーを渡し、drawCanvasを呼び出す前にそのレンダラーのsetSize(width, height)を呼び出してください

data ​

data:inputFormat

コメントデータまたはundefinedを渡してください

対応フォーマットはformatを確認してください

options ​

options:InitOptions

config ​

config:Config = {}

WARNING

このオプションは弄らないことを推奨します。描画が崩れる場合があります

内部処理用のマジックナンバーを上書きすることができます

各変数の詳細はsrc/definition/config.ts内のdefaultConfigのコメントを参照してください

debug ​

debug:boolean = false

処理の所要時間をブラウザコンソールに出力します

また、各コメントの左上に適用されているコマンドを表示します

デフォルト(false)の場合は出力を行いません

enableCustomCommands ​

enableCustomCommands:boolean = false

niconicomments独自のコマンド(nico:*)を有効にするかを指定します

デフォルト(false)の場合、nico:*形式のコマンドはすべて無視されます

trueの場合、Custom Commandsに記載されているコマンドが有効になります

enableLegacyPiP ​

enableLegacyPiP:boolean = false

初期化後も随時設定の変更が可能です

PiPの出力形式を変更します

デフォルト(false)の場合は画面全体を覆うように動画を描画します

trueの場合は画面内に全体が収まるように動画を描画します

format ​

format:inputFormatType = "default"

入力フォーマットを指定します

対応しているフォーマットは以下のとおりです

名前dataのtype備考
defaultrawApiResponse[] | formattedComment[] | formattedLegacyComment[]既定値。非推奨の formatted オプションが true なら formatted(formattedComment[] | formattedLegacyComment[])、それ以外は legacy(rawApiResponse[])として扱います
emptyundefined動的追加コメント用
XMLDocumentXMLDocumentsaccubusやniconicome等が生成したXMLをDOMParserでparseFromStringしたものを渡してください
後方互換のためフォーマット名「niconicome」もサポートしていますが、今後予告なく実装から削除される場合があります
xml2jsXml2jsPacketxml形式のコメントをxml2jsでパースしたオブジェクトを渡してください
formattedformattedComment[] | formattedLegacyComment[]user_idとlayerが含まれない場合はformattedLegacyCommentになります
legacyrawApiResponse[]legacy apiのレスポンスをJSON.parseしたものを渡してください
ownerownerComment[]投稿者コメント編集画面のエディータのjsonをJSON.parseしたものを渡してください
legacyOwnerstring旧投稿者コメント編集画面のエディータの文字列(改行含む)をそのまま渡してください
v1v1Thread[]v1 apiのdata以下threadsの内容を渡してください
formatted ​

formatted:boolean = false

WARNING

このオプションは非推奨です。formatオプションを使用してください

コメントデータが独自フォーマットかを指定します

デフォルト(false)の場合は独自フォーマットに変換を行ってから処理を行います

trueの場合はそのまま処理を行います

keepCA ​

keepCA:boolean = false

別のCAや関係ないコメントによってCA(主に積み絵)が崩壊するのを抑制します

デフォルト(false)の場合は通常通り位置決定を行います

trueの場合はCAを投稿していると推定されるユーザーのレイヤーを分けて位置決定をおこないます

また、該当CAの拡大縮小を抑制する効果もあります

mode ​

mode:modeType = "default"

描画モードを指定します

デフォルト("default")の場合は投稿時間をもとにコメントごとに動作モードを自動で切り替えます

"html5"の場合は、現行のhtml5プレイヤーに近い動作をします

"flash"の場合は、Saccubus/ZenzaWatchなどFlash時代の互換プレイヤーに近い動作をします

"default"または"flash"の場合はFlashプレイヤー当時のフォント変化文字や分割コメントなどを部分的にサポートします

scale ​

scale:number = 1

表示コメントサイズを拡大縮小します

keepCAを併用することを推奨します

showCollision ​

showCollision:boolean = false

初期化後も随時設定の変更が可能です

コメントの当たり判定を描画するか指定します

デフォルト(false)の場合は描画を行いません

trueの場合は、コメントの当たり判定と行の区切りを描画します

HTML5版のコメントは水色に、Flash版のコメントは紫に外枠線の色が変化します

showCommentCount ​

showCommentCount:boolean = false

初期化後も随時設定の変更が可能です

描画されているコメント数を画面上に描画するか指定します

デフォルト(false)の場合は描画を行いません

trueの場合は、画面内に描画されているコメントの総数を描画します

showFPS ​

showFPS:boolean = false

初期化後も随時設定の変更が可能です

FPSを画面上に描画するか指定します

デフォルト(false)の場合は描画を行いません

trueの場合は、FPSを表示します

※この値はフレームを描画するのにかかった時間をもとに算出しているため、実際に描画されたフレーム数とは異なります

useLegacy ​

useLegacy:boolean = false

WARNING

このオプションは非推奨です。modeオプションを使用してください

公式プレイヤー互換モードを有効にするか指定します

デフォルト(false)の場合は描画モードがコメントごとに自動で切り替わります

trueの場合は全コメントをHTML5版のコメントとして処理します

video ​

video:HTMLVideoElement | null = null

初期化後も随時設定の変更が可能です

IRenderer に適合するオブジェクトまたはクラスを使用している場合は IRenderer の video プロパティに VideoElement をセットしてください
CanvasRenderer を使用している場合は第二引数に VideoElement を渡してください

背景に描画する動画を指定します

デフォルト(null)の場合は描画を行いません

指定されている場合は、背景に指定された動画を描画し、その上にコメントを描画します

この機能を応用すると、Picture in Pictureにもコメントを表示できるようになります

メソッド ​

addComments() ​

addComments(...comments:formattedComment):void

主に生配信向けの、コメントを動的に追加する機能です

この機能によって追加されたコメントは当たり判定を考慮して配置されますが、すでに配置されているその後のコメントの位置には影響を及ぼしません

生成済みのコメントの間に配置した場合、コメント同士が重複する場合があります

addEventListener() ​

addEventListener(eventName:CommentEventName, eventHandler:CommentEventHandler):void

イベントハンドラを追加します

イベントの詳細は型定義を確認してください

removeEventListener() ​

removeEventListener(eventName:CommentEventName, eventHandler:CommentEventHandler):void

addEventListenerで追加されたイベントハンドラを削除します

drawCanvas() ​

drawCanvas(vpos:number):void

vpos(動画のcurrentTime*100)を元にキャンバスにコメントを描画します

clear() ​

clear():void

キャンバスを消去します