com.opentok.ArchiveProperties.Builder
包含クラス: : アーカイブのプロパティ
public static class ArchiveProperties.Builder extends 目的
ArchiveProperties オブジェクトを作成するために使用されます。
関連項目:
: - ArchiveProperties
コンストラクタの概要
コンストラクタ
コンストラクタ
説明
Builder()
方法の概要
すべてのメソッド インスタンスメソッド 具体的なメソッド
修飾子と型
方法
説明
ArchiveProperties
build()
ArchiveProperties オブジェクトを作成します。
ArchiveProperties.Builder
hasAudio(boolean hasAudio)
オーディオトラックを組み込むには、このメソッドを呼び出します(true(デフォルト)
かどうか false).
ArchiveProperties.Builder
hasVideo(boolean hasVideo)
ビデオトラックを追加するには、このメソッドを呼び出します(true(デフォルト)
かどうか false).
ArchiveProperties.Builder
layout(ArchiveLayout layout)
構成済みアーカイブのレイアウトを設定します。
ArchiveProperties.Builder
maxBitrate(int maxBitrate)
アーカイブの最大ビットレート(bps)を設定します。
ArchiveProperties.Builder
multiArchiveTag(String multiArchiveTag)
同じセッションに対して複数のアーカイブを同時に記録できるようにするには、この設定を有効にしてください。
ArchiveProperties.Builder
name(String name)
アーカイブの名前を設定します。
ArchiveProperties.Builder
outputMode(Archive.OutputMode outputMode)
このアーカイブの出力モードを設定します。
ArchiveProperties.Builder
resolution(String resolution)
アーカイブの解像度を設定します。
ArchiveProperties.Builder
streamMode(Archive.StreamMode streamMode)
このアーカイブのストリームモードを設定します。
java.lang クラスから継承されたメソッド。目的
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
コンストラクタの詳細
ビルダー
public Builder()
メソッドの詳細
名称
public ArchiveProperties.Builder name(ストリング 名前)
アーカイブの名前を設定します。
パラメータ:
: name - アーカイブの名前。この名前を使用して、アーカイブを識別できます。これは
Archive オブジェクトのプロパティであり、OpenTok JavaScript SDK におけるアーカイブ関連のイベントのプロパティでもあります。
戻り値: : name 設定が適用された ArchiveProperties.Builder オブジェクト。
決議
public ArchiveProperties.Builder 解像度(ストリング 決議)
アーカイブの解像度を設定します。
パラメータ:
: resolution - アーカイブの解像度。「640x480」(SD、デフォルト)または
「1280x720」(HD)。このプロパティは、合成されたアーカイブにのみ適用されます。 これを設定し、
かつ outputMode プロパティを「individual」に設定すると、API メソッドの呼び出しで
エラーが発生します。
戻り値: : 解像度設定が指定された ArchiveProperties.Builder オブジェクト。
hasAudio
public ArchiveProperties.Builder hasAudio(boolean hasAudio)
オーディオトラックを組み込むには、このメソッドを呼び出します(true(デフォルト)
かどうか false).
パラメータ:
: hasAudio - アーカイブに音声トラックが含まれるかどうか。
戻り値: : hasAudio 設定が指定された ArchiveProperties.Builder オブジェクト。
hasVideo
public ArchiveProperties.Builder hasVideo(boolean hasVideo)
ビデオトラックを追加するには、このメソッドを呼び出します(true(デフォルト)
かどうか false).
パラメータ:
: hasVideo - アーカイブにビデオトラックが含まれるかどうか。
戻り値: : hasVideo 設定が指定された ArchiveProperties.Builder オブジェクト。
maxBitrate
public ArchiveProperties.Builder maxBitrate(int maxBitrate)
アーカイブの最大ビットレート(bps)を設定します。最小値は 100000、最大値は 6000000 です。
パラメータ:
: maxBitrate - アーカイブ作成時の最大ビットレート(ビット/秒)。
戻り値: : maxBitrate 設定が適用された ArchiveProperties.Builder オブジェクト。
バージョン: : 4.15.0
outputMode
public ArchiveProperties.Builder outputMode(Archive.OutputMode outputMode)
このアーカイブの出力モードを設定します。
パラメータ:
: outputMode - で定義された値に設定する Archive.OutputMode を列挙する。
戻り値: : 出力モードが設定された ArchiveProperties.Builder オブジェクト。
streamMode
public ArchiveProperties.Builder streamMode(Archive.StreamMode streamMode)
このアーカイブのストリームモードを設定します。
ストリームが自動的に選択される場合(StreamMode.AUTO(デフォルト設定)、セッション内のすべての
ストリームをアーカイブに含めることができます。ストリームを手動で選択した場合は
(StreamMode.MANUAL)、含めるストリームは
への呼び出しに基づいて指定します OpenTok.addArchiveStream(String, String, boolean, boolean) そして
OpenTok.removeArchiveStream(String, String) メソッド。これを使って
StreamMode.MANUAL, ストリームの音声、動画、あるいはその両方を
アーカイブに含めるかどうかを指定できます。自動モードと手動モードのいずれにおいても、アーカイブ作成ツールは
以下の基準に基づいてストリームをアーカイブに含めます。
ストリーム
優先順位付けルール.
パラメータ:
: streamMode - で定義された値に設定する Archive.StreamMode を列挙する。
戻り値: : ストリームモードが設定された ArchiveProperties.Builder オブジェクト。
レイアウト
public ArchiveProperties.Builder layout(アーカイブレイアウト (レイアウト)
構成済みアーカイブのレイアウトを設定します。
パラメータ:
: layout - 型が ArchiveLayout .
戻り値: : レイアウト設定が指定された ArchiveProperties.Builder オブジェクト。
multiArchiveTag
public ArchiveProperties.Builder multiArchiveTag(ストリング multiArchiveTag)
同じセッションに対して複数のアーカイブを同時に記録できるようにするには、これを設定してください。 進行中のセッションの同時アーカイブごとに、一意の文字列をここに設定してください。また、自動的にアーカイブされるアーカイブを手動で開始する場合も、この オプションを設定する必要があります。一意の multiArchiveTag を指定しない場合、 特定のセッションに対して一度に記録できるアーカイブは 1 つだけになります。詳しくは 「Simultaneous Archives」のドキュメンテーション.
パラメータ:
: multiArchiveTag - 一意のアーカイブタグ。
戻り値: : MultiArchiveTag 設定が適用された ArchiveProperties.Builder オブジェクト。
ビルド
public アーカイブのプロパティ build()
ArchiveProperties オブジェクトを作成します。
戻り値: : ArchiveProperties オブジェクト。