VideoOverlayリファレンス

注意事項

まだNewとなった機能を追加したバージョンはリリースされていません。


コンストラクタ
VideoOverlay

メソッド
close ( メディアを閉じる )
open ( メディアを開く )
play ( 再生開始 )
setBounds ( 再生矩形の位置とサイズを指定 )
setPos ( 再生矩形の左上位置を指定 )
setSize ( 再生矩形のサイズを指定 )
stop ( 再生停止 )
pause (一時停止)
rewind (巻き戻し)
prepare (再生準備)
setSegmentLoop (指定フレーム間ループ)
cancelSegmentLoop (指定フレーム間ループ解除)
setPeriodEvent (指定フレームでのイベント)
cancelPeriodEvent (指定フレームでのイベント解除)
selectAudioStream (音声ストリームの選択)
setMixingLayer (ミキシングレイヤーの設定)
resetMixingLayer (ミキシングレイヤーの設定解除)

プロパティ
height ( 再生矩形の縦幅 )
left ( 再生矩形の左端位置 )
position ( 再生位置 )
top ( 再生矩形の上端位置 )
visible ( 可視かどうか )
width ( 再生矩形の横幅 )
loop (ループ )
frame (現在のフレーム)
fps (フレームレート)
numberOfFrame (全フレーム数)
totalTime (合計時間)
layer1 (描画レイヤー指定1)
layer2 (描画レイヤー指定2)
mode (オーバーレイorレイヤー描画orミキサー)
playRate (再生速度)
segmentLoopStartFrame (セグメントループの開始フレーム)
segmentLoopEndFrame (セグメントループの終了フレーム)
periodEventFrame (ピリオドイベントフレーム)
audioBalance (音声バランス[パニング])
audioVolume (音声ボリューム)
numberOfAudioStream (音声ストリーム数)
enabledAudioStream (再生対象音声ストリーム番号)
mixingMovieAlpha (ビデオの透明度)
mixingMovieBGColor (背景色)

イベント
onCallbackCommand ( コールバックコマンドが発生した )
onPeriod ( Periodイベントが発生した )
onStatusChanged ( ステータスが変更された )
onFrameUpdate ( ビデオフレームが更新された )

は追加、もしくは機能追加されたものです。



吉里吉里のページを参照してください。



VideoOverlay.selectAudioStream
機能/意味
音声ストリームの選択
タイプ
VideoOverlayクラスのメソッド
構文
selectAudioStream(streamNumber)
引数
streamNumber 音声ストリーム番号
戻り値
なし (void)
説明
指定した音声ストリーム番号を有効にします。

VideoOverlay.setMixingLayer
機能/意味
ミキシング対象レイヤの設定
タイプ
VideoOverlayクラスのメソッド
構文
setMixingLayer(layer)
引数
layer レイヤー
戻り値
なし (void)
説明
指定したレイヤーとビデオのミキシングを行います。
ミキシングはこのメソッドが呼び出された時のレイヤー画像と行われます。
レイヤー画像の更新を反映するには、再度このメソッドを呼び出す必要があります。
onFrameUpdateを使用して、レイヤー画像が更新されたことを調べてこのメソッドを呼び出すようにすれば、自動的に更新が反映されるようになります。
onFrameUpdateで毎フレームこのメソッドを呼び出した場合、かなり負荷がかかりますのでそれは避けた方が良いです。
ミキサーモードでのみ利用可能です。

VideoOverlay.resetMixingLayer
機能/意味
ミキシング対象レイヤの設定解除
タイプ
VideoOverlayクラスのメソッド
構文
resetMixingLayer()
引数
なし
戻り値
なし (void)
説明
ビデオとレイヤーのミキシングを解除します。
ミキサーモードでのみ利用可能です。

VideoOverlay.playRate
機能/意味
再生速度
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
メディアの再生速度を設定します。
設定可能値はDirectShowのフィルタによって決まります。
参考 : 音声付のMPEGファイルの場合、0.0より大きい値から2.0までの値が設定可能です。音声なしのMPEGファイルの場合、0.0より大きい値からdoubleの範囲内(たぶん)で設定可能ですが、実際の再生速度は処理速度によって上限が決まります。

VideoOverlay.segmentLoopStartFrame
機能/意味
セグメントループの開始フレーム
タイプ
VideoOverlayクラスのプロパティ (読み出しのみ可能)
説明
セグメントループの始端フレームです。

VideoOverlay.segmentLoopEndFrame
機能/意味
セグメントループの終了フレーム
タイプ
VideoOverlayクラスのプロパティ (読み出しのみ可能)
説明
セグメントループの終端フレームです。

VideoOverlay.periodEventFrame
機能/意味
ピリオドイベントフレーム
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
periodイベントを発生させるフレームです。
未設定の場合、負の値が返ります。

VideoOverlay.audioBalance
機能/意味
音声バランス[パニング]
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
-10,000 〜 10,000の値が設定可能です。
値が -10,000 の場合、右チャンネルは 100 dB 減衰され、無音となることを意味しています。
値が 10,000 の場合、左チャンネルが無音であることを意味しています。
真中の値は 0 で、これは両方のチャンネルがフルボリュームであることを意味しています。
一方のチャンネルが減衰されても、もう一方のチャンネルはフル ボリュームのままです。

VideoOverlay.audioVolume
機能/意味
音声ボリューム
タイプ
VideoOverlayクラスのプロパティ (読み出しのみ可能)
説明
-10,000 〜 0の値が設定可能です。
最大ボリュームは 0、無音は -10,000です。
必要なデシベル値を 100 倍した値を設定します。
例 : -10,000 = -100 dB。

VideoOverlay.numberOfAudioStream
機能/意味
音声ストリーム数
タイプ
VideoOverlayクラスのプロパティ (読み出しのみ可能)
説明
MPEGファイルのみで利用可能です。
オーディオストリーム数を取得できます。

VideoOverlay.enabledAudioStream
機能/意味
再生対象音声ストリーム番号
タイプ
VideoOverlayクラスのプロパティ (読み出しのみ可能)
説明
MPEGファイルのみで利用可能です。
再生対象のオーディオストリーム番号を取得できます。
オーディオストリームが見付からない場合は-1を返します。

VideoOverlay.mode
機能/意味
再生モード
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
オーバーレイモードであるか、レイヤ描画モードであるか、ミキサーモードであるかを表します。値を設定することもできます。
オーバーレイモードの場合は vomOverlay、レイヤ描画モードの場合は vomLayer、ミキサーモードの場合は vomMixer となります。

VideoOverlay.mixingMovieAlpha
機能/意味
ビデオの透明度
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
0.0(完全に透明)〜1.0(完全に不透明)の範囲でビデオの透明度を表します。
ミキサーモードでのみ利用可能です。

VideoOverlay.mixingMovieBGColor
機能/意味
ビデオの背景色
タイプ
VideoOverlayクラスのプロパティ (読み書き可能)
説明
ビデオの背景色を表します。
ミキサーモードでのみ利用可能です。

VideoOverlay.onFrameUpdate
機能/意味
ビデオフレームが更新された
タイプ
VideoOverlayクラスのイベント
構文
onFrameUpdate(frame)
引数
frame ビデオのフレーム番号
説明
ビデオフレームが更新された後に呼び出されるメソッドです。
引数であるframeは現在表示されているビデオフレームと完全に一致しているとは限りません。
レイヤ描画モード、ミキサーモード時のみ利用可能です。