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 OutputProfile
s 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 |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
(json body) | array | List< |
/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 |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
/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 |
app_name | string | A name of |
profile_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
/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 |
app_name | string | A name of |
profile_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
(json body) | object |
|
/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 |
app_name | string | A name of |
profile_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Last updated