All pages
Powered by GitBook
1 of 1

Loading...

Output Profile

Get Output Profile List

Request

GET /v1/vhosts/{vhost}/apps/{app}/outputProfiles

Header

Responses

200 Ok

The request has succeeded

Header

401 Unauthorized

Authentication required

Header

404 Not Found

The given vhost or application name could not be found.

Body

Create Output Profile

Add an Output Profile to the Application. If this request succeeds, the application will be restarted.

Request

POST /v1/vhosts/{vhost}/apps/{app}/outputProfiles

Header

Responses

200 Ok

The request has succeeded

Header

207 Multi-Status

There might be a mixture of responses.

Header

400 Bad Request

Invalid request. Body is not a Json array or does not have a required value

401 Unauthorized

Authentication required

Header

404 Not Found

The given vhost or application name could not be found.

Body

409 Conflict

A output profile name already exists

Get Output Profile Information

Request

GET /v1/vhosts/{vhost}/apps/{app}/outputProfiles/{profile}

Header

Responses

200 Ok

The request has succeeded

Header

401 Unauthorized

Authentication required

Header

404 Not Found

The given vhost or application name could not be found.

Body

Delete Output Profile

Delete output profile settings. If this request succeeds, the Application will be restarted.

Request

DELETE /v1/vhosts/{vhost}/apps/{app}/outputProfiles/{profile}

Header

Responses

200 Ok

The request has succeeded

Header

401 Unauthorized

Authentication required

Header

404 Not Found

The given vhost or application name could not be found.

Body

Body
Body
Body

Configure output profiles to be created in Json array format.

Body

It responds with Json array for each request.

Body

It responds with Json array for each request.

Body
Body
Body
Body
Body
Content-Type: application/json
{
    "message": "[HTTP] Could not find the application: [vhost/app1] (404)",
    "statusCode": 404
}
Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>
WWW-Authenticate: Basic realm=”OvenMediaEngine”
{
	"statusCode": 200,
	"message": "OK",
	"response": [
		"default",
		"audio_only"
	]
}


{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}
Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>
Content-Type: application/json
Content-Type: application/json
WWW-Authenticate: Basic realm=”OvenMediaEngine”
{
    "message": "[HTTP] Could not find the application: [vhost/app1] (404)",
    "statusCode": 404
}
Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>
Content-Type: application/json
WWW-Authenticate: Basic realm=”OvenMediaEngine”
{
    "message": "[HTTP] Could not find the application: [vhost/app1] (404)",
    "statusCode": 404
}
Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>
Content-Type: application/json
WWW-Authenticate: Basic realm=”OvenMediaEngine”
{
    "message": "[HTTP] Could not find the application: [vhost/app1] (404)",
    "statusCode": 404
}
[
  {
    "name": "bypass_profile",
    "outputStreamName": "${OriginStreamName}_bypass",
    "encodes": {
      "videos": [
        {
          "bypass": true
        }
      ],
      "audios": [
        {
          "bypass": true
        }
      ]
    }
  }
]

# name (required)
  The name of the output profile. cannot be duplicated

# outputStreamName (required)
  The name of the output stream to be created through this profile.
  
# encodes (required)
  encode profile list. It must have videos or audios, and must have at least one item.
[
    {
        "statusCode": 200,
        "message": "OK",
        "response": {
            "name": "bypass_profile",
            "outputStreamName": "${OriginStreamName}_bypass",
            "encodes": {
                "audios": [],
                "videos": [
                    {
                        "bypass": true
                    }
                ]
            }
    },
    {
        "statusCode": 200,
        "message": "OK",
        "response": {
            ...
        }
    }
}

# statusCode
    Same as HTTP Status Code
# message
    A human-readable description of the response code
# response
    Created output profile information
[
    {
        "statusCode": 200,
        "message": "OK",
        "response": {
            "name": "app",
            "outputProfiles": {
            ...

            "providers": {
                "ovt": {},
                "rtmp": {},
            ...
    },
    {
        "statusCode": 409,
        "message": "Conflict",
        "response": {
            ...
        }
    }
}

# statusCode
    Same as HTTP Status Code
# message
    A human-readable description of the response code
# response
    Output profile information created when statusCode is 200
{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}
{
    "statusCode": 200,
    "message": "OK",
    "response": {
        "name": "bypass_profile2",
        "outputStreamName": "${OriginStreamName}_bypass"
        "encodes": {
            "audios": [],
            "videos": [
                {
                    "bypass": true
                }
            ]
        }
    }
}

# statusCode
	Same as HTTP Status Code
# message
	A human-readable description of the response code
# response
	Output Profile information
{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}
{
    "message": "OK",
    "statusCode": 200
}

# statusCode
	Same as HTTP Status Code
# message
	A human-readable description of the response code
{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}
# statusCode
Same as HTTP Status Code
# message
A human-readable description of the response code
# response
Json array containing a list of output profile names