forked from l3tnun/EPGStation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yml
2420 lines (2294 loc) · 75.7 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
openapi: 3.0.1
info:
version: '~'
title: '~'
license:
name: MIT
url: https://github.com/l3tnun/EPGStation/blob/master/LICENSE
servers: []
paths: {}
components:
schemas:
UnixtimeMS:
description: 時刻 (ms)
type: integer
ChannelId:
description: 放送局 id
type: integer
maximum: 6553565535
ServiceId:
description: service id
type: integer
maximum: 6553565535
NetworkId:
description: network id
type: integer
maximum: 6553565535
ProgramId:
description: program id
type: integer
maximum: 655356553565535
EventId:
description: event id
type: integer
maximum: 655356553565535
RuleId:
description: ルール id
type: integer
ReserveId:
description: 予約 id
type: integer
RecordedId:
description: 録画済み番組 id
type: integer
RecordedHistoryId:
description: 録画済み番組履歴管理 id
type: integer
VideoFileId:
description: ビデオファイル id
type: integer
VideoFileType:
description: ビデオファイル形式
type: string
enum:
- 'ts'
- 'encoded'
ThumbnailId:
description: サムネイル id
type: integer
DropLogFileId:
description: ドロップログファイル id
type: integer
RecordedTagId:
description: 録画 tag id
type: integer
EncodeId:
description: エンコード id
type: integer
ChannelType:
description: 放送波タイプ
type: string
enum:
- GR
- BS
- CS
- SKY
- NW1
- NW2
- NW3
- NW4
- NW5
- NW6
- NW7
- NW8
- NW9
- NW10
- NW11
- NW12
- NW13
- NW14
- NW15
- NW16
- NW17
- NW18
- NW19
- NW20
- NW21
- NW22
- NW23
- NW24
- NW25
- NW26
- NW27
- NW28
- NW29
- NW30
- NW31
- NW32
- NW33
- NW34
- NW35
- NW36
- NW37
- NW38
- NW39
- NW40
ProgramGenreLv1:
description: ジャンル
type: integer
ProgramGenreLv2:
description: サブジャンル
type: integer
ProgramVideoType:
description: 番組ビデオコーデック
type: string
enum:
- mpeg2
- h.264
- h.265
ProgramVideoResolution:
description: 番組ビデオ解像度
type: string
enum:
- 240p
- 480i
- 480p
- 720p
- 1080i
- 1080p
- 2160p
- 4320p
ProgramAudioSamplingRate:
description: 番組オーディオサンプリングレート
type: integer
enum:
- 16000 # 001
- 22050 # 010
- 24000 # 011
- 32000 # 101
- 44100 # 110
- 48000 # 111
StreamId:
description: ストリーム id
type: integer
StreamType:
description: ストリームの種類
type: string
enum:
- LiveStream
- LiveHLS
- RecordedStream
- RecordedHLS
URLSchemeInfo:
description: URL Scheme
type: object
properties:
ios:
type: string
android:
type: string
mac:
type: string
win:
type: string
M2TSStreamParam:
description: M2TS形式ストリーミングパラメータ
type: object
required:
- name
- isUnconverted
properties:
name:
description: 表示名
type: string
isUnconverted:
description: 無変換か
type: boolean
Config:
description: コンフィグ
type: object
required:
- socketIOPort
- broadcast
- recorded
- encode
- urlscheme
- isEnableLiveStream
- isEnableTSRecordedStream
- isEnableEncodedRecordedStream
properties:
socketIOPort:
description: socket.io 通信で使用するポート
type: integer
broadcast:
description: 有効な放送波情報
type: object
required:
- GR
- BS
- CS
- SKY
- NW1
- NW2
- NW3
- NW4
- NW5
- NW6
- NW7
- NW8
- NW9
- NW10
- NW11
- NW12
- NW13
- NW14
- NW15
- NW16
- NW17
- NW18
- NW19
- NW20
properties:
GR:
type: boolean
BS:
type: boolean
CS:
type: boolean
SKY:
type: boolean
NW1:
type: boolean
NW2:
type: boolean
NW3:
type: boolean
NW4:
type: boolean
NW5:
type: boolean
NW6:
type: boolean
NW7:
type: boolean
NW8:
type: boolean
NW9:
type: boolean
NW10:
type: boolean
NW11:
type: boolean
NW12:
type: boolean
NW13:
type: boolean
NW14:
type: boolean
NW15:
type: boolean
NW16:
type: boolean
NW17:
type: boolean
NW18:
type: boolean
NW19:
type: boolean
NW20:
type: boolean
NW21:
type: boolean
NW22:
type: boolean
NW23:
type: boolean
NW24:
type: boolean
NW25:
type: boolean
NW26:
type: boolean
NW27:
type: boolean
NW28:
type: boolean
NW29:
type: boolean
NW30:
type: boolean
NW31:
type: boolean
NW32:
type: boolean
NW33:
type: boolean
NW34:
type: boolean
NW35:
type: boolean
NW36:
type: boolean
NW37:
type: boolean
NW38:
type: boolean
NW39:
type: boolean
NW40:
type: boolean
recorded:
description: 指定可能な録画ディレクトリ名
type: array
items:
type: string
encode:
description: エンコードモード
type: array
items:
type: string
urlscheme:
description: URL Scheme 情報
type: object
required:
- m2ts
- video
- download
properties:
m2ts:
$ref: '#/components/schemas/URLSchemeInfo'
video:
$ref: '#/components/schemas/URLSchemeInfo'
download:
$ref: '#/components/schemas/URLSchemeInfo'
isEnableLiveStream:
description: ライブ視聴が有効か
type: boolean
isEnableTSRecordedStream:
description: 録画済みの TS ファイルのストリーミングが有効か
type: boolean
isEnableEncodedRecordedStream:
description: 録画済みのエンコード済みファイルのストリーミングが有効か
type: boolean
streamConfig:
description: ストリーミング設定
type: object
properties:
live:
description: ライブストリーミング設定
type: object
properties:
m2ts:
description: ライブ M2TS ストリーミング設定
type: array
items:
$ref: '#/components/schemas/M2TSStreamParam'
m2tsll:
description: ライブ M2TS Low Latency (mpegts.js 用) ストリーミング設定
type: array
items:
type: string
webm:
description: ライブ WebM ストリーミング設定
type: array
items:
type: string
mp4:
description: ライブ MP4 ストリーミング設定
type: array
items:
type: string
hls:
description: ライブ HLS ストリーミング設定
type: array
items:
type: string
recorded:
description: 録画済みストリーミング設定
type: object
properties:
ts:
description: 録画済み TS ファイルのストリーミング設定
type: object
properties:
webm:
description: 録画済み TS ファイルの WebM ストリーミング設定
type: array
items:
type: string
mp4:
description: 録画済み TS ファイルの MP4 ストリーミング設定
type: array
items:
type: string
hls:
description: 録画済み TS ファイルの HLS ストリーミング設定
type: array
items:
type: string
encoded:
description: 録画エンコード済みファイルのストリーミング設定
type: object
properties:
webm:
description: 録画エンコード済みファイルの WebM ストリーミング設定
type: array
items:
type: string
mp4:
description: 録画エンコード済みファイルの MP4 ストリーミング設定
type: array
items:
type: string
hls:
description: 録画エンコード済みファイルの HLS ストリーミング設定
type: array
items:
type: string
kodiHosts:
description: kodi hosts
type: array
items:
type: string
ChannelItems:
type: array
items:
$ref: '#/components/schemas/ChannelItem'
ChannelItem:
description: チャンネル情報
required:
- id
- serviceId
- networkId
- name
- halfWidthName
- remoteControlKeyId
- hasLogoData
- channelType
- channel
properties:
id:
$ref: '#/components/schemas/ChannelId'
serviceId:
$ref: '#/components/schemas/ServiceId'
networkId:
$ref: '#/components/schemas/NetworkId'
name:
description: 放送局名
type: string
halfWidthName:
description: 放送局名(半角)
type: string
hasLogoData:
description: ロゴデータを持っているか
type: boolean
channelType:
$ref: '#/components/schemas/ChannelType'
channel:
type: string
type:
type: number
ScheduleChannleItem:
description: 番組表の放送局データ
required:
- id
- serviceId
- networkId
- name
- hasLogoData
- channelType
properties:
id:
$ref: '#/components/schemas/ChannelId'
serviceId:
$ref: '#/components/schemas/ServiceId'
networkId:
$ref: '#/components/schemas/NetworkId'
name:
description: 放送局名
type: string
remoteControlKeyId:
description: リモコン番号
type: integer
hasLogoData:
description: ロゴデータを持っているか
type: boolean
channelType:
$ref: '#/components/schemas/ChannelType'
type:
type: number
ScheduleProgramItem:
description: 番組表の番組データ
required:
- id
- channelId
- startAt
- endAt
- isFree
- name
properties:
id:
$ref: '#/components/schemas/ProgramId'
channelId:
$ref: '#/components/schemas/ChannelId'
startAt:
$ref: '#/components/schemas/UnixtimeMS'
endAt:
$ref: '#/components/schemas/UnixtimeMS'
isFree:
description: 無料放送か
type: boolean
name:
description: 番組名
type: string
description:
description: 番組詳細
type: string
extended:
description: 番組拡張
type: string
rawExtended:
description: 番組拡張 (Mirakurun の extended)
type: object
genre1:
$ref: '#/components/schemas/ProgramGenreLv1'
subGenre1:
$ref: '#/components/schemas/ProgramGenreLv2'
genre2:
$ref: '#/components/schemas/ProgramGenreLv1'
subGenre2:
$ref: '#/components/schemas/ProgramGenreLv2'
genre3:
$ref: '#/components/schemas/ProgramGenreLv1'
subGenre3:
$ref: '#/components/schemas/ProgramGenreLv2'
videoType:
$ref: '#/components/schemas/ProgramVideoType'
videoResolution:
$ref: '#/components/schemas/ProgramVideoResolution'
videoStreamContent:
type: integer
videoComponentType:
type: integer
audioSamplingRate:
$ref: '#/components/schemas/ProgramAudioSamplingRate'
audioComponentType:
type: integer
ScheduleProgramItems:
type: array
items:
$ref: '#/components/schemas/ScheduleProgramItem'
Schedule:
description: 番組表データ
required:
- channel
- programs
properties:
channel:
$ref: '#/components/schemas/ScheduleChannleItem'
programs:
$ref: '#/components/schemas/ScheduleProgramItems'
Schedules:
type: array
items:
$ref: '#/components/schemas/Schedule'
ScheduleSearchOption:
description: 番組検索オプション
type: object
required:
- option
- isHalfWidth
properties:
option:
$ref: '#/components/schemas/RuleSearchOption'
isHalfWidth:
description: 半角文字で取得するか
type: boolean
limit:
description: 検索結果取得最大件数
type: number
Rules:
description: ルール情報
type: object
required:
- rules
- total
properties:
rules:
type: array
items:
$ref: '#/components/schemas/Rule'
total:
description: ルール総件数
type: integer
Rule:
description: ルール
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/RuleId'
reservesCnt:
description: 予約件数
type: integer
allOf:
- $ref: '#/components/schemas/AddRuleOption'
RuleKeywordItem:
type: object
required:
- id
- keyword
properties:
id:
$ref: '#/components/schemas/RuleId'
keyword:
type: string
RuleKeywordInfo:
description: ルールキーワード検索結果
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/RuleKeywordItem'
AddRuleOption:
description: ルール追加プション
type: object
required:
- isTimeSpecification
- searchOption
- reserveOption
properties:
isTimeSpecification:
description: 時刻指定予約か
type: boolean
searchOption:
$ref: '#/components/schemas/RuleSearchOption'
reserveOption:
$ref: '#/components/schemas/RuleReserveOption'
saveOption:
$ref: '#/components/schemas/ReserveSaveOption'
encodeOption:
$ref: '#/components/schemas/ReserveEncodedOption'
RuleSearchOption:
description: ルール検索オプション
type: object
properties:
keyword:
description: 検索キーワード
type: string
ignoreKeyword:
description: 除外検索キーワード
type: string
keyCS:
description: 大文字小文字区別有効化 (検索キーワード)
type: boolean
keyRegExp:
description: 正規表現 (検索キーワード)
type: boolean
name:
description: 番組名 (検索キーワード)
type: boolean
description:
description: 概要 (検索キーワード)
type: boolean
extended:
description: 詳細 (検索キーワード)
type: boolean
ignoreKeyCS:
description: 大文字小文字区別有効化 (除外検索キーワード)
type: boolean
ignoreKeyRegExp:
description: 正規表現 (除外検索キーワード)
type: boolean
ignoreName:
description: 番組名 (除外検索キーワード)
type: boolean
ignoreDescription:
description: 概要 (除外検索キーワード)
type: boolean
ignoreExtended:
description: 詳細 (除外検索キーワード)
type: boolean
GR:
description: GR
type: boolean
BS:
description: BS
type: boolean
CS:
description: CS
type: boolean
SKY:
description: SKY
type: boolean
NW1:
description: NW
type: boolean
NW2:
description: NW
type: boolean
NW3:
description: NW
type: boolean
NW4:
description: NW
type: boolean
NW5:
description: NW
type: boolean
NW6:
description: NW
type: boolean
NW7:
description: NW
type: boolean
NW8:
description: NW
type: boolean
NW9:
description: NW
type: boolean
NW10:
description: NW
type: boolean
NW11:
description: NW
type: boolean
NW12:
description: NW
type: boolean
NW13:
description: NW
type: boolean
NW14:
description: NW
type: boolean
NW15:
description: NW
type: boolean
NW16:
description: NW
type: boolean
NW17:
description: NW
type: boolean
NW18:
description: NW
type: boolean
NW19:
description: NW
type: boolean
NW20:
description: NW
type: boolean
NW21:
description: NW
type: boolean
NW22:
description: NW
type: boolean
NW23:
description: NW
type: boolean
NW24:
description: NW
type: boolean
NW25:
description: NW
type: boolean
NW26:
description: NW
type: boolean
NW27:
description: NW
type: boolean
NW28:
description: NW
type: boolean
NW29:
description: NW
type: boolean
NW30:
description: NW
type: boolean
NW31:
description: NW
type: boolean
NW32:
description: NW
type: boolean
NW33:
description: NW
type: boolean
NW34:
description: NW
type: boolean
NW35:
description: NW
type: boolean
NW36:
description: NW
type: boolean
NW37:
description: NW
type: boolean
NW38:
description: NW
type: boolean
NW39:
description: NW
type: boolean
NW40:
description: NW
type: boolean
channelIds:
description: 放送局
type: array
items:
$ref: '#/components/schemas/ChannelId'
genres:
description: ジャンル
type: array
items:
$ref: '#/components/schemas/Genre'
times:
description: 時刻範囲
type: array
items:
$ref: '#/components/schemas/SearchTime'
isFree:
description: 無料放送か
type: boolean
durationMin:
description: 番組最小時間 (分)
type: integer
durationMax:
description: 番組最大時間 (分)
type: integer
searchPeriods:
description: 検索対象期間
type: array
items:
$ref: '#/components/schemas/SearchPeriod'
Genre:
description: ジャンル設定
type: object
required:
- genre
properties:
genre:
$ref: '#/components/schemas/ProgramGenreLv1'
subGenre:
$ref: '#/components/schemas/ProgramGenreLv2'
SearchTime:
description: 時刻範囲指定オプション
type: object
required:
- week
properties:
start:
description:
開始時刻 1 - 23, 時刻予約の場合は 0 時を 0 とした 0 ~ (60 * 50 * 24) - 1
秒までの開始時刻を指定する
type: integer
range:
description:
開始時刻からの時刻範囲(時) 1 - 23, 時刻予約の場合は秒で時間の長さを指定する 1 ~ 60 * 50 * 24 秒
type: integer
week:
description:
曜日指定 0x01, 0x02, 0x04, 0x08, 0x10, 0x20 ,0x40 が日〜土に対応するので and
演算で曜日を指定する
type: integer
SearchPeriod:
description: 検索対象期間オプション
type: object
required:
- startAt
- endAt
properties:
startAt:
$ref: '#/components/schemas/UnixtimeMS'
endAt:
$ref: '#/components/schemas/UnixtimeMS'
RuleReserveOption:
description: ルール予約オプション
type: object
required:
- enable
- allowEndLack
- avoidDuplicate
properties:
enable:
description: ルールが有効か
type: boolean
allowEndLack:
description: 末尾切れを許可するか
type: boolean
avoidDuplicate:
description: 録画済みの重複番組を排除するか
type: boolean
periodToAvoidDuplicate:
description: 重複を避ける期間
type: integer
tags:
type: array
items:
$ref: '#/components/schemas/RecordedTagId'
ReserveSaveOption:
description: 予約保存オプション
type: object
properties:
parentDirectoryName:
description: 親保存ディレクトリ
type: string
directory:
description: 保存ディレクトリ
type: string
recordedFormat:
description: ファイル名フォーマット
type: string
ReserveEncodedOption:
description: 予約エンコードオプション
required:
- isDeleteOriginalAfterEncode
properties:
mode1:
description: エンコードモード1
type: string
encodeParentDirectoryName1:
description: エンコードモード1親ディレクトリ
type: string
directory1:
description: エンコードモード1ディレクトリ
type: string
mode2:
description: エンコードモード2
type: string