Output Profile

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

POST http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles

Creates OutputProfiles in the Application Request Example: POST http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles [ { "name": "bypass_profile", "outputStreamName": "${OriginStreamName}", "encodes": { "videos": [ { "bypass": true } ], "audios": [ { "bypass": true } ] } } ]

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.

Request Body

Name	Type	Description
(json body)	array	List<OutputProfile>

200 - Return type: List<Response<OutputProfile>> - Description Returns a list of created output profile informations

[
	{
		"statusCode": 200,
		"message": "OK",
		"response": {
			"encodes": {
				"audios": [
					{
						"bypass": true
					}
				],
				"images": [],
				"videos": [
					{
						"bypass": true
					}
				]
			},
			"name": "bypass_profile",
			"outputStreamName": "${OriginStreamName}"
		}
	}
]

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}/outputProfiles

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

Lists all output profile names in the Application Request Example: GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles

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 output profile names

{
	"statusCode": 200,
	"message": "OK",
	"response": [
		"bypass.opus",
		"bypass_profile"
	]
}

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}/outputProfiles/{profile_name}

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

Gets the configuration of the OutputProfile Request Example: GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile

Path Parameters

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

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<OutputProfile> - Description Returns the specified output profile information

{
	"statusCode": 200,
	"message": "OK",
	"response": {
		"encodes": {
			"audios": [
				{
					"bypass": true
				}
			],
			"images": [],
			"videos": [
				{
					"bypass": true
				}
			]
		},
		"name": "bypass_profile",
		"outputStreamName": "${OriginStreamName}"
	}
}

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

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

/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}

PUT http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}

Changes the configuration of the OutputProfile Request Example: PUT http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile { "outputStreamName": "${OriginStreamName}", "encodes": { "videos": [ { "codec": "h264", "bitrate": "3M", "width": 1280, "height": 720, "framerate": 30 } ], "audios": [ { "bypass": true } ] } }

Path Parameters

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

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.

Request Body

Name	Type	Description
(json body)	object	OutputProfile

200 - Return type: Response<OutputProfile> - Description Returns the modified output profile information

{
	"statusCode": 200,
	"message": "OK",
	"response": {
		"encodes": {
			"audios": [
				{
					"bypass": true
				}
			],
			"images": [],
			"videos": [
				{
					"active": true,
					"bitrate": "3M",
					"codec": "h264",
					"framerate": 30.0,
					"height": 720,
					"width": 1280
				}
			]
		},
		"name": "bypass_profile",
		"outputStreamName": "${OriginStreamName}"
	}
}

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

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

/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}

DELETE http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}

Deletes the OutputProfile Request Example: DELETE http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile

Path Parameters

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

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<> - Description Returns the result

{
	"statusCode": 200,
	"message": "OK"
}

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

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