com.opentok.android.PublisherKit
com.opentok.android.Publisher
実装済みのすべてのインターフェース:
: Observer
public class Publisher extends PublisherKit
デバイスのマイクおよびカメラからのオーディオ・ビデオストリームをキャプチャし、 OpenTokセッションで使用するために使用します。Publisherコンストラクタを呼び出して、 Publisherインスタンスを作成します。
パブリッシャーのビューがアクティブなウィンドウから外れると、パブリッシャーオブジェクトは 破棄されます。これは、アクティビティが停止または一時停止された場合にも当てはまります。
関連項目:
: - Session.publish(PublisherKit publisher)
ネストされたクラスの概要
ネストされたクラス
修飾子と型
クラス
説明
static class
Publisher.Builder
~を構築するために使用される Publisher オブジェクトがある。
static enum
Publisher.CameraCaptureFrameRate
の値を定義します。 frameRate パラメーターの
Publisher.Builder.frameRate(Publisher.CameraCaptureFrameRate frameRate) メソッドを使用する。
static enum
Publisher.CameraCaptureResolution
の値を定義します。 resolution パラメーターの
Publisher.Builder.resolution(Publisher.CameraCaptureResolution resolution) メソッドを使用する。
static interface
Publisher.CameraListener
パブリッシャーが使用するカメラが変更されたことを監視します。
com.opentok.android クラスを継承するネストされたクラス/インターフェース。PublisherKit
PublisherKit.AudioLevelListener, PublisherKit.AudioStatsListener, PublisherKit.AudioTransformer, PublisherKit.CustomAudioTransformer, PublisherKit.CustomVideoTransformer, PublisherKit.DegradationPreference, PublisherKit.MediaLinkStatsListener, PublisherKit.MuteListener, PublisherKit.PreferredVideoCodecs, PublisherKit.PublisherAudioStats, PublisherKit.PublisherKitVideoType, PublisherKit.PublisherListener, PublisherKit.PublisherMediaLinkStats, PublisherKit.PublisherRtcStats, PublisherKit.PublisherRtcStatsReportListener, PublisherKit.PublisherVideoStats, PublisherKit.VideoBitratePreset, PublisherKit.VideoLayerStats, PublisherKit.VideoListener, PublisherKit.VideoStatsListener, PublisherKit.VideoTransformer
フィールド概要
フィールド
修飾子と型
フィールド
説明
protected Publisher.CameraCaptureFrameRate
cameraFrameRate
protected Publisher.CameraListener
cameraListener
protected Publisher.CameraCaptureResolution
cameraResolution
com.opentok.android クラスから継承されたフィールド。PublisherKit
audioLevelListener, audioStatsListener, capturer, context, handler, mediaLinkStatsListener, muteListener, NETWORK_REASON_NETWORK_CONDITION_CHANGE, publisherListener, renderer, rtcStatsReportListener, VIDEO_REASON_CODEC_CHANGE, VIDEO_REASON_NONE, VIDEO_REASON_QUALITY, VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH, VIDEO_REASON_QUALITY_DEGRADATION_CPU, VIDEO_REASON_QUALITY_DEGRADATION_OTHER, VIDEO_REASON_RESOLUTION_CHANGE, videoListener, videoStatsListener
コンストラクタの概要
コンストラクタ
修飾子
コンストラクタ
説明
protected
Publisher(Publisher.Builder builder)
方法の概要
すべてのメソッド インスタンスメソッド 具体的なメソッド 非推奨のメソッド
修飾子と型
方法
説明
void
cycleCamera()
デバイスに複数のカメラが搭載されている場合、カメラ間で切り替わります。
int
getCameraId()
非推奨です。
protected void
onCameraChanged(int newCameraId)
パブリッシャーがアクティブなカメラを変更したときに呼び出されます。
protected void
onCameraError(OpentokError error)
カメラへのアクセス中にエラーが発生した際に呼び出されます。
void
setCameraId(int cameraId)
非推奨です。
void
setCameraListener(Publisher.CameraListener listener)
を Publisher.CameraListener パブリッシャーが使用するカメラが
変更された際に監視するオブジェクト。
void
setCameraTorch(boolean enable)
カメラの推奨懐中電灯(トーチ)モードを設定します。
void
setCameraZoomFactor(float cameraZoomFactor)
カメラの推奨ズーム倍率(比率)。
void
startPreview()
非推奨です。
void
swapCamera()
非推奨です。
com.opentok.android クラスから継承されたメソッド。PublisherKit
destroy, finalize, getCapturer, getDegradationPreference, getMaxVideoBitrate, getName, getPublishAudio, getPublishCaptions, getPublisherVideoType, getPublishVideo, getRenderer, getRtcStatsReport, getSession, getStream, getTargetScalabilityMode, getVideoBitratePreset, getView, onAudioLevelUpdated, onError, onMuteForced, onPause, onRestart, onResume, onRtcStatsReport, onStop, onStreamCreated, onStreamDestroyed, setAudioLevelListener, setAudioStatsListener, setAudioTransformers, setCapturer, setDegradationPreference, setMaxVideoBitrate, setMediaLinkStatsListener, setMuteListener, setName, setPublishAudio, setPublishCaptions, setPublisherListener, setPublisherVideoType, setPublishVideo, setRenderer, setRtcStatsReportListener, setStyle, setTargetScalabilityMode, setVideoBitratePreset, setVideoListener, setVideoStatsListener, setVideoTransformers, update
java.lang クラスから継承されたメソッド。目的
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
フィールドの詳細
カメラのフレームレート
protected Publisher.CameraCaptureFrameRate カメラのフレームレート
cameraResolution
protected Publisher.CameraCaptureResolution cameraResolution
cameraListener
protected Publisher.CameraListener cameraListener
コンストラクタの詳細
出版社
protected Publisher(パブリッシャー.ビルダー (ビルダー)
メソッドの詳細
setCameraListener
public void setCameraListener(Publisher.CameraListener リスナー)
を Publisher.CameraListener パブリッシャーが使用するカメラが
変更された際に監視するオブジェクト。
パラメータ:
: listener - その Publisher.CameraListener インスタンスだ。
setCameraId
@非推奨 public void setCameraId(int cameraId)
非推奨です。
指定したカメラを設定します。 cameraId 0
から android.hardware.Camera#getNumberOfCameras() - 1 までの値をとることができます。
パブリッシャーが使用するカメラが変わると、
Publisher.CameraListener.onCameraChanged(Publisher publisher, int newCameraId)
メソッドが呼び出されます。
このメソッドは非推奨です。新しい cycleCamera() デバイスに複数のカメラが搭載されている場合、
カメラを切り替える方法。
パラメータ:
: cameraId - このパブリッシャーで使用するカメラのID
setCameraTorch
public void setCameraTorch(boolean enable)
カメラの推奨懐中電灯(トーチ)モードを設定します。これは設定項目であるため、 現在使用中のカメラが懐中電灯機能をサポートしていない場合、 この設定が反映されない場合があります(例えば、通常、フロントカメラは懐中電灯機能をサポートしていません)。
パラメータ:
: enable - デフォルト値は false です。true または false を指定することで、
利用可能な場合、パブリッシャーがカメラのフラッシュを
有効にするか無効にするかを指定します。
setCameraZoomFactor
public void setCameraZoomFactor(float cameraZoomFactor)
カメラの推奨ズーム倍率(比率)。 値が 1.0 の場合はズームなし(デフォルトの表示)を表します。値の範囲は 0.5 から最大ズーム倍率までです。0.5 から 1.0 までの値は 超広角(ズームアウト)を表し、1.0 から 最大ズーム倍率までの値はズームインを表します。 実際に適用されるズーム倍率は、 アクティブなカメラの設定でサポートされている範囲内に 自動的に制限されます。カメラが 超広角をサポートしていない場合、1.0未満に設定されたズーム倍率は 有効にならず、ズームは適用されません。 カメラがサポートする最大ズーム倍率を超える値の場合、 ズーム倍率は最大値に設定されます。パブリッシャー カメラが有効になっている場合、このプロパティを取得すると現在のズーム倍率が返されます。 パブリッシャーカメラが無効になっている場合、このプロパティを取得すると 推奨ズーム倍率が返されます。
パラメータ:
: cameraZoomFactor - このプロパティを設定すると、希望するズームレベルを指定できます。
値が 1.0 の場合はズームなし(デフォルトの表示)となります。
cycleCamera
public void cycleCamera()
デバイスに複数のカメラがある場合、カメラを切り替えます。
パブリッシャーが使用するカメラが変わると、
Publisher.CameraListener.onCameraChanged(Publisher publisher, int newCameraId)
メソッドが呼び出されます。
swapCamera
@非推奨 public void swapCamera()
非推奨です。
このメソッドは非推奨です。新しい cycleCamera() デバイスに複数のカメラが搭載されている場合、
カメラを切り替える方法。
カスタムビデオキャプチャ機能を使用している場合は、
BaseVideoCapturer.CaptureSwitch BaseVideoCapturer を継承するオブジェクト内のインターフェースを定義し、
その
BaseVideoCapturer.CaptureSwitch.swapCamera(int cameraId) の挙動を定義する方法
の Publisher.swapCamera() メソッドを使用する。
getCameraId
@非推奨 public int getCameraId()
非推奨です。
現在アクティブなカメラのIDを返します。この値は、0(
背面カメラ)または1(前面カメラ)のいずれかです。もし
setCameraId(int) が呼び出されない場合、戻り値は 1 になります(
前面カメラの場合)。
このメソッドは非推奨です。新しい cycleCamera() デバイスに複数のカメラが搭載されている場合、
カメラを切り替える方法。
onCameraChanged
protected void onCameraChanged(int newCameraId)
パブリッシャーがアクティブなカメラを変更したときに呼び出されます。
Publisher クラスを継承する場合は、このメソッドをオーバーライドすることで、
onCameraChanged() Publisher.CameraListener
インターフェースのメソッド。
パラメータ:
: newCameraId - 新たにアクティブになったカメラのID。
onCameraError
protected void onCameraError(OpentokError (エラー)
カメラへのアクセス中にエラーが発生した際に呼び出されます。
パラメータ:
: error - エラー。
プレビューを開始
@非推奨 public void startPreview()
非推奨です。
バージョン 2.17.0 以降、このメソッドは何も実行しなくなりました。Publisher オブジェクトが作成されるとすぐに、カメラの映像が Publisher のビューに表示されるようになりました。この変更により、 OpenTok クライアント SDK 全体で動作が統一されました。