Skip to content

Commit 8636d06

Browse files
ioppermannioppermann
committed
Export better RTMP and SRT channel lists
1 parent da6848c commit 8636d06

12 files changed

Lines changed: 641 additions & 27 deletions

File tree

‎docs/docs.go‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5564,6 +5564,35 @@ const docTemplate = `{
55645564
],
55655565
"summary": "List all publishing RTMP streams",
55665566
"operationId": "rtmp-3-list-channels",
5567+
"responses": {
5568+
"200": {
5569+
"description": "OK",
5570+
"schema": {
5571+
"type": "array",
5572+
"items": {
5573+
"$ref": "#/definitions/api.RTMPChannelName"
5574+
}
5575+
}
5576+
}
5577+
}
5578+
}
5579+
},
5580+
"/api/v3/rtmp/channels": {
5581+
"get": {
5582+
"security": [
5583+
{
5584+
"ApiKeyAuth": []
5585+
}
5586+
],
5587+
"description": "List all currently publishing RTMP streams and their subscriber",
5588+
"produces": [
5589+
"application/json"
5590+
],
5591+
"tags": [
5592+
"v16.?.?"
5593+
],
5594+
"summary": "List all publishing RTMP streams",
5595+
"operationId": "rtmp-3-list-all-channels",
55675596
"responses": {
55685597
"200": {
55695598
"description": "OK",
@@ -5826,6 +5855,38 @@ const docTemplate = `{
58265855
}
58275856
}
58285857
},
5858+
"/api/v3/srt/channels": {
5859+
"get": {
5860+
"security": [
5861+
{
5862+
"ApiKeyAuth": []
5863+
}
5864+
],
5865+
"description": "List all currently publishing SRT streams and their subscribers. This endpoint is EXPERIMENTAL and may change in future.",
5866+
"produces": [
5867+
"application/json"
5868+
],
5869+
"tags": [
5870+
"v16.?.?"
5871+
],
5872+
"summary": "List all publishing SRT treams",
5873+
"operationId": "srt-3-list-allchannels",
5874+
"responses": {
5875+
"200": {
5876+
"description": "OK",
5877+
"schema": {
5878+
"type": "array",
5879+
"items": {
5880+
"type": "array",
5881+
"items": {
5882+
"$ref": "#/definitions/api.SRTChannelX"
5883+
}
5884+
}
5885+
}
5886+
}
5887+
}
5888+
}
5889+
},
58295890
"/api/v3/srt/disconnect": {
58305891
"put": {
58315892
"security": [
@@ -8923,13 +8984,53 @@ const docTemplate = `{
89238984
}
89248985
},
89258986
"api.RTMPChannel": {
8987+
"type": "object",
8988+
"properties": {
8989+
"is_proxy": {
8990+
"type": "boolean"
8991+
},
8992+
"name": {
8993+
"type": "string"
8994+
},
8995+
"publisher": {
8996+
"$ref": "#/definitions/api.RTMPConnection"
8997+
},
8998+
"subscriber": {
8999+
"type": "array",
9000+
"items": {
9001+
"$ref": "#/definitions/api.RTMPConnection"
9002+
}
9003+
}
9004+
}
9005+
},
9006+
"api.RTMPChannelName": {
89269007
"type": "object",
89279008
"properties": {
89289009
"name": {
89299010
"type": "string"
89309011
}
89319012
}
89329013
},
9014+
"api.RTMPConnection": {
9015+
"type": "object",
9016+
"properties": {
9017+
"created_at": {
9018+
"type": "integer",
9019+
"format": "int64"
9020+
},
9021+
"remote": {
9022+
"type": "string"
9023+
},
9024+
"rx_bytes": {
9025+
"type": "integer",
9026+
"format": "uint64"
9027+
},
9028+
"tx_bytes": {
9029+
"type": "integer",
9030+
"format": "uint64"
9031+
}
9032+
}
9033+
},
89339034
"api.SRTChannel": {
89349035
"type": "object",
89359036
"properties": {
@@ -8962,6 +9063,26 @@ const docTemplate = `{
89629063
}
89639064
}
89649065
},
9066+
"api.SRTChannelX": {
9067+
"type": "object",
9068+
"properties": {
9069+
"is_proxy": {
9070+
"type": "boolean"
9071+
},
9072+
"name": {
9073+
"type": "string"
9074+
},
9075+
"publisher": {
9076+
"$ref": "#/definitions/api.SRTConnectionX"
9077+
},
9078+
"subscriber": {
9079+
"type": "array",
9080+
"items": {
9081+
"$ref": "#/definitions/api.SRTConnectionX"
9082+
}
9083+
}
9084+
}
9085+
},
89659086
"api.SRTConnection": {
89669087
"type": "object",
89679088
"properties": {
@@ -8979,6 +9100,29 @@ const docTemplate = `{
89799100
}
89809101
}
89819102
},
9103+
"api.SRTConnectionX": {
9104+
"type": "object",
9105+
"properties": {
9106+
"created_at": {
9107+
"type": "integer",
9108+
"format": "int64"
9109+
},
9110+
"remote": {
9111+
"type": "string"
9112+
},
9113+
"rx_bytes": {
9114+
"type": "integer",
9115+
"format": "uint64"
9116+
},
9117+
"stats": {
9118+
"$ref": "#/definitions/api.SRTStatistics"
9119+
},
9120+
"tx_bytes": {
9121+
"type": "integer",
9122+
"format": "uint64"
9123+
}
9124+
}
9125+
},
89829126
"api.SRTLog": {
89839127
"type": "object",
89849128
"properties": {

‎docs/swagger.json‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5557,6 +5557,35 @@
55575557
],
55585558
"summary": "List all publishing RTMP streams",
55595559
"operationId": "rtmp-3-list-channels",
5560+
"responses": {
5561+
"200": {
5562+
"description": "OK",
5563+
"schema": {
5564+
"type": "array",
5565+
"items": {
5566+
"$ref": "#/definitions/api.RTMPChannelName"
5567+
}
5568+
}
5569+
}
5570+
}
5571+
}
5572+
},
5573+
"/api/v3/rtmp/channels": {
5574+
"get": {
5575+
"security": [
5576+
{
5577+
"ApiKeyAuth": []
5578+
}
5579+
],
5580+
"description": "List all currently publishing RTMP streams and their subscriber",
5581+
"produces": [
5582+
"application/json"
5583+
],
5584+
"tags": [
5585+
"v16.?.?"
5586+
],
5587+
"summary": "List all publishing RTMP streams",
5588+
"operationId": "rtmp-3-list-all-channels",
55605589
"responses": {
55615590
"200": {
55625591
"description": "OK",
@@ -5819,6 +5848,38 @@
58195848
}
58205849
}
58215850
},
5851+
"/api/v3/srt/channels": {
5852+
"get": {
5853+
"security": [
5854+
{
5855+
"ApiKeyAuth": []
5856+
}
5857+
],
5858+
"description": "List all currently publishing SRT streams and their subscribers. This endpoint is EXPERIMENTAL and may change in future.",
5859+
"produces": [
5860+
"application/json"
5861+
],
5862+
"tags": [
5863+
"v16.?.?"
5864+
],
5865+
"summary": "List all publishing SRT treams",
5866+
"operationId": "srt-3-list-allchannels",
5867+
"responses": {
5868+
"200": {
5869+
"description": "OK",
5870+
"schema": {
5871+
"type": "array",
5872+
"items": {
5873+
"type": "array",
5874+
"items": {
5875+
"$ref": "#/definitions/api.SRTChannelX"
5876+
}
5877+
}
5878+
}
5879+
}
5880+
}
5881+
}
5882+
},
58225883
"/api/v3/srt/disconnect": {
58235884
"put": {
58245885
"security": [
@@ -8916,13 +8977,53 @@
89168977
}
89178978
},
89188979
"api.RTMPChannel": {
8980+
"type": "object",
8981+
"properties": {
8982+
"is_proxy": {
8983+
"type": "boolean"
8984+
},
8985+
"name": {
8986+
"type": "string"
8987+
},
8988+
"publisher": {
8989+
"$ref": "#/definitions/api.RTMPConnection"
8990+
},
8991+
"subscriber": {
8992+
"type": "array",
8993+
"items": {
8994+
"$ref": "#/definitions/api.RTMPConnection"
8995+
}
8996+
}
8997+
}
8998+
},
8999+
"api.RTMPChannelName": {
89199000
"type": "object",
89209001
"properties": {
89219002
"name": {
89229003
"type": "string"
89239004
}
89249005
}
89259006
},
9007+
"api.RTMPConnection": {
9008+
"type": "object",
9009+
"properties": {
9010+
"created_at": {
9011+
"type": "integer",
9012+
"format": "int64"
9013+
},
9014+
"remote": {
9015+
"type": "string"
9016+
},
9017+
"rx_bytes": {
9018+
"type": "integer",
9019+
"format": "uint64"
9020+
},
9021+
"tx_bytes": {
9022+
"type": "integer",
9023+
"format": "uint64"
9024+
}
9025+
}
9026+
},
89269027
"api.SRTChannel": {
89279028
"type": "object",
89289029
"properties": {
@@ -8955,6 +9056,26 @@
89559056
}
89569057
}
89579058
},
9059+
"api.SRTChannelX": {
9060+
"type": "object",
9061+
"properties": {
9062+
"is_proxy": {
9063+
"type": "boolean"
9064+
},
9065+
"name": {
9066+
"type": "string"
9067+
},
9068+
"publisher": {
9069+
"$ref": "#/definitions/api.SRTConnectionX"
9070+
},
9071+
"subscriber": {
9072+
"type": "array",
9073+
"items": {
9074+
"$ref": "#/definitions/api.SRTConnectionX"
9075+
}
9076+
}
9077+
}
9078+
},
89589079
"api.SRTConnection": {
89599080
"type": "object",
89609081
"properties": {
@@ -8972,6 +9093,29 @@
89729093
}
89739094
}
89749095
},
9096+
"api.SRTConnectionX": {
9097+
"type": "object",
9098+
"properties": {
9099+
"created_at": {
9100+
"type": "integer",
9101+
"format": "int64"
9102+
},
9103+
"remote": {
9104+
"type": "string"
9105+
},
9106+
"rx_bytes": {
9107+
"type": "integer",
9108+
"format": "uint64"
9109+
},
9110+
"stats": {
9111+
"$ref": "#/definitions/api.SRTStatistics"
9112+
},
9113+
"tx_bytes": {
9114+
"type": "integer",
9115+
"format": "uint64"
9116+
}
9117+
}
9118+
},
89759119
"api.SRTLog": {
89769120
"type": "object",
89779121
"properties": {

0 commit comments

Comments
 (0)