Updates the state of an output.
/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}
put
Stream Live Inputs
stream-live-inputs-update-an-output
nullnull[
{
"in": "path",
"name": "output_identifier",
"required": true,
"schema": {
"description": "A unique identifier for the output.",
"example": "baea4d9c515887b80289d5c33cf01145",
"maxLength": 32,
"type": "string"
}
},
{
"in": "path",
"name": "live_input_identifier",
"required": true,
"schema": {
"description": "A unique identifier for a live input.",
"example": "66be4bf738797e01e1fca35a7bdecdcd",
"maxLength": 32,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"enabled": {
"default": true,
"description": "When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.",
"example": true,
"type": "boolean"
}
},
"required": [
"enabled"
]
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"enabled": {
"default": true,
"description": "When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.",
"example": true,
"type": "boolean"
},
"streamKey": {
"description": "The streamKey used to authenticate against an output's target.",
"example": "uzya-f19y-g2g9-a2ee-51j2",
"type": "string"
},
"uid": {
"description": "A unique identifier for the output.",
"example": "baea4d9c515887b80289d5c33cf01145",
"maxLength": 32,
"type": "string"
},
"url": {
"description": "The URL an output uses to restream.",
"example": "rtmp://a.rtmp.youtube.com/live2",
"type": "string"
}
}
}
}
}
]
}
}
},
"description": "Update an output response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Update an output response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]