arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Output Profile

hashtag
Get Output Profile List

hashtag
Request

chevron-rightGET /v1/vhosts/{vhost}/apps/{app}/outputProfileshashtag

hashtag
Header

hashtag
Responses

chevron-right200 Okhashtag

The request has succeeded

hashtag
Header

chevron-right401 Unauthorizedhashtag

Authentication required

hashtag
Header

chevron-right404 Not Foundhashtag

The given vhost or application name could not be found.

hashtag
Body

hashtag
Create Output Profile

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

hashtag
Request

chevron-rightPOST /v1/vhosts/{vhost}/apps/{app}/outputProfileshashtag

hashtag
Header

hashtag
Responses

chevron-right200 Okhashtag

The request has succeeded

hashtag
Header

chevron-right207 Multi-Statushashtag

There might be a mixture of responses.

hashtag
Header

chevron-right400 Bad Requesthashtag

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

chevron-right401 Unauthorizedhashtag

Authentication required

hashtag
Header

chevron-right404 Not Foundhashtag

The given vhost or application name could not be found.

hashtag
Body

chevron-right409 Conflicthashtag

A output profile name already exists

hashtag
Get Output Profile Information

hashtag
Request

chevron-rightGET /v1/vhosts/{vhost}/apps/{app}/outputProfiles/{profile}hashtag

hashtag
Header

hashtag
Responses

chevron-right200 Okhashtag

The request has succeeded

hashtag
Header

chevron-right401 Unauthorizedhashtag

Authentication required

hashtag
Header

chevron-right404 Not Foundhashtag

The given vhost or application name could not be found.

hashtag
Body

hashtag
Delete Output Profile

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

hashtag
Request

chevron-rightDELETE /v1/vhosts/{vhost}/apps/{app}/outputProfiles/{profile}hashtag

hashtag
Header

hashtag
Responses

chevron-right200 Okhashtag

The request has succeeded

hashtag
Header

chevron-right401 Unauthorizedhashtag

Authentication required

hashtag
Header

chevron-right404 Not Foundhashtag

The given vhost or application name could not be found.

hashtag
Body

hashtag
Body
hashtag
Body
hashtag
Body

Configure output profiles to be created in Json array format.

hashtag
Body

It responds with Json array for each request.

hashtag
Body

It responds with Json array for each request.

hashtag
Body
hashtag
Body
hashtag
Body
hashtag
Body
hashtag
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": "[HTTP] Authorization header is required to call API (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
}
"
message
"
:
"
OK
"
,
"response": [
"default",
"audio_only"
]
}
# 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
"statusCode": 401
}