Skip to content

Commit 7506386

Browse files
nobuo-kobayashinobuo-kobayashi
committed
mediaStreamRecoriding の説明を修正
1 parent 9e2c87b commit 7506386

1 file changed

Lines changed: 133 additions & 41 deletions

File tree

  • dConnectDevicePlugin/dConnectDeviceHost/app/src/main/assets/org_deviceconnect_android_deviceplugin_host/api

‎dConnectDevicePlugin/dConnectDeviceHost/app/src/main/assets/org_deviceconnect_android_deviceplugin_host/api/mediaStreamRecording.json‎

Lines changed: 133 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
"paths": {
1212
"/crop": {
1313
"put": {
14-
"summary": "配信を行う映像の範囲を指定します。",
15-
"description": "現在の配信範囲から指定された範囲まで移動します。",
14+
"summary": "配信を行う映像の範囲を指定する。",
15+
"description": "現在の配信範囲から指定された範囲まで移動する。",
1616
"operationId": "mediaStreamRecordingCropPut",
1717
"parameters": [
1818
{
@@ -32,49 +32,56 @@
3232
{
3333
"name": "name",
3434
"in": "formData",
35-
"description": "範囲指定を行うサーバの名前。 省略された場合は、全てのサーバに範囲指定を行います。",
35+
"description": "範囲指定を行うサーバの名前を指定する。<br> 省略された場合は、全てのサーバに範囲指定を行う。",
3636
"required": false,
3737
"type": "string"
3838
},
3939
{
4040
"name": "left",
4141
"in": "formData",
42-
"description": "範囲の左座標を指定します。",
42+
"description": "範囲の左座標を指定する。",
4343
"required": false,
4444
"type": "integer",
4545
"format": "int64"
4646
},
4747
{
4848
"name": "top",
4949
"in": "formData",
50-
"description": "範囲の上座標を指定します。",
50+
"description": "範囲の上座標を指定する。",
5151
"required": false,
5252
"type": "integer",
5353
"format": "int64"
5454
},
5555
{
5656
"name": "right",
5757
"in": "formData",
58-
"description": "範囲の右座標を指定します。",
58+
"description": "範囲の右座標を指定する。",
5959
"required": false,
6060
"type": "integer",
6161
"format": "int64"
6262
},
6363
{
6464
"name": "bottom",
6565
"in": "formData",
66-
"description": "範囲の下座標を指定します。",
66+
"description": "範囲の下座標を指定する。",
6767
"required": false,
6868
"type": "integer",
6969
"format": "int64"
7070
},
7171
{
7272
"name": "duration",
7373
"in": "formData",
74-
"description": "指定された時間(ミリ秒)をかけて、指定された座標に移動します。 省略された場合には、瞬時に移動します。",
74+
"description": "指定された時間(ミリ秒)をかけて、指定された座標に移動する。<br> 省略された場合には、瞬時に移動する。",
7575
"required": false,
7676
"type": "integer",
7777
"format": "int64"
78+
},
79+
{
80+
"name": "visible",
81+
"in": "formData",
82+
"description": "画面上に範囲枠を表示するか指定する。",
83+
"required": false,
84+
"type": "boolean"
7885
}
7986
],
8087
"responses": {
@@ -141,8 +148,8 @@
141148
},
142149
"/encoder": {
143150
"put": {
144-
"summary": "配信を行うエンコーダの設定を行います。",
145-
"description": "配信を行うエンコーダの設定を行います。",
151+
"summary": "配信を行うエンコーダの設定を行う。",
152+
"description": "配信を行うエンコーダの設定を行う。",
146153
"operationId": "mediaStreamRecordingEncoderPut",
147154
"parameters": [
148155
{
@@ -162,97 +169,97 @@
162169
{
163170
"name": "name",
164171
"in": "formData",
165-
"description": "エンコーダの設定を行うサーバの名前。 省略された場合は、全てのエンコーダに対して処理を行います。",
172+
"description": "エンコーダの設定を行うサーバの名前。 省略された場合は、全てのエンコーダに対して処理を行う。",
166173
"required": false,
167174
"type": "string"
168175
},
169176
{
170177
"name": "mimeType",
171178
"in": "formData",
172-
"description": "マイムタイプを指定します。<br> 以下のマイムタイプをサポートします。<br> - video/x-mjpeg<br> - video/x-rtp<br> - video/MP2T<br> - video/x-rtmp",
179+
"description": "マイムタイプを指定する。<br> 以下のマイムタイプをサポートする。<br> - video/x-mjpeg<br> - video/x-rtp<br> - video/MP2T<br> - video/x-rtmp",
173180
"required": false,
174181
"type": "string"
175182
},
176183
{
177184
"name": "width",
178185
"in": "formData",
179-
"description": "配信する映像の横幅を指定します。",
186+
"description": "配信する映像の横幅を指定する。",
180187
"required": false,
181188
"type": "integer",
182189
"format": "int32"
183190
},
184191
{
185192
"name": "height",
186193
"in": "formData",
187-
"description": "配信する映像の縦幅を指定します。",
194+
"description": "配信する映像の縦幅を指定する。",
188195
"required": false,
189196
"type": "integer",
190197
"format": "int32"
191198
},
192199
{
193200
"name": "frameRate",
194201
"in": "formData",
195-
"description": "配信する映像のフレームレートを指定します。",
202+
"description": "配信する映像のフレームレートを指定する。",
196203
"required": false,
197204
"type": "integer",
198205
"format": "int64"
199206
},
200207
{
201208
"name": "bitRate",
202209
"in": "formData",
203-
"description": "配信する映像のビットレートを指定します。",
210+
"description": "配信する映像のビットレートを指定する。",
204211
"required": false,
205212
"type": "integer",
206213
"format": "int64"
207214
},
208215
{
209216
"name": "keyFrameInterval",
210217
"in": "formData",
211-
"description": "配信する映像のキーフレームインターバルを指定します。",
218+
"description": "配信する映像のキーフレームインターバルを指定する。",
212219
"required": false,
213220
"type": "integer",
214221
"format": "int32"
215222
},
216223
{
217224
"name": "codec",
218225
"in": "formData",
219-
"description": "配信する映像のコーデックを指定します。<br> サポートするコーデック<br> - h264<br> - h265",
226+
"description": "配信する映像のコーデックを指定する。<br> サポートするコーデック<br> - h264<br> - h265",
220227
"required": false,
221228
"type": "string"
222229
},
223230
{
224231
"name": "profile",
225232
"in": "formData",
226-
"description": "配信する映像のコーデックのプロファイルを指定します。<br> サポートされるプロファイルは端末ごとに異なります。",
233+
"description": "配信する映像のコーデックのプロファイルを指定する。<br> サポートされるプロファイルは端末ごとに異なる。",
227234
"required": false,
228235
"type": "string"
229236
},
230237
{
231238
"name": "level",
232239
"in": "formData",
233-
"description": "配信する映像のコーデックのレベルを指定します。<br> サポートされるレベルは端末ごとに異なります。",
240+
"description": "配信する映像のコーデックのレベルを指定する。<br> サポートされるレベルは端末ごとに異なる。",
234241
"required": false,
235242
"type": "string"
236243
},
237244
{
238245
"name": "useSoftwareEncoder",
239246
"in": "formData",
240-
"description": "配信する映像のエンコーダにソフトウェアエンコーダを指定します。",
247+
"description": "配信する映像のエンコーダにソフトウェアエンコーダを指定する。",
241248
"required": false,
242249
"type": "boolean"
243250
},
244251
{
245252
"name": "intraRefresh",
246253
"in": "formData",
247-
"description": "配信する映像のイントラリフレッシュを指定します。",
254+
"description": "配信する映像のイントラリフレッシュを指定する。",
248255
"required": false,
249256
"type": "integer",
250257
"format": "int32"
251258
},
252259
{
253260
"name": "jpegQuality",
254261
"in": "formData",
255-
"description": "配信する映像のJPEGの品質を指定します。<br> video/x-mjpeg のみサポートします。",
262+
"description": "配信する映像のJPEGの品質を指定する。<br> video/x-mjpeg のみサポートする。",
256263
"required": false,
257264
"type": "number",
258265
"maximum": 1.0,
@@ -261,14 +268,14 @@
261268
{
262269
"name": "broadcastUri",
263270
"in": "formData",
264-
"description": "配信先の URI を指定します。<br> video/x-rtmp のみサポートします。",
271+
"description": "配信先の URI を指定する。<br> video/x-rtmp のみサポートする。",
265272
"required": false,
266273
"type": "string"
267274
},
268275
{
269276
"name": "retryCount",
270277
"in": "formData",
271-
"description": "配信先の URI への接続リトライ回数を指定します。<br> video/x-rtmp のみサポートします。",
278+
"description": "配信先の URI への接続リトライ回数を指定する。<br> video/x-rtmp のみサポートする。",
272279
"required": false,
273280
"type": "integer",
274281
"format": "int32"
@@ -300,8 +307,8 @@
300307
"x-type": "one-shot"
301308
},
302309
"delete": {
303-
"summary": "配信を行うエンコーダの削除を行います。",
304-
"description": "配信を行うエンコーダの削除を行います。",
310+
"summary": "配信を行うエンコーダの削除を行う。",
311+
"description": "配信を行うエンコーダの削除を行う。",
305312
"operationId": "mediaStreamRecordingEncoderDelete",
306313
"parameters": [
307314
{
@@ -901,6 +908,13 @@
901908
"required": false,
902909
"type": "string"
903910
},
911+
{
912+
"name": "mimeType",
913+
"in": "formData",
914+
"description": "MimeType。<br> 動画録画・音声録音するときのエンコードするタイプ。",
915+
"required": true,
916+
"type": "string"
917+
},
904918
{
905919
"name": "imageWidth",
906920
"in": "formData",
@@ -937,31 +951,109 @@
937951
"type": "number",
938952
"minimum": 0,
939953
"exclusiveMinimum": true
940-
},
954+
},
941955
{
942-
"name": "previewBitRate",
956+
"name": "previewKeyFrameInterval",
943957
"in": "formData",
944-
"description": "プレビューのビットレート。単位はKbps。",
958+
"description": "プレビュー時のキーフレームインターバル。",
945959
"required": false,
946-
"type": "integer"
947-
},
960+
"type": "number",
961+
"minimum": 0,
962+
"exclusiveMinimum": false
963+
},
948964
{
949-
"name": "previewJpegQuality",
965+
"name": "previewBitRate",
950966
"in": "formData",
951-
"description": "JPEGの品質。範囲は0.0から1.0。MotionJPEGのみサポート。",
967+
"description": "プレビュー時のビットレート。単位は (KB)。",
952968
"required": false,
953969
"type": "number",
954970
"minimum": 0,
955-
"exclusiveMinimum": false,
956-
"maximum": 1,
957-
"exclusiveMaximum": false
958-
},
971+
"exclusiveMinimum": true
972+
},
959973
{
960-
"name": "mimeType",
974+
"name": "previewEncoder",
961975
"in": "formData",
962-
"description": "MimeType。動画録画・音声録音するときのエンコードするタイプ。",
963-
"required": true,
976+
"description": "配信する映像のコーデックを指定する。<br> サポートするコーデック<br> - h264<br> - h265",
977+
"required": false,
964978
"type": "string"
979+
},
980+
{
981+
"name": "previewProfile",
982+
"in": "formData",
983+
"description": "配信する映像のコーデックのプロファイルを指定する。<br> サポートされるプロファイルは端末ごとに異なる。",
984+
"required": false,
985+
"type": "string"
986+
},
987+
{
988+
"name": "previewLevel",
989+
"in": "formData",
990+
"description": "配信する映像のコーデックのレベルを指定する。<br> サポートされるレベルは端末ごとに異なる。",
991+
"required": false,
992+
"type": "string"
993+
},
994+
{
995+
"name": "previewIntraRefresh",
996+
"in": "formData",
997+
"description": "配信する映像のイントラリフレッシュを指定する。",
998+
"required": false,
999+
"type": "integer",
1000+
"format": "int32"
1001+
},
1002+
{
1003+
"name": "previewJpegQuality",
1004+
"in": "formData",
1005+
"description": "配信する映像のJPEGの品質を指定する。<br> video/x-mjpeg のみサポートする。",
1006+
"required": false,
1007+
"type": "number",
1008+
"maximum": 1.0,
1009+
"minimum": 0.0
1010+
},
1011+
{
1012+
"name": "previewClipLeft",
1013+
"in": "formData",
1014+
"description": "範囲の左座標を指定する。",
1015+
"required": false,
1016+
"type": "integer",
1017+
"format": "int64"
1018+
},
1019+
{
1020+
"name": "previewClipTop",
1021+
"in": "formData",
1022+
"description": "範囲の上座標を指定する。",
1023+
"required": false,
1024+
"type": "integer",
1025+
"format": "int64"
1026+
},
1027+
{
1028+
"name": "previewClipRight",
1029+
"in": "formData",
1030+
"description": "範囲の右座標を指定する。",
1031+
"required": false,
1032+
"type": "integer",
1033+
"format": "int64"
1034+
},
1035+
{
1036+
"name": "previewClipBottom",
1037+
"in": "formData",
1038+
"description": "範囲の下座標を指定する。",
1039+
"required": false,
1040+
"type": "integer",
1041+
"format": "int64"
1042+
},
1043+
{
1044+
"name": "previewClipDuration",
1045+
"in": "formData",
1046+
"description": "指定された時間(ミリ秒)をかけて、指定された座標に移動する。<br> 省略された場合には、瞬時に移動する。",
1047+
"required": false,
1048+
"type": "integer",
1049+
"format": "int64"
1050+
},
1051+
{
1052+
"name": "previewClipVisible",
1053+
"in": "formData",
1054+
"description": "画面上に範囲枠を表示するか指定する。",
1055+
"required": false,
1056+
"type": "boolean"
9651057
}
9661058
],
9671059
"responses": {

0 commit comments

Comments
 (0)