日本語
Appearance
class NiconiComments(canvas:HTMLCanvasElement | IRenderer, data:inputFormat, options:InitOptions)
このライブラリの本体です
canvas:HTMLCanvasElement | IRenderer
コメント描画用のCanvasElementか、 IRenderer に適合するクラス、オブジェクトなどを渡してください
デフォルトで使用される CanvasRender は NiconiComments.internal.renderer.CanvasRenderer から使用することができます
コメントのレイアウトは1920x1080(16:9)のステージを基準とし、キャンバスの高さがステージの高さに一致するように拡大縮小されます
キャンバスのアスペクト比は16:9でなくても構いません。表示範囲はキャンバスのアスペクト比で決まり、ステージは常に中央に配置されます
canvas.width / canvas.heightを直接変更しても検知されません。初期化後にサイズを変更する場合は、CanvasRendererなどのレンダラーを渡し、drawCanvasを呼び出す前にそのレンダラーのsetSize(width, height)を呼び出してください
canvas.width
canvas.height
setSize(width, height)
data:inputFormat
コメントデータまたはundefinedを渡してください
対応フォーマットはformatを確認してください
options:InitOptions
config:Config = {}
WARNING
このオプションは弄らないことを推奨します。描画が崩れる場合があります
内部処理用のマジックナンバーを上書きすることができます
各変数の詳細はsrc/definition/config.ts内のdefaultConfigのコメントを参照してください
debug:boolean = false
false
処理の所要時間をブラウザコンソールに出力します
また、各コメントの左上に適用されているコマンドを表示します
デフォルト(false)の場合は出力を行いません
enableCustomCommands:boolean = false
niconicomments独自のコマンド(nico:*)を有効にするかを指定します
nico:*
デフォルト(false)の場合、nico:*形式のコマンドはすべて無視されます
trueの場合、Custom Commandsに記載されているコマンドが有効になります
true
enableLegacyPiP:boolean = false
初期化後も随時設定の変更が可能です
PiPの出力形式を変更します
デフォルト(false)の場合は画面全体を覆うように動画を描画します
trueの場合は画面内に全体が収まるように動画を描画します
format:inputFormatType = "default"
"default"
入力フォーマットを指定します
対応しているフォーマットは以下のとおりです
formatted
formatted:boolean = false
このオプションは非推奨です。formatオプションを使用してください
コメントデータが独自フォーマットかを指定します
デフォルト(false)の場合は独自フォーマットに変換を行ってから処理を行います
trueの場合はそのまま処理を行います
keepCA:boolean = false
別のCAや関係ないコメントによってCA(主に積み絵)が崩壊するのを抑制します
デフォルト(false)の場合は通常通り位置決定を行います
trueの場合はCAを投稿していると推定されるユーザーのレイヤーを分けて位置決定をおこないます
また、該当CAの拡大縮小を抑制する効果もあります
mode:modeType = "default"
描画モードを指定します
デフォルト("default")の場合は投稿時間をもとにコメントごとに動作モードを自動で切り替えます
"html5"の場合は、現行のhtml5プレイヤーに近い動作をします
"html5"
"flash"の場合は、Saccubus/ZenzaWatchなどFlash時代の互換プレイヤーに近い動作をします
"flash"
"default"または"flash"の場合はFlashプレイヤー当時のフォント変化文字や分割コメントなどを部分的にサポートします
scale:number = 1
1
表示コメントサイズを拡大縮小します
keepCAを併用することを推奨します
showCollision:boolean = false
コメントの当たり判定を描画するか指定します
デフォルト(false)の場合は描画を行いません
trueの場合は、コメントの当たり判定と行の区切りを描画します
HTML5版のコメントは水色に、Flash版のコメントは紫に外枠線の色が変化します
showCommentCount:boolean = false
描画されているコメント数を画面上に描画するか指定します
trueの場合は、画面内に描画されているコメントの総数を描画します
showFPS:boolean = false
FPSを画面上に描画するか指定します
trueの場合は、FPSを表示します
※この値はフレームを描画するのにかかった時間をもとに算出しているため、実際に描画されたフレーム数とは異なります
useLegacy:boolean = false
このオプションは非推奨です。modeオプションを使用してください
公式プレイヤー互換モードを有効にするか指定します
デフォルト(false)の場合は描画モードがコメントごとに自動で切り替わります
trueの場合は全コメントをHTML5版のコメントとして処理します
video:HTMLVideoElement | null = null
null
IRenderer に適合するオブジェクトまたはクラスを使用している場合は IRenderer の video プロパティに VideoElement をセットしてください CanvasRenderer を使用している場合は第二引数に VideoElement を渡してください
背景に描画する動画を指定します
デフォルト(null)の場合は描画を行いません
指定されている場合は、背景に指定された動画を描画し、その上にコメントを描画します
この機能を応用すると、Picture in Pictureにもコメントを表示できるようになります
addComments(...comments:formattedComment):void
主に生配信向けの、コメントを動的に追加する機能です
この機能によって追加されたコメントは当たり判定を考慮して配置されますが、すでに配置されているその後のコメントの位置には影響を及ぼしません
生成済みのコメントの間に配置した場合、コメント同士が重複する場合があります
addEventListener(eventName:CommentEventName, eventHandler:CommentEventHandler):void
イベントハンドラを追加します
イベントの詳細は型定義を確認してください
removeEventListener(eventName:CommentEventName, eventHandler:CommentEventHandler):void
addEventListenerで追加されたイベントハンドラを削除します
drawCanvas(vpos:number):void
vpos(動画のcurrentTime*100)を元にキャンバスにコメントを描画します
clear():void
キャンバスを消去します
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でなくても構いません。表示範囲はキャンバスのアスペクト比で決まり、ステージは常に中央に配置されます
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 =
falseniconicomments独自のコマンド(
nico:*)を有効にするかを指定しますデフォルト(
false)の場合、nico:*形式のコマンドはすべて無視されますtrueの場合、Custom Commandsに記載されているコマンドが有効になりますenableLegacyPiP
enableLegacyPiP:boolean =
false初期化後も随時設定の変更が可能です
PiPの出力形式を変更します
デフォルト(
false)の場合は画面全体を覆うように動画を描画しますtrueの場合は画面内に全体が収まるように動画を描画しますformat
format:inputFormatType =
"default"入力フォーマットを指定します
対応しているフォーマットは以下のとおりです
formattedオプションがtrueなら formatted(formattedComment[] | formattedLegacyComment[])、それ以外は legacy(rawApiResponse[])として扱います後方互換のためフォーマット名「niconicome」もサポートしていますが、今後予告なく実装から削除される場合があります
formatted
formatted:boolean =
falseWARNING
このオプションは非推奨です。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 =
falseWARNING
このオプションは非推奨です。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
キャンバスを消去します