Stream

/v1/vhosts/{vhost_name}/apps/{app_name}/streams

GET http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/streams

Lists all stream names in the Application Request Example: GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/streams

Path Parameters

Name	Type	Description
vhost_name	string	A name of VirtualHost
app_name	string	A name of Application

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

200 - Return type: Response<List<string>> - Description Returns a list of stream names

{
	"statusCode": 200,
	"message": "OK",
	"response": [
		"stream"
	]
}

404 - Return type: Response<> - Description Not Found

{
	"statusCode": 404,
	"message": "Could not find the application: [default/non-exists] (404)"
}

/v1/vhosts/{vhost_name}/apps/{app_name}/streams/{stream_name}

GET http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/streams/{stream_name}

Gets the configuration of the Stream Request Example: GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/streams/stream

Path Parameters

Name	Type	Description
vhost_name	string	A name of VirtualHost
app_name	string	A name of Application
stream_name	string	A name of Stream

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

200 - Return type: Response<Stream> - Description Returns the specified stream information

{
	"statusCode": 200,
	"message": "OK",
	"response": {
		"input": {
			"createdTime": "2021-01-11T03:45:21.879+09:00",
			"sourceType": "Rtmp",
			"tracks": [
				{
					"type": "Video",
					"video": {
						"bitrate": "2500000",
						"bypass": false,
						"codec": "H264",
						"framerate": 30.0,
						"height": 720,
						"width": 1280
					}
				},
				{
					"audio": {
						"bitrate": "128000",
						"bypass": false,
						"channel": 2,
						"codec": "AAC",
						"samplerate": 48000
					},
					"type": "Audio"
				}
			]
		},
		"name": "stream",
		"outputs": [
			{
				"name": "stream",
				"tracks": [
					{
						"type": "Video",
						"video": {
							"bypass": true
						}
					},
					{
						"audio": {
							"bypass": true
						},
						"type": "Audio"
					},
					{
						"audio": {
							"bitrate": "128000",
							"bypass": false,
							"channel": 2,
							"codec": "OPUS",
							"samplerate": 48000
						},
						"type": "Audio"
					}
				]
			}
		]
	}
}

404 - Return type: Response<> - Description Not Found

{
	"statusCode": 404,
	"message": "Could not find the output profile: [default/app/non-exists] (404)"
}