forked from l3tnun/EPGStation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yml
1455 lines (1373 loc) · 34.3 KB
/
api.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: "2.0"
consumes:
- application/json
produces:
- application/json
paths: {}
parameters:
offset:
description: '取得の開始位置'
name: offset
in: query
type: integer
format: int32
minimum: 0
default: 0
limit:
description: '取得数の上限'
name: limit
in: query
type: integer
format: int32
minimum: 1
default: 24
reverse:
description: '逆順にソート'
name: reverse
in: query
type: boolean
default: false
scheduleType:
description: '番組表放送波'
name: type
in: query
required: true
type: string
enum:
- GR
- BS
- CS
- SKY
scheduleTime:
description: '番組表の時刻指定(YYMMDDHH)'
name: time
in: query
type: integer
scheduleLength:
description: '番組表の長さ指定'
name: length
in: query
type: integer
minimum: 1
default: 24
scheduleAddition:
description: '放映中の時刻加算(分)'
name: time
in: query
type: integer
minimum: 0
default: 0
rule:
description: 'rule id'
name: rule
in: query
type: integer
genre1:
description: 'genre1'
name: genre1
in: query
type: integer
minimum: 0
channel:
description: 'channel id'
name: channel
in: query
type: integer
minimum: 0
recordedKeyword:
description: 'recorded search keyword'
name: keyword
in: query
type: string
searchHasTs:
description: 'TSを必ず含む'
name: hasTs
in: query
type: boolean
ruleKeyword:
description: 'rule search keyword'
name: keyword
in: query
type: string
enableonly:
description: 'rule search enableonly'
name: enableonly
in: query
type: boolean
recording:
description: '録画中か'
name: recording
in: query
type: boolean
definitions:
total:
description: '総数'
type: integer
KodiHostIndex:
description: 'kodi host index number'
type: integer
EncodedId:
description: 'encoded id'
type: integer
EncodeId:
description: 'encode id'
type: string
RecordedId:
description: 'recorded id'
type: integer
RuleId:
description: 'rule id'
type: integer
ProgramId:
type: integer
maximum: 655356553565535
EventId:
type: integer
maximum: 65535
ServiceId:
type: integer
maximum: 65535
NetworkId:
type: integer
maximum: 65535
ServiceItemId:
type: integer
maximum: 6553565535
UnixtimeMS:
type: integer
ChannelType:
type: string
enum:
- GR
- BS
- CS
- SKY
remoteControlKeyId:
type: integer
ProgramGenreLv1:
type: integer
ProgramGenreLv2:
type: integer
ProgramVideoType:
type: string
enum:
- mpeg2
- h.264
- h.265
ProgramVideoResolution:
type: string
enum:
- 240p
- 480i
- 480p
- 720p
- 1080i
- 1080p
- 2160p
- 4320p
ProgramAudioSamplingRate:
type: integer
enum:
- 16000 # 001
- 22050 # 010
- 24000 # 011
- 32000 # 101
- 44100 # 110
- 48000 # 111
Config:
description: 'config'
type: object
required:
- socketioPort
- enableEncode
- enableLiveStreaming
- boradcast
properties:
socketioPort:
description: 'Socket.IO で使用するポート'
type: number
enableEncode:
description: 'エンコードが有効か'
type: boolean
enableLiveStreaming:
description: 'ライブ視聴が有効か'
type: boolean
recordedTSDefaultDirectory:
type: string
description: '手動予約時のTSファイルデフォルト保存場所'
recordedEncodeDefaultDirectory:
type: string
description: '手動予約時のエンコードファイルデフォルト保存場所'
encodeOption:
type: array
items:
description: 'エンコードオプション名'
type: string
defaultEncode:
description: '手動予約時のエンコード設定番号'
type: number
delTs:
description: '手動予約時にデフォルトで ts を削除するか'
type: boolean
boradcast:
description: '有効になっている放送波'
type: object
required:
- GR
- BS
- CS
- SKY
properties:
GR:
type: boolean
BS:
type: boolean
CS:
type: boolean
SKY:
type: boolean
recordedViewer:
description: '録画ファイル視聴アプリ設定'
type: object
properties:
ios:
type: string
android:
type: string
mac:
type: string
win:
type: string
recordedDownloader:
description: '録画ファイルダウンロードアプリ設定'
type: object
properties:
ios:
type: string
android:
type: string
mac:
type: string
win:
type: string
mpegTsStreaming:
type: array
items:
description: 'mpeg ts streaming ライブ視聴の設定'
type: string
mpegTsViewer:
description: 'mpeg ts streaming の 視聴アプリ設定'
type: object
properties:
ios:
type: string
android:
type: string
mac:
type: string
win:
type: string
recordedStreaming:
description: '録画ストリーミング配信'
type: object
properties:
mpegTs:
type: array
items:
type: string
webm:
type: array
items:
type: string
mp4:
type: array
items:
type: string
recordedHLS:
type: array
items:
description: 'HLS での録画済みファイルの配信設定'
type: string
liveHLS:
type: array
items:
description: 'HLS ライブ配信の設定'
type: string
HLSViewer:
description: 'HLS 視聴アプリ設定'
type: object
properties:
ios:
type: string
android:
type: string
mac:
type: string
win:
type: string
liveWebM:
type: array
items:
description: 'WebM ライブ配信の設定'
type: string
liveMP4:
type: array
items:
description: 'MP4 ライブ配信の設定'
type: string
kodiHosts:
type: array
items:
description: 'kodi host 名の一覧'
type: string
EncodingInfo:
description: 'encode 中, encode 待ち情報'
type: object
required:
- queue
properties:
encoding:
$ref: '#/definitions/EncodingProgram'
queue:
type: array
items:
$ref: '#/definitions/EncodingProgram'
EncodingProgram:
description: 'encode info'
type: object
required:
- id
- name
- recordedId
- program
properties:
id:
$ref: '#/definitions/EncodeId'
name:
type: string
description: 'encode コマンド名'
recordedId:
$ref: '#/definitions/RecordedId'
encodedId:
$ref: '#/definitions/EncodedId'
mode:
type: integer
description: 'encode コマンド番号'
program:
$ref: '#/definitions/RecordedProgram'
EncodingCancels:
type: object
required:
- ids
properties:
ids:
type: array
items:
$ref: '#/definitions/EncodeId'
SchedulePrograms:
description: '番組データ'
type: array
items:
$ref: '#/definitions/ScheduleProgram'
ScheduleProgram:
type: object
required:
- channel
- programs
properties:
channel:
$ref: '#/definitions/ScheduleServiceItem'
programs:
type: array
items:
$ref: '#/definitions/ScheduleProgramItem'
ScheduleSearch:
description: '番組検索結果'
type: array
items:
$ref: '#/definitions/ScheduleProgramItem'
ScheduleProgramItem:
type: object
required:
- id
- channelId
- startAt
- endAt
- isFree
- name
- channelType
properties:
id:
$ref: '#/definitions/ProgramId'
description: 'program id'
channelId:
$ref: '#/definitions/ServiceItemId'
startAt:
$ref: '#/definitions/UnixtimeMS'
endAt:
$ref: '#/definitions/UnixtimeMS'
isFree:
type: boolean
description: '無料放送か'
name:
type: string
description: '番組タイトル'
description:
type: string
description: '番組詳細'
extended:
type: string
description: '番組拡張'
genre1:
$ref: '#/definitions/ProgramGenreLv1'
genre2:
$ref: '#/definitions/ProgramGenreLv2'
genre3:
$ref: '#/definitions/ProgramGenreLv1'
genre4:
$ref: '#/definitions/ProgramGenreLv2'
genre5:
$ref: '#/definitions/ProgramGenreLv1'
genre6:
$ref: '#/definitions/ProgramGenreLv2'
channelType:
$ref: '#/definitions/ChannelType'
videoType:
$ref: '#/definitions/ProgramVideoType'
videoResolution:
$ref: '#/definitions/ProgramVideoResolution'
videoStreamContent:
type: integer
videoComponentType:
type: integer
audioSamplingRate:
$ref: '#/definitions/ProgramAudioSamplingRate'
audioComponentType:
type: integer
overlap:
description: '録画履歴と重複しているか'
type: boolean
ScheduleServiceItem:
type: object
required:
- id
- serviceId
- networkId
- name
- hasLogoData
- channelType
properties:
id:
$ref: '#/definitions/ServiceItemId'
serviceId:
$ref: '#/definitions/ServiceId'
networkId:
$ref: '#/definitions/NetworkId'
name:
type: string
remoteControlKeyId:
$ref: '#/definitions/remoteControlKeyId'
hasLogoData:
type: boolean
channelType:
$ref: '#/definitions/ChannelType'
ServiceItem:
type: object
required:
- id
- serviceId
- networkId
- name
- hasLogoData
- channelType
- channel
properties:
id:
$ref: '#/definitions/ServiceItemId'
serviceId:
$ref: '#/definitions/ServiceId'
networkId:
$ref: '#/definitions/NetworkId'
name:
type: string
remoteControlKeyId:
$ref: '#/definitions/remoteControlKeyId'
hasLogoData:
type: boolean
channelType:
$ref: '#/definitions/ChannelType'
channel:
type: string
type:
type: number
EncodedProgram:
type: object
required:
- encodedId
- name
- filename
properties:
encodedId:
$ref: '#/definitions/EncodedId'
name:
type: string
filename:
type: string
description: 'ファイル名'
filesize:
type: integer
RecordedEncodingInfo:
type: object
required:
- name
- isEncoding
properties:
name:
type: string
description: エンコードモード名
isEncoding:
type: boolean
description: エンコード中か
RecordedProgram:
type: object
required:
- id
- channelId
- channelType
- startAt
- endAt
- name
- hasThumbnail
- original
- recording
- protection
properties:
id:
$ref: '#/definitions/RecordedId'
channelId:
$ref: '#/definitions/ServiceItemId'
channelType:
$ref: '#/definitions/ChannelType'
startAt:
$ref: '#/definitions/UnixtimeMS'
endAt:
$ref: '#/definitions/UnixtimeMS'
name:
type: string
description: '番組タイトル'
description:
type: string
description: '番組詳細'
extended:
type: string
description: '番組拡張'
genre1:
$ref: '#/definitions/ProgramGenreLv1'
genre2:
$ref: '#/definitions/ProgramGenreLv2'
genre3:
$ref: '#/definitions/ProgramGenreLv1'
genre4:
$ref: '#/definitions/ProgramGenreLv2'
genre5:
$ref: '#/definitions/ProgramGenreLv1'
genre6:
$ref: '#/definitions/ProgramGenreLv2'
videoType:
$ref: '#/definitions/ProgramVideoType'
videoResolution:
$ref: '#/definitions/ProgramVideoResolution'
videoStreamContent:
type: integer
videoComponentType:
type: integer
audioSamplingRate:
$ref: '#/definitions/ProgramAudioSamplingRate'
audioComponentType:
type: integer
recording:
type: boolean
description: '録画中か'
protection:
type: boolean
description: '自動削除から保護するか'
filesize:
type: integer
description: 'ファイルサイズ'
errorCnt:
type: integer
description: 'エラーカウント'
dropCnt:
type: integer
description: 'ドロップカウント'
scramblingCnt:
type: integer
description: 'スクランブル解除漏れカウント'
hasThumbnail:
type: boolean
description: 'サムネイルが作成済みか'
original:
type: boolean
description: 'オリジナルの録画データが削除されていないか'
filename:
type: string
description: 'ファイル名'
encoded:
type: array
items:
$ref: '#/definitions/EncodedProgram'
encoding:
type: array
items:
$ref: '#/definitions/RecordedEncodingInfo'
RecordedDurationInfo:
type: object
required:
- duration
properties:
duration:
type: integer
RecordingProgram:
$ref: '#/definitions/ReserveProgram'
RecordedTags:
description: '録画タグ, ruleId, genre1 は null 値も入る'
type: object
required:
- rule
- channel
- genre
properties:
rule:
type: array
items:
$ref: '#/definitions/RecordedRuleTag'
channel:
type: array
items:
$ref: '#/definitions/RecordedChannelTag'
genre:
type: array
items:
$ref: '#/definitions/RecordedGenreTag'
RecordedRuleTag:
type: object
required:
- cnt
- ruleId
- name
properties:
cnt:
type: integer
ruleId:
$ref: '#/definitions/RuleId'
name:
type: string
RecordedChannelTag:
type: object
required:
- cnt
- channelId
properties:
cnt:
type: integer
channelId:
$ref: '#/definitions/ServiceId'
name:
type: string
RecordedGenreTag:
type: object
required:
- cnt
- genre1
properties:
cnt:
type: integer
genre1:
description: 'null 値も取る'
$ref: '#/definitions/ProgramGenreLv1'
RecordedSendToKodi:
type: object
required:
- kodi
properties:
kodi:
$ref: '#/definitions/KodiHostIndex'
encodedId:
$ref: '#/definitions/EncodedId'
RecordedAddEncode:
type: object
required:
- mode
properties:
mode:
description: 'エンコードモード'
type: integer
encodedId:
$ref: '#/definitions/EncodedId'
directory:
description: 'ディレクトリ'
type: string
isOutputTheOriginalDirectory:
description: '入力元と同じディレクトリに出力するか'
type: boolean
delTs:
description: 'エンコード完了後に ts を削除するか'
type: boolean
NewRecorded:
type: object
required:
- channelId
- startAt
- endAt
- name
properties:
channelId:
$ref: '#/definitions/ServiceItemId'
startAt:
$ref: '#/definitions/UnixtimeMS'
endAt:
$ref: '#/definitions/UnixtimeMS'
name:
type: string
description: '番組タイトル'
description:
type: string
description: '番組詳細'
extended:
type: string
description: '番組拡張'
genre1:
$ref: '#/definitions/ProgramGenreLv1'
genre2:
$ref: '#/definitions/ProgramGenreLv2'
genre3:
$ref: '#/definitions/ProgramGenreLv1'
genre4:
$ref: '#/definitions/ProgramGenreLv2'
genre5:
$ref: '#/definitions/ProgramGenreLv1'
genre6:
$ref: '#/definitions/ProgramGenreLv2'
videoType:
$ref: '#/definitions/ProgramVideoType'
videoResolution:
$ref: '#/definitions/ProgramVideoResolution'
videoStreamContent:
type: integer
videoComponentType:
type: integer
audioSamplingRate:
$ref: '#/definitions/ProgramAudioSamplingRate'
audioComponentType:
type: integer
ruleId:
$ref: '#/definitions/RuleId'
RecordedDeletes:
type: object
required:
- recordedIds
properties:
recordedIds:
type: array
items:
$ref: '#/definitions/RecordedId'
option:
description: 'onlyTs: TS だけ削除, onlyEncoded: エンコード済みファイル削除のみ削除'
type: string
enum:
- 'onlyTs'
- 'onlyEncoded'
AddReserve:
type: object
description: 'program or programId が必須'
properties:
programId:
$ref: '#/definitions/ProgramId'
option:
$ref: '#/definitions/AddReserveOption'
encode:
$ref: '#/definitions/RuleEncode'
program:
$ref: '#/definitions/AddReserveProgram'
EditReserve:
type: object
required:
- allowEndLack
properties:
allowEndLack:
type: boolean
description: 'チューナの使用状況によっては末尾が欠けることを許可'
option:
$ref: '#/definitions/AddReserveOption'
encode:
$ref: '#/definitions/RuleEncode'
program:
$ref: '#/definitions/AddReserveProgram'
AddReserveOption:
type: object
description: '手動予約オプション'
properties:
directory:
type: string
description: '録画データの保存場所'
recordedFormat:
type: string
description: '録画ファイル名フォーマット'
AddReserveProgram:
type: object
description: '時刻指定予約番組情報オプション'
required:
- channelId
- startAt
- endAt
- name
properties:
channelId:
$ref: '#/definitions/ServiceItemId'
startAt:
$ref: '#/definitions/UnixtimeMS'
endAt:
$ref: '#/definitions/UnixtimeMS'
name:
type: string
description: '番組タイトル'
description:
type: string
description: '番組詳細'
extended:
type: string
description: '番組拡張'
genre1:
$ref: '#/definitions/ProgramGenreLv1'
genre2:
$ref: '#/definitions/ProgramGenreLv2'
genre3:
$ref: '#/definitions/ProgramGenreLv1'
genre4:
$ref: '#/definitions/ProgramGenreLv2'
genre5:
$ref: '#/definitions/ProgramGenreLv1'
genre6:
$ref: '#/definitions/ProgramGenreLv2'
AddReserveResult:
type: object
required:
- programId
properties:
programId:
$ref: '#/definitions/ProgramId'
ReservePositionResult:
type: object
description: '指定した programId 予約の位置'
properties:
position:
type: integer
Reserve:
type: object
required:
- program
- allowEndLack
description: 'program は必須項目'
properties:
program:
$ref: '#/definitions/ReserveProgram'
ruleId:
$ref: '#/definitions/RuleId'
isTimeSpecifited:
description: '時刻指定予約か'
type: boolean
allowEndLack:
description: 'チューナの使用状況によっては末尾が欠けることを許可する'
type: boolean
option:
$ref: '#/definitions/AddReserveOption'
encode:
$ref: '#/definitions/RuleEncode'
ReserveAllId:
type: object
description: '予約一覧の program id を抜き出したもの'
required:
- reserves
- conflicts
- skips
- overlaps
properties:
reserves:
type: array
items:
$ref: '#/definitions/ReserveAllItem'
conflicts:
type: array
items:
$ref: '#/definitions/ReserveAllItem'
skips:
type: array
items:
$ref: '#/definitions/ReserveAllItem'
overlaps:
type: array
items:
$ref: '#/definitions/ReserveAllItem'
ReserveAllItem:
type: object
required:
- programId
properties:
programId:
$ref: '#/definitions/ProgramId'
ruleId:
$ref: '#/definitions/RuleId'
ReserveProgram:
type: object
description: '予約番組情報'
required:
- id
- channelId
- eventId
- serviceId
- networkId
- startAt
- endAt
- isFree
- name