RTSP サーバーの開始方法を追記。

Author: masaru-takano

dConnectSDK/dConnectLibStreaming/README.md

@@ -60,8 +60,95 @@ dependencies {
 
 # チュートリアル
 
+libmedia と libsrt の提供するメディアサーバーの開始方法について説明します。
+
+## RTSP サーバー
+libmedia の `RtspServer` クラスは RTSP サーバーの機能を提供します。
+
+### インスタンス生成
+サーバーのインスタンスを作成します。デフォルトのポート番号は 10000 です。
+
+``` java
+RtspServer server = new RtspServer();
+```
+
+### ポート設定
+別のポート番号を指定したい場合は以下で変更します。
+
+``` java
+server.setServerPort(port);
+```
+
+### サーバー名設定
+クライアント側へ RTSP 経由で通知するサーバー名を設定します。
+
+``` java
+server.setServerName("Your Server");
+```
+
+### セッションのコールバック設定
+サーバーから実際に映像と音声を配信するために、セッションのコールバック `RtspServer.Callback` を設定します。
+
+``` java
+server.setCallback(new RtspServer.Callback() {
+    @Override
+    public void createSession(RtspSession session) {
+        // 必要なリソースを確保し、session に設定。
+    }
+
+    @Override
+    public void releaseSession(RtspSession session) {
+        // リソースを解放。
+    }
+});
+```
+
+セッションで映像と音声のリソースのライフサイクルを管理します。
+詳しくは以降の節、または `rtsp-server-app` のソースコードをご参照ください。
+
+### セッション作成処理
+`createSession(RtspSession)` コールバックは、クライアントとの接続が確立した時に呼び出されます。すでに1つ以上の接続がある場合は呼び出されないようになっています。ここで映像・音声のストリームを確保し、`session` に対して設定します。
+
+RTSP では映像・音声についてそれぞれストリームが定義されます。libmedia では、映像・音声のストリームがそれぞれ `VideoStream` と `AudioStream` として提供されます。
+
+各ストリームは、それぞれ1つの映像または音声のエンコーダを持ちます。エンコーダは `VideoEncoder` と `AudioEncoder` のクラスとして定義されています。映像・音声の具体的なソースによって、`VideoEncoder` と `AudioEncoder` の拡張クラスが実装されています。例えば、Android 端末のカメラ映像を Camera2 API で取得する場合は、`CameraSurfaceVideoEncoder` を使用します。
+
+以下、Android 端末のカメラ映像のストリームをセッションに設定するサンプルコードです。
+
+``` java
+// 映像のストリーム作成
+VideoStream videoStream = new CameraH264VideoStream(context);
+videoStream.setDestinationPort(5006);
+((CameraH264VideoStream) videoStream).addSurface(surface);
+
+// 映像のパラメータ設定
+VideoEncoder videoEncoder = videoStream.getVideoEncoder();
+CameraVideoQuality videoQuality = (CameraVideoQuality) videoEncoder.getVideoQuality();
+videoQuality.setFacing(facing);
+videoQuality.setVideoWidth(videoWidth);
+videoQuality.setVideoHeight(videoHeight);
+videoQuality.setIFrameInterval(IFrameInterval);
+videoQuality.setFrameRate(frameRate);
+videoQuality.setBitRate(videoBitRate);
+
+// 映像のストリームをセッションに対して設定
+session.setVideoMediaStream(videoStream);
+```
+
+音声のストリームも同様に設定可能です。
+
+なお、配信しないメディアについては、セッションへの設定を省略することで配信をオフにできます。
+
+### セッション解放処理
+`releaseSession(RtspSession)` コールバックは、すべてのクライアントとの接続が切断された時に呼び出されます。ここで必要に応じてリソースの解放を行います。
+
+### RTSP サーバー起動
+``` java
+server.start();
+```
+
 ## SRT サーバー
-libsrt の `SRTServer` クラスは SRT のサーバー機能を提供します。
+libsrt の `SRTServer` クラスは SRT サーバーの機能を提供します。
 
 ### インスタンス生成
 サーバーのポート番号を指定して、インスタンスを作成します。
@@ -82,10 +169,10 @@ socketOptions.put(SRT.SRTO_PEERIDLETIMEO, 120);
 server setSocketOptions(socketOptions);
 ```
 
-### コールバック設定
-サーバーから実際に映像と音声を配信するためには、`SRTServer.Callback` を設定する必要があります。
+### セッションのコールバック設定
+サーバーから実際に映像と音声を配信するために、セッションのコールバック `SRTServer.Callback` を設定します。
 
-```
+``` java
 mSRTServer.setCallback(new SRTServer.Callback() {
     @Override
     public void createSession(SRTSession session) {
@@ -100,17 +187,18 @@ mSRTServer.setCallback(new SRTServer.Callback() {
 ```
 
 セッションで映像と音声のリソースのライフサイクルを管理します。
-詳しくは以降の節をご参照ください。
-
+詳しくは以降の節、または `srt-server-app` のソースコードをご参照ください。
 
 ### セッション作成処理
 `createSession(SRTSession)` コールバックは、クライアントとの接続が確立した時に呼び出されます。すでに1つ以上の接続がある場合は呼び出されないようになっています。ここで映像・音声のエンコーダを確保し、`session` に対して設定します。
 
-映像・音声のエンコーダは libmedia の `VideoEncoder` と `AudioEncoder` のクラスとして定義されています。映像・音声の具体的なソースによって、`VideoEncoder` と `AudioEncoder` の拡張クラスが実装されています。例えば、Android 端末のカメラ映像を Camera2 API で取得する場合は、`CameraSurfaceVideoEncoder` をセッションに設定します。
+RTSPとは異なり、SRT 自体にはストリームの概念がないため、セッションに直接エンコーダを設定します。
+
+映像・音声のエンコーダは libmedia の `VideoEncoder` と `AudioEncoder` のクラスとして定義されています。映像・音声の具体的なソースによって、`VideoEncoder` と `AudioEncoder` の拡張クラスが実装されています。例えば、Android 端末のカメラ映像を Camera2 API で取得する場合は、`CameraSurfaceVideoEncoder` を使用します。
 
 以下、セッションに映像のエンコーダを設定するサンプルコードです。
 
-```
+``` java
 // Android 端末のカメラ映像のエンコーダを作成
 CameraSurfaceVideoEncoder videoEncoder = new CameraSurfaceVideoEncoder(context, "video/avc");
 videoEncoder.addSurface(surface);
@@ -135,7 +223,7 @@ session.setVideoEncoder(videoEncoder);
 `releaseSession(SRTSession)` コールバックは、すべてのクライアントとの接続が切断された時に呼び出されます。ここで必要に応じてリソースの解放を行います。
 
 ### SRT サーバー起動
-```
+``` java
 server.start();
 ```