-
Notifications
You must be signed in to change notification settings - Fork 9
/
openapi.yaml
1613 lines (1612 loc) · 48.1 KB
/
openapi.yaml
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
# This file has been generated using OpenApiSpex. Do not edit manually!
# Run `mix api.spec` to regenerate
---
components:
responses: {}
schemas:
PeerStatus:
description: Informs about the peer status
enum:
- connected
- disconnected
example: disconnected
title: PeerStatus
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.Status
HealthReportStatus:
description: Informs about the status of Fishjam or a specific service
enum:
- UP
- DOWN
example: UP
title: HealthReportStatus
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.HealthReport.Status
RoomDetailsResponse:
description: Response containing room details
properties:
data:
$ref: '#/components/schemas/Room'
required:
- data
title: RoomDetailsResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.RoomDetailsResponse
ComponentOptionsRTSP:
description: Options specific to the RTSP component
properties:
keepAliveInterval:
default: 15000
description: Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
minimum: 0
type: integer
pierceNat:
default: true
description: Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
type: boolean
reconnectDelay:
default: 15000
description: Delay (in ms) between successive reconnect attempts
minimum: 0
type: integer
rtpPort:
default: 20000
description: Local port RTP stream will be received at
maximum: 65535
minimum: 1
type: integer
sourceUri:
description: URI of RTSP source stream
example: rtsp://localhost:554/stream
type: string
required:
- sourceUri
title: ComponentOptionsRTSP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.RTSP.Options
ComponentOptionsSIP:
description: Options specific to the SIP component
properties:
registrarCredentials:
description: Credentials used to authorize in SIP Provider service
properties:
address:
description: 'SIP provider address. Can be in the form of FQDN (my-sip-registrar.net) or IPv4 (1.2.3.4). Port can be specified e.g: 5.6.7.8:9999. If not given, the default SIP port `5060` will be assumed'
example: example.org
type: string
password:
description: Password in SIP service provider
type: string
username:
description: Username in SIP service provider
type: string
required:
- address
- username
- password
title: SIPCredentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP.SIPCredentials
required:
- registrarCredentials
title: ComponentOptionsSIP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP.Options
ComponentPropertiesHLS:
description: Properties specific to the HLS component
properties:
lowLatency:
description: Whether the component uses LL-HLS
type: boolean
persistent:
description: Whether the video is stored after end of stream
type: boolean
playable:
description: Whether the generated HLS playlist is playable
type: boolean
subscribeMode:
description: Whether the HLS component should subscribe to tracks automatically or manually
enum:
- auto
- manual
type: string
targetWindowDuration:
description: Duration of stream available for viewer
nullable: true
type: integer
required:
- playable
- lowLatency
- persistent
- targetWindowDuration
- subscribeMode
title: ComponentPropertiesHLS
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS.Properties
Room:
description: Description of the room state
properties:
components:
description: List of all components
items:
$ref: '#/components/schemas/Component'
type: array
config:
$ref: '#/components/schemas/RoomConfig'
id:
description: Room ID
example: room-1
type: string
peers:
description: List of all peers
items:
$ref: '#/components/schemas/Peer'
type: array
required:
- id
- config
- components
- peers
title: Room
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Room
ComponentOptionsRecording:
description: Options specific to the Recording component
properties:
credentials:
description: An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided
nullable: true
properties:
accessKeyId:
description: An AWS access key identifier, linked to your AWS account.
type: string
bucket:
description: The name of the S3 bucket where your data will be stored.
type: string
region:
description: The AWS region where your bucket is located.
type: string
secretAccessKey:
description: The secret key that is linked to the Access Key ID.
type: string
required:
- accessKeyId
- secretAccessKey
- region
- bucket
title: S3Credentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS.S3
pathPrefix:
description: Path prefix under which all recording are stored
nullable: true
type: string
subscribeMode:
default: auto
description: Whether the Recording component should subscribe to tracks automatically or manually.
enum:
- auto
- manual
type: string
title: ComponentOptionsRecording
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.Recording.Options
Component:
description: Describes component
discriminator:
mapping:
file: '#/components/schemas/ComponentFile'
hls: '#/components/schemas/ComponentHLS'
recording: '#/components/schemas/ComponentRecording'
rtsp: '#/components/schemas/ComponentRTSP'
sip: '#/components/schemas/ComponentSIP'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ComponentHLS'
- $ref: '#/components/schemas/ComponentRTSP'
- $ref: '#/components/schemas/ComponentFile'
- $ref: '#/components/schemas/ComponentSIP'
- $ref: '#/components/schemas/ComponentRecording'
title: Component
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component
PeerOptionsWebRTC:
description: Options specific to the WebRTC peer
properties:
enableSimulcast:
default: true
description: Enables the peer to use simulcast
type: boolean
title: PeerOptionsWebRTC
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.WebRTC
HealthcheckResponse:
description: Response containing health report of Fishjam
properties:
data:
$ref: '#/components/schemas/HealthReport'
required:
- data
title: HealthcheckResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.HealthcheckResponse
ComponentSIP:
description: Describes the SIP component
properties:
id:
description: Assigned component ID
example: component-1
type: string
properties:
$ref: '#/components/schemas/ComponentPropertiesSIP'
tracks:
description: List of all component's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
description: Component type
example: sip
type: string
required:
- id
- type
- properties
- tracks
title: ComponentSIP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP
ComponentHLS:
description: Describes the HLS component
properties:
id:
description: Assigned component ID
example: component-1
type: string
properties:
$ref: '#/components/schemas/ComponentPropertiesHLS'
tracks:
description: List of all component's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
description: Component type
example: hls
type: string
required:
- id
- type
- properties
- tracks
title: ComponentHLS
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS
HlsSkip:
description: Set to "YES" if delta manifest should be requested
example: YES
nullable: true
title: HlsSkip
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.HLS.Params.HlsSkip
PeerMetadata:
description: Custom metadata set by the peer
example:
name: FishjamUser
nullable: true
title: PeerMetadata
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.PeerMetadata
ComponentPropertiesFile:
description: Properties specific to the File component
properties:
filePath:
description: Relative path to track file. Must be either OPUS encapsulated in Ogg or raw h264
type: string
framerate:
description: Framerate of video in a file. It is only valid for video track
example: 30
nullable: true
type: integer
required:
- filePath
- framerate
title: ComponentPropertiesFile
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.File.Properties
ComponentFile:
description: Describes the File component
properties:
id:
description: Assigned component ID
example: component-1
type: string
properties:
$ref: '#/components/schemas/ComponentPropertiesFile'
tracks:
description: List of all component's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
description: Component type
example: file
type: string
required:
- id
- type
- tracks
title: ComponentFile
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.File
SubscriptionConfig:
description: Subscription config
properties:
origins:
description: List of peers and components ids whose tracks the HLS endpoint will subscribe to
items:
type: string
type: array
title: SubscriptionConfig
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Subscription.Origins
HlsMsn:
description: Segment sequence number
example: 10
minimum: 0
nullable: true
title: HlsMsn
type: integer
x-struct: Elixir.FishjamWeb.ApiSpec.HLS.Params.HlsMsn
ComponentPropertiesRecording:
description: Properties specific to the Recording component
properties:
subscribeMode:
description: Whether the Recording component should subscribe to tracks automatically or manually
enum:
- auto
- manual
type: string
required:
- subscribeMode
title: ComponentPropertiesRecording
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.Recording.Properties
DialConfig:
description: Dial config
properties:
phoneNumber:
description: Phone number on which SIP Component will call
type: string
title: DialConfig
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Dial.PhoneNumber
ComponentRTSP:
description: Describes the RTSP component
properties:
id:
description: Assigned component ID
example: component-1
type: string
properties:
$ref: '#/components/schemas/ComponentPropertiesRTSP'
tracks:
description: List of all component's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
description: Component type
example: hls
type: string
required:
- id
- type
- properties
- tracks
title: ComponentRTSP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.RTSP
HlsPart:
description: Partial segment sequence number
example: 10
minimum: 0
nullable: true
title: HlsPart
type: integer
x-struct: Elixir.FishjamWeb.ApiSpec.HLS.Params.HlsPart
WebsocketURL:
description: Websocket URL to which peer has to connect
example: www.fishjam.org/socket/peer
title: WebsocketURL
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.WebSocketUrl
ComponentDetailsResponse:
description: Response containing component details
properties:
data:
$ref: '#/components/schemas/Component'
required:
- data
title: ComponentDetailsResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.ComponentDetailsResponse
ComponentOptionsHLS:
description: Options specific to the HLS component
properties:
lowLatency:
default: false
description: Whether the component should use LL-HLS
type: boolean
persistent:
default: false
description: Whether the video is stored after end of stream
type: boolean
s3:
description: An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided
nullable: true
properties:
accessKeyId:
description: An AWS access key identifier, linked to your AWS account.
type: string
bucket:
description: The name of the S3 bucket where your data will be stored.
type: string
region:
description: The AWS region where your bucket is located.
type: string
secretAccessKey:
description: The secret key that is linked to the Access Key ID.
type: string
required:
- accessKeyId
- secretAccessKey
- region
- bucket
title: S3Credentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS.S3
subscribeMode:
default: auto
description: Whether the HLS component should subscribe to tracks automatically or manually.
enum:
- auto
- manual
type: string
targetWindowDuration:
description: Duration of stream available for viewer
nullable: true
type: integer
title: ComponentOptionsHLS
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS.Options
SIPCredentials:
description: Credentials used to authorize in SIP Provider service
properties:
address:
description: 'SIP provider address. Can be in the form of FQDN (my-sip-registrar.net) or IPv4 (1.2.3.4). Port can be specified e.g: 5.6.7.8:9999. If not given, the default SIP port `5060` will be assumed'
example: example.org
type: string
password:
description: Password in SIP service provider
type: string
username:
description: Username in SIP service provider
type: string
required:
- address
- username
- password
title: SIPCredentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP.SIPCredentials
S3Credentials:
description: An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided
nullable: true
properties:
accessKeyId:
description: An AWS access key identifier, linked to your AWS account.
type: string
bucket:
description: The name of the S3 bucket where your data will be stored.
type: string
region:
description: The AWS region where your bucket is located.
type: string
secretAccessKey:
description: The secret key that is linked to the Access Key ID.
type: string
required:
- accessKeyId
- secretAccessKey
- region
- bucket
title: S3Credentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.HLS.S3
RecordingListResponse:
description: Response containing list of all recording
properties:
data:
items:
type: string
type: array
required:
- data
title: RecordingListResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.RecordingListResponse
ComponentOptions:
description: Component-specific options
oneOf:
- $ref: '#/components/schemas/ComponentOptionsHLS'
- $ref: '#/components/schemas/ComponentOptionsRTSP'
- $ref: '#/components/schemas/ComponentOptionsFile'
- $ref: '#/components/schemas/ComponentOptionsSIP'
- $ref: '#/components/schemas/ComponentOptionsRecording'
title: ComponentOptions
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.Options
Track:
description: Describes media track of a Peer or Component
properties:
id:
type: string
metadata:
nullable: true
type:
enum:
- audio
- video
type: string
title: Track
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Track
HealthReportDistribution:
description: Informs about the status of Fishjam distribution
properties:
enabled:
description: Whether distribution is enabled on this Fishjam
type: boolean
nodeStatus:
$ref: '#/components/schemas/HealthReportStatus'
nodesInCluster:
description: Amount of nodes (including this Fishjam's node) in the distribution cluster
type: integer
required:
- nodeStatus
- nodesInCluster
title: HealthReportDistribution
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.HealthReport.Distribution
ComponentPropertiesRTSP:
description: Properties specific to the RTSP component
properties:
keepAliveInterval:
description: Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
type: integer
pierceNat:
description: Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
type: boolean
reconnectDelay:
description: Delay (in ms) between successive reconnect attempts
type: integer
rtpPort:
description: Local port RTP stream will be received at
type: integer
sourceUri:
description: URI of RTSP source stream
type: string
required:
- sourceUri
- rtpPort
- reconnectDelay
- keepAliveInterval
- pierceNat
title: ComponentPropertiesRTSP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.RTSP.Properties
PeerOptions:
description: Peer-specific options
oneOf:
- $ref: '#/components/schemas/PeerOptionsWebRTC'
title: PeerOptions
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.Options
HealthReport:
description: Describes overall Fishjam health
properties:
distribution:
$ref: '#/components/schemas/HealthReportDistribution'
gitCommit:
description: Commit hash of the build
type: string
status:
$ref: '#/components/schemas/HealthReportStatus'
uptime:
description: Uptime of Fishjam (in seconds)
type: integer
version:
description: Version of Fishjam
type: string
required:
- status
- uptime
- distribution
- version
- gitCommit
title: HealthReport
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.HealthReport
Peer:
description: Describes peer status
properties:
id:
description: Assigned peer id
example: peer-1
type: string
metadata:
$ref: '#/components/schemas/PeerMetadata'
status:
$ref: '#/components/schemas/PeerStatus'
tracks:
description: List of all peer's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
$ref: '#/components/schemas/PeerType'
required:
- id
- type
- status
- tracks
- metadata
title: Peer
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Peer
ComponentType:
description: Component type
example: hls
title: ComponentType
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.Component.Type
AuthToken:
description: Token for authorizing websocket connection
example: 5cdac726-57a3-4ecb-b1d5-72a3d62ec242
title: AuthToken
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.Token
RoomsListingResponse:
description: Response containing list of all rooms
properties:
data:
items:
$ref: '#/components/schemas/Room'
type: array
required:
- data
title: RoomsListingResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.RoomsListingResponse
ComponentPropertiesSIP:
description: Properties specific to the SIP component
properties:
registrarCredentials:
description: Credentials used to authorize in SIP Provider service
properties:
address:
description: 'SIP provider address. Can be in the form of FQDN (my-sip-registrar.net) or IPv4 (1.2.3.4). Port can be specified e.g: 5.6.7.8:9999. If not given, the default SIP port `5060` will be assumed'
example: example.org
type: string
password:
description: Password in SIP service provider
type: string
username:
description: Username in SIP service provider
type: string
required:
- address
- username
- password
title: SIPCredentials
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP.SIPCredentials
required:
- registrarCredentials
title: ComponentPropertiesSIP
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.SIP.Properties
PeerDetailsResponse:
description: Response containing peer details and their token
properties:
data:
properties:
peer:
$ref: '#/components/schemas/Peer'
peer_websocket_url:
$ref: '#/components/schemas/WebsocketURL'
token:
$ref: '#/components/schemas/AuthToken'
required:
- peer
- token
type: object
required:
- data
title: PeerDetailsResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.PeerDetailsResponse
HlsResponse:
description: Requested file
title: HlsResponse
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.HLS.Response
ComponentRecording:
description: Describes the Recording component
properties:
id:
description: Assigned component ID
example: component-1
type: string
properties:
$ref: '#/components/schemas/ComponentPropertiesRecording'
tracks:
description: List of all component's tracks
items:
$ref: '#/components/schemas/Track'
type: array
type:
description: Component type
example: recording
type: string
required:
- id
- type
- properties
- tracks
title: ComponentRecording
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.Recording
PeerType:
description: Peer type
example: webrtc
title: PeerType
type: string
x-struct: Elixir.FishjamWeb.ApiSpec.Peer.Type
RoomCreateDetailsResponse:
description: Response containing room details
properties:
data:
properties:
fishjam_address:
description: Fishjam instance address where the room was created. This might be different than the address of Fishjam where the request was sent only when running a cluster of Fishjams.
example: fishjam1:5003
type: string
room:
$ref: '#/components/schemas/Room'
required:
- room
- fishjam_address
type: object
required:
- data
title: RoomCreateDetailsResponse
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.RoomCreateDetailsResponse
ComponentOptionsFile:
description: Options specific to the File component
properties:
filePath:
description: Path to track file. Must be either OPUS encapsulated in Ogg or raw h264
example: /root/video.h264
type: string
framerate:
description: Framerate of video in a file. It is only valid for video track
example: 30
nullable: true
type: integer
required:
- filePath
title: ComponentOptionsFile
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Component.File.Options
Error:
description: Error message
properties:
errors:
description: Error details
example: Token has expired
type: string
required:
- errors
title: Error
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Error
RoomConfig:
description: Room configuration
properties:
maxPeers:
description: Maximum amount of peers allowed into the room
example: 10
minimum: 1
nullable: true
type: integer
peerDisconnectedTimeout:
description: Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
example: 60
minimum: 1
nullable: true
type: integer
peerlessPurgeTimeout:
description: Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
example: 60
minimum: 1
nullable: true
type: integer
roomId:
description: Custom id used for identifying room within Fishjam. Must be unique across all rooms. If not provided, random UUID is generated.
nullable: true
type: string
videoCodec:
description: Enforces video codec for each peer in the room
enum:
- h264
- vp8
nullable: true
type: string
webhookUrl:
description: URL where Fishjam notifications will be sent
example: https://backend.address.com/fishjam-notifications-endpoint
nullable: true
type: string
title: RoomConfig
type: object
x-struct: Elixir.FishjamWeb.ApiSpec.Room.Config
securitySchemes:
authorization:
scheme: bearer
type: http
info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Fishjam Media Server
version: 0.6.3
openapi: 3.0.0
paths:
/health:
get:
callbacks: {}
operationId: healthcheck
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HealthcheckResponse'
description: Healthy
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unauthorized
security:
- authorization: []
summary: Describes the health of Fishjam
tags:
- health
/hls/{room_id}/{filename}:
get:
callbacks: {}
operationId: getHlsContent
parameters:
- description: Room id
in: path
name: room_id
required: true
schema:
type: string
- description: Name of the file
in: path
name: filename
required: true
schema:
type: string
- description: Byte range of partial segment
in: header
name: range
required: false
schema:
type: string
- description: Segment sequence number
in: query
name: _HLS_msn
required: false
schema:
$ref: '#/components/schemas/HlsMsn'
- description: Partial segment sequence number
in: query
name: _HLS_part
required: false
schema:
$ref: '#/components/schemas/HlsPart'
- description: Is delta manifest requested
in: query
name: _HLS_skip
required: false
schema:
$ref: '#/components/schemas/HlsSkip'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HlsResponse'
description: File was found
'301':
description: Resource available on another Fishjam instance
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Invalid filename
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: File not found
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Service temporarily unavailable
summary: Retrieve HLS Content
tags:
- hls
/recording:
get:
callbacks: {}
operationId: get_recordings
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RecordingListResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unable to obtain recordings
security:
- authorization: []
summary: Lists all available recordings
tags:
- recording