| \nWant to take the API for a test run?\n\nAll you'll need is a [Wowza Video subscription](https://www.wowza.com/pricing), or [free trial](https://www.wowza.com/free-trial), for the API access token. Then, fork [our collection in Postman](https://www.postman.com/wowzavideo/workspace/wowza-video-rest-api) and you'll be\nmaking calls to our REST API in minutes!\n\nSee [Trial the Wowza Video REST API using Postman](https://www.wowza.com/docs/trial-the-wowza-video-rest-api-using-postman) for more information.\n | \n
To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.", "x-displayName": "Real-Time Streams" }, { "name": "usage", "description": "Operations related to stream target analytics, including CDN usage and viewer data.", "x-displayName": "Stream Targets" }, { "name": "usage_transcoders", "description": "Operations related to transcoder analytics.", "x-displayName": "Transcoders" }, { "name": "usage_live_streams", "description": "Operations related to livestream analytics.", "x-displayName": "Livestreams" }, { "name": "storage", "description": "Operations related to peak storage for an account. You can use this operation to show the amount of peak recording and VOD stream storage used by your account.", "x-displayName": "Storage" }, { "name": "usage_vod_streams", "description": "Operations related to video on demand (VOD) stream analytics.", "x-displayName": "VOD Streams" }, { "name": "usage_real_time_streams", "description": "Operations related to real-time streams analytics.", "x-displayName": "Real Time Streams" }, { "name": "usage_account", "description": "Operations related to stream analytics for an account.", "x-displayName": "Account" }, { "name": "analytics_viewers", "description": "Operations related to viewer analytics.", "x-displayName": "Viewers" }, { "name": "analytics_ingest", "description": "Operations related to ingest analytics for a live stream.", "x-displayName": "Ingest" }, { "name": "analytics_engagement", "description": "Operations related to engagement analytics for a VOD stream.", "x-displayName": "Engagement" }, { "name": "analytics_popularity", "description": "Operations related to popularity analytics.", "x-displayName": "Popularity" } ], "paths": { "/live_streams": { "post": { "summary": "Create a live stream", "description": "This operation creates a live stream.", "operationId": "createLiveStream", "tags": [ "live_streams" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v1.11/live_streams\" \\\n -d $'{\n \"live_stream\": {\n \"name\": \"My New Live Stream\",\n \"transcoder_type\": \"transcoded\",\n \"billing_mode\": \"pay_as_you_go\",\n \"broadcast_location\": \"us_west_california\",\n \"encoder\": \"other_rtmp\",\n \"delivery_method\": \"push\",\n \"aspect_ratio_width\": 1920,\n \"aspect_ratio_height\": 1080\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/live_streams';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"live_stream\": {\n \"name\": \"My New Live Stream\",\n \"transcoder_type\": \"transcoded\",\n \"billing_mode\": \"pay_as_you_go\",\n \"broadcast_location\": \"us_west_california\",\n \"encoder\": \"other_rtmp\",\n \"delivery_method\": \"push\",\n \"aspect_ratio_width\": 1920,\n \"aspect_ratio_height\": 1080\n }\n}));\nreq.end();\n" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/live_stream_create_input" } } }, "description": "Provide the details of the live stream to create in the body of the request.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "live_stream" ], "properties": { "live_stream": { "$ref": "#/components/schemas/live_stream" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } }, "get": { "summary": "Fetch all live streams", "description": "This operation shows limited details for all of your live streams. For detailed information, fetch a single live stream.", "operationId": "listLiveStreams", "tags": [ "live_streams" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/live_streams\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/live_streams';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/live_streams" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } } } } }, "/live_streams/{id}": { "get": { "summary": "Fetch a live stream", "description": "This operation shows the details of a specific live stream.", "operationId": "showLiveStream", "tags": [ "live_streams" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/live_streams/2adffc17\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/live_streams/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the live stream.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "live_stream" ], "properties": { "live_stream": { "$ref": "#/components/schemas/live_stream" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } }, "patch": { "summary": "Update a live stream", "description": "This operation updates a live stream.", "operationId": "updateLiveStream", "tags": [ "live_streams" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/live_streams/2adffc17\" \\\n -d $'{\n \"live_stream\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/live_streams/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"live_stream\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the live stream.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/live_stream_update_input" } } }, "description": "Provide the details of the live stream to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "live_stream" ], "properties": { "live_stream": { "$ref": "#/components/schemas/live_stream" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } }, "delete": { "summary": "Delete a live stream", "description": "This operation deletes a live stream, including all assigned outputs and targets.
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "listPlayers", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/players\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/players" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } } } } }, "/players/{id}": { "get": { "summary": "Fetch a player", "description": "This operation shows details of a specific player.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "showPlayer", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "player" ], "properties": { "player": { "$ref": "#/components/schemas/player" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } }, "patch": { "summary": "Update a player", "description": "This operation updates a player.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "updatePlayer", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17\" \\\n -d $'{\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/player_update_input" } } }, "description": "Provide the details of the player to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "player" ], "properties": { "player": { "$ref": "#/components/schemas/player" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } } }, "/players/{id}/rebuild": { "post": { "summary": "Rebuild player code", "description": "This operation rebuilds the player with the current configuration.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "requestPlayerRebuild", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/rebuild\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/rebuild';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.end();\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "player" ], "properties": { "player": { "type": "object", "title": "player", "properties": { "state": { "type": "string", "description": "The state of the player.", "example": "requested", "enum": [ "requested", "already_requested", "activated" ] } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } } }, "/players/{id}/state": { "get": { "summary": "Fetch the state of a player", "description": "This operation shows the current state of a player.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "showPlayerState", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/state\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/state';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "player" ], "properties": { "player": { "type": "object", "title": "player", "properties": { "state": { "type": "string", "description": "The state of the player.", "example": "activated", "enum": [ "requested", "activated" ] } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } } }, "/players/{player_id}/urls": { "post": { "summary": "Create a player URL", "description": "This operation creates a new player URL.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "createPlayerUrl", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/urls\" \\\n -d $'{\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/urls';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/url_create_input" } } }, "description": "Provide the details of the player URL to create in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "$ref": "#/components/schemas/url" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } }, "get": { "summary": "Fetch all player URLs", "description": "This operation shows the details of all player URLs.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "listPlayerUrls", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/urls\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/urls';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/urls" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } } }, "/players/{player_id}/urls/{id}": { "get": { "summary": "Fetch a player URL", "description": "This operation shows the details of a player URL.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "showPlayerUrl", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/urls/1acfg43d\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/urls/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player URL.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "$ref": "#/components/schemas/url" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } }, "patch": { "summary": "Update a player URL", "description": "This operation updates a player URL.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "updatePlayerUrl", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/urls/1acfg43d\" \\\n -d $'{\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/urls/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"player\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player URL.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/url_update_input" } } }, "description": "Provide the details of the player URL to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "$ref": "#/components/schemas/url" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } }, "delete": { "summary": "Delete a player URL", "description": "This operation deletes a player URL.\n
If you're using the 1.11 API with the new Wowza Video user interface, these endpoints are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "operationId": "deletePlayerUrl", "tags": [ "players" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v1.11/players/2adffc17/urls/1acfg43d\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/players/2adffc17/urls/1acfg43d';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "player_id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the player URL.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } } }, "/assets": { "post": { "summary": "Create an asset", "description": "This operation creates an asset. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected.", "operationId": "createAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v1.11/assets\" \\\n -d $'{\n \"asset\": {\n \"name\": \"My New Asset\"\n }\n}'" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'POST',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"asset\": {\n \"name\": \"My New Asset\"\n }\n}));\nreq.end();\n" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset_create_input" } } }, "description": "Provide the details of the asset to create in the body of the request.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "asset" ], "properties": { "asset": { "$ref": "#/components/schemas/asset_create_output" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } }, "get": { "summary": "Fetch all assets", "description": "This operation shows limited details for all of your assets. For detailed information, fetch a single asset.", "operationId": "listAssets", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/assets\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "filter", "in": "query", "required": false, "description": "Restricts the data that gets returned by filtering on one or more values associated with a field. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**filter[0][field]=created_at&filter[0][gte]=2021-07-14T17:47:45.000Z**", "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "description": "Restricts the data that gets returned by querying on one or more values associated with a set of fields. For more information and examples, see the technical article [How to get filtered query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).\n\nExample:\n**sort_direction=desc&sort_column=created_at&per_page=30&state=completed&query=sample**", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assets" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } } } } }, "/assets/{id}": { "get": { "summary": "Fetch an asset", "description": "This operation shows the details of a specific asset.\n\nThe fields returned vary depending on when you send this request. For example, if a resource hasn't been created yet during the processing state, you won't see **available_renditions** in the response.\n\n**Tip**: If your original upload URL expired and you need a new one for an asset, send this request and the response will contain a new upload URL.", "operationId": "showAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "asset" ], "properties": { "asset": { "$ref": "#/components/schemas/asset" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } }, "patch": { "summary": "Update an asset", "description": "This operation updates an asset. Assets must be uploaded and complete processing before they can be updated.\n\nThe fields returned vary depending on when you send this request. For example, if a stream doesn't have unique viewer data, you won't see **unique_viewers** in the response.", "operationId": "updateAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17\" \\\n -d $'{\n \"asset\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"asset\": {\n \"property\": \"My Value\",\n \"...\": \"...\"\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset_update_input" } } }, "description": "Provide the details of the asset to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "asset" ], "properties": { "asset": { "$ref": "#/components/schemas/asset_update_output" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Asset Not Available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422_asset_not_available" } } } } } }, "delete": { "summary": "Delete an asset", "description": "This operation deletes an asset, including all assigned outputs and targets.", "operationId": "deleteAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "curl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"DELETE\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'DELETE',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Asset Not Available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422_asset_not_available" } } } } } } }, "/assets/{id}/live_streams": { "post": { "summary": "Restream an asset", "description": "This operation returns a live stream ID you can use to re-stream an uploaded asset.", "operationId": "restreamAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n\n -H \"Content-Type: application/json\" \\\n -X \"POST\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17/live_streams\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17/live_streams';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "live_stream" ], "properties": { "live_stream": { "$ref": "#/components/schemas/asset_restream" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "422": { "description": "Asset Not Available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422_asset_not_available" } } } } } } }, "/asset_tags": { "get": { "summary": "Fetch all asset tags", "description": "This operation retrieves a list of all of the tags that have been used previously by an organization.", "operationId": "asset_tags", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/asset_tags\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/asset_tags';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});" } ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset_tags" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } } } } }, "/assets/{id}/upload_completed": { "patch": { "summary": "Report asset as uploaded", "description": "This operation reports that an asset was successfully uploaded to storage.", "operationId": "reportUploadedAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n\n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17/upload_completed\" \\\n -d $'{\n \"asset\": {\n \"file_size\": \"1570024\",\n \"duration\": \"9241\"\n }\n}'\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17/upload_completed';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname',\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nconst req = https.request(options, function(res) {\n var body = '';\n res.on('data', function(data) {\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\nreq.write(JSON.stringify({\n \"asset\": {\n \"file_size\": 1570024,\n \"duration\": 9241\n }\n}));\nreq.end();\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset_report_uploaded_input" } } }, "description": "Provide the details of the asset to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "asset" ], "properties": { "asset": { "$ref": "#/components/schemas/asset_report_uploaded_output" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } } }, "/assets/{id}/upload_failed": { "patch": { "summary": "Report asset upload as failed", "description": "This operation reports that an asset uploaded to storage failed. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected.", "operationId": "reportUploadFailedAsset", "tags": [ "assets" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"PATCH\" \\\n \"${WV_HOST}/api/v1.11/assets/2adffc17/upload_failed\"" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/assets/2adffc17/upload_failed';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n method: 'PATCH',\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n // no data being returned, just: 204 NO CONTENT\n console.log(res.statusCode);\n}).on('error', function(e) {\n console.log(e.message);\n});" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the asset.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset_report_upload_failed_input" } } }, "description": "Provide the details of the asset to update in the body of the request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "asset" ], "properties": { "asset": { "$ref": "#/components/schemas/asset_report_upload_failed_output" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error422" } } } } } } }, "/recordings": { "get": { "summary": "Fetch all recordings", "description": "This operation shows limited details for all of your recordings. For detailed information, fetch a single recording.", "operationId": "listRecordings", "tags": [ "recordings" ], "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/recordings\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/recordings';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recordings" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } } } } }, "/recordings/{id}": { "get": { "summary": "Fetch a recording", "description": "This operation shows the details of a specific recording.", "operationId": "showRecording", "tags": [ "recordings" ], "x-codeSamples": [ { "lang": "Shell", "source": "// Using cURL\ncurl -H \"Authorization: Bearer ${WV_JWT}\" \\\n \n -H \"Content-Type: application/json\" \\\n -X \"GET\" \\\n \"${WV_HOST}/api/v1.11/recordings/2adffc17\"\n" }, { "lang": "JavaScript", "source": "// Using Node.js\nconst https = require('https');\nconst crypto = require('crypto');\nvar hostname = 'api.video.wowza.com'\nvar path = '/api/v1.11/recordings/2adffc17';\n//For security, never reveal API token in client-side code\nvar wvJWT = 'Bearer [your JWT]';\n\nconst options = {\n hostname: hostname,\n path: path,\n headers: {\n 'Authorization': wvJWT,\n 'Content-Type': 'application/json'\n }\n};\nhttps.get(options, function(res) {\n var body = '';\n res.on('data', function(data){\n body += data;\n });\n res.on('end', function() {\n console.log(JSON.parse(body));\n });\n}).on('error', function(e) {\n console.log(e.message);\n});\n" } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The unique alphanumeric string that identifies the recording.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "recording" ], "properties": { "recording": { "$ref": "#/components/schemas/recording" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error401" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error404" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error410" } } } } } }, "delete": { "summary": "Delete a recording", "description": "This operation deletes a recording.
\"enabled\": true",
"example": ""
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"description\": \"My Hosted Page Description\"",
"example": ""
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.\n\n**Example:** \"sharing_icons\": false",
"example": ""
},
"title": {
"type": "string",
"description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"title\": \"My Hosted Page\"",
"example": ""
}
}
},
"player_request_object_create": {
"type": "object",
"description": "Configuration of the player.\nIf you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "properties": { "customizations": { "type": "object", "description": "Configuration of the player customizations.", "properties": { "play_icon": { "type": "string", "description": "A play icon that is displayed on the video preview. The default, **solid**, uses the standard play (solid triangle) icon. **outlined** uses an alternate (outlined triangle) play icon. **ring** uses an alternate (small solid triangle enclosed in a circle) play icon.\n\nDefault: **solid**\n\n**Example:**
\"play_icon\": \"solid\"",
"example": "solid",
"enum": [
"solid",
"outlined",
"ring"
]
},
"thin_timeline": {
"type": "boolean",
"description": "If **true**, displays a thinner control bar than the default in the video. The default is **false**.\n\n**Example:** \"thin_timeline\": false",
"example": ""
},
"drag_handle": {
"type": "boolean",
"description": "If **true**, displays a drag handle on the progress bar. The default is **false**.\n\n**Example:** \"drag_handle\": false",
"example": ""
},
"volume": {
"type": "boolean",
"description": "If **true**, displays a volume button on the video. The default is **true**.\n\n**Example:** \"volume\": true",
"example": ""
},
"mute": {
"type": "boolean",
"description": "If **true**, displays a mute button on the video. The default is **true**.\n\n**Example:** \"mute\": true",
"example": ""
},
"fullscreen": {
"type": "boolean",
"description": "If **true**, displays a fullscreen button on the video. The default is **true**.\n\n**Example:** \"fullscreen\": true",
"example": ""
},
"show_player_title": {
"type": "boolean",
"description": "If **true**, displays a preview title on the video. The default is **false**.\n\n**Example:** \"show_player_title\": false",
"example": ""
},
"color": {
"type": "string",
"description": "The color of the timeline and volume bar of the player. You can set the color of your choice by passing a hex code for that specific color.\n\n**Example:** \"color\": \"4d4d4d\"",
"example": ""
}
}
},
"countdown": {
"type": "boolean",
"description": "A clock that appears in the player before the event and counts down to the start of the stream. Specify **true** to display the countdown clock. The default is **false**.\n\n**Example:** \"countdown\": false",
"example": ""
},
"countdown_at": {
"type": "string",
"description": "The date and time that the event starts, used by the countdown clock. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC.\n\n**Example:** \"countdown_at\": \"2020-02-01T17:00:00.000Z\"",
"example": ""
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\" ",
"example": ""
},
"logo_position": {
"type": "string",
"description": "The corner of the player in which you want the player logo to appear. The default is **top-left**.\n\n**Example:** \"logo_position\": \"top-right\"",
"example": "",
"enum": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
]
},
"plugins": {
"type": "object",
"description": "Configuration of the plugins.",
"properties": {
"airplay": {
"type": "boolean",
"description": "If **true**, enables Airplay functionality in the player which allows you to cast to an Airplay device. The default is **false**.\n\n**Example:** \"airplay\": false",
"example": ""
},
"chromecast": {
"type": "boolean",
"description": "If **true**, enables Chromecast functionality in the player which allows you to cast to a Chromecast device. The default is **false**.\n\n**Example:** \"chromecast\": false",
"example": ""
}
}
},
"responsive": {
"type": "boolean",
"description": "A player whose size adjusts according to the device on which it's being viewed. If **true**, creates a responsive player. If **false**, specify a *player_width*.\n\n\n **Example:** \"type\": false",
"example": ""
},
"type": {
"type": "string",
"description": "The player you want to use.\n\n**Wowza Video subscribers** Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.\n\n**Example:** \"type\": \"wowza_flowplayer\"",
"example": ""
},
"video_poster_image": {
"type": "string",
"description": "The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.\n\n**Example:** \"video_poster_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": ""
},
"width": {
"type": "integer",
"description": "The width, in pixels, of a fixed-size player. The default is **640**.\n\n**Example:** \"width\": 640",
"example": "",
"format": "int32"
}
}
},
"live_stream_create_input": {
"type": "object",
"description": "",
"required": [
"live_stream"
],
"properties": {
"live_stream": {
"type": "object",
"title": "live_stream",
"description": "",
"required": [
"name",
"transcoder_type",
"billing_mode",
"broadcast_location",
"encoder",
"aspect_ratio_width",
"aspect_ratio_height"
],
"properties": {
"aspect_ratio_height": {
"type": "integer",
"description": "The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_width**, makes up the input resolution.",
"example": 1080,
"format": "int32"
},
"aspect_ratio_width": {
"type": "integer",
"description": "The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_height**, makes up the input resolution.",
"example": 1920,
"format": "int32"
},
"billing_mode": {
"type": "string",
"description": "The billing mode for the stream. The default is **pay_as_you_go**.\n\n\n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n\n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.",
"example": "pay_as_you_go",
"enum": [
"pay_as_you_go",
"twentyfour_seven"
]
},
"broadcast_location": {
"$ref": "#/components/schemas/broadcast_location"
},
"encoder": {
"type": "string",
"description": "The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose **ipcamera**, **other_rtmp**, or **other_rtsp**.",
"example": "other_webrtc",
"enum": [
"wowza_clearcaster",
"wowza_gocoder",
"wowza_streaming_engine",
"media_ds",
"axis",
"epiphan",
"file",
"hauppauge",
"jvc",
"live_u",
"matrox",
"newtek_tricaster",
"osprey",
"sony",
"telestream_wirecast",
"teradek_cube",
"vmix",
"x_split",
"ipcamera",
"other_rtmp",
"other_rtsp",
"other_webrtc",
"other_udp",
"other_srt"
]
},
"name": {
"type": "string",
"description": "A descriptive name for the live stream. Maximum 200 characters.",
"example": "My Live Stream"
},
"transcoder_type": {
"type": "string",
"description": "The type of transcoder, either **transcoded** for streams that are transcoded into adaptive bitrate renditions or **passthrough** for streams that aren't processed by the transcoder. The default is **transcoded**.",
"example": "transcoded",
"enum": [
"transcoded",
"passthrough"
]
},
"closed_caption_type": {
"type": "string",
"description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.\n\n**Example:** \"closed_caption_type\": \"none\"",
"example": "none",
"enum": [
"none",
"cea",
"on_text",
"both"
]
},
"delivery_method": {
"type": "string",
"description": "The type of connection between the video source and the transcoder. The default, **push**, instructs the source to push the stream to the transcoder. **pull** instructs the transcoder to pull the video from the source. **cdn** uses a stream source to deliver the stream to the transcoder.\n\nDefault: **push**\n\n**Example:** \"delivery_method\": \"pull\"",
"example": "push",
"enum": [
"pull",
"cdn",
"push"
]
},
"delivery_protocols": {
"type": "array",
"description": "An array of direct delivery protocols enabled for this live stream. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are enabled.\n\n**Example:** See response body sample",
"items": {
"type": "string"
}
},
"disable_authentication": {
"type": "boolean",
"description": "Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Video. Specify **true** to disable authentication with the video source.\n\n**Example:** \"disable_authentication\": false",
"example": false
},
"hosted_page": {
"$ref": "#/components/schemas/hosted_page_request_object_create"
},
"low_latency": {
"type": "boolean",
"description": "For streams whose *target_delivery_protocol* is **hls-https**. If **true**, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is **false**.\n\n\n **Example:** \"low_latency\": false",
"example": false
},
"password": {
"type": "string",
"description": "A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"password\": 68332313",
"example": "68332313"
},
"player": {
"$ref": "#/components/schemas/player_request_object_create"
},
"recording": {
"type": "boolean",
"description": "If **true**, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.\n\nRecordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.\n\nDefault: **false**\n\n> **Note**: If **save_asset** is **true**, that field overrides a true **recording** value and the asset is saved in Asset Management.\n\n**Example:** \"recording\": true",
"example": true
},
"reference_id": {
"type": "string",
"description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.\n\n**Example:** \"reference_id\": \"mySystemID_01\"",
"example": "mySystemID_01"
},
"save_asset": {
"type": "boolean",
"description": "If **true**, saves an MP4 recording and a VOD asset in Asset Management. The default is **false**. You can't set **save_asset** for a live stream created from re-streaming an asset in Asset Management.\n> **Note**: If this value is true, **recording** and/or **vod_stream** are set to false. You need a Wowza Video subscription to access Asset Management.\n\nAvailable from version 1.8.\n\n**Example:** \"save_asset\": true",
"example": true
},
"source_url": {
"type": "string",
"description": "For the *delivery_method* **pull** or *encoder* **file**.\n\nFor **pull**, enter the URL of an IP camera or video encoder using an RTMP and RTSP pull connection to Wowza Video. Consult the camera or encoder documentation for the URL syntax.\n\nFor **file**, enter the source file URL, including the protocol (http, https, gs, s3).\n\n\n**Example:** \"source_url\": \"xyz.streamlock.net/vod/mp4:Movie.mov\"",
"example": "xyz.streamlock.net/vod/mp4:Movie.mov"
},
"target_delivery_protocol": {
"type": "string",
"description": "The type of stream being delivered from Wowza Video. The default and only valid value is **hls-https**. \n\n**Example:** \"target_delivery_protocol\": \"hls-https\"",
"example": "hls-https",
"enum": [
"hls-https"
]
},
"use_stream_source": {
"type": "boolean",
"description": "If **true**, uses a stream source to deliver the stream to Wowza Video. The default, **false**, pushes directly to Wowza Video.\n\n**Example:** \"use_stream_source\": false",
"example": false
},
"username": {
"type": "string",
"description": "A user name for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"username\": \"client2\"",
"example": "client2"
},
"vod_stream": {
"type": "boolean",
"description": "If **true**, creates a VOD stream after the live stream ends. The default is **false**. VOD streams require a Fastly stream target with HLS as a delivery protocol.\n> **Note**: If **save_asset** is **true**, that field overrides a true **vod_stream** value and the asset is saved in Asset Management.\n\n**Example:** \"vod_stream\": true",
"example": true
}
}
}
},
"example": {
"live_stream": {
"aspect_ratio_height": 720,
"aspect_ratio_width": 1280,
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_west_oregon",
"encoder": "other_webrtc",
"name": "My Live Stream",
"transcoder_type": "transcoded"
}
}
},
"hosted_page_response_object": {
"type": "object",
"description": "Configuration of the hosted page.",
"properties": {
"enabled": {
"type": "boolean",
"description": "A web page hosted by Wowza Video that includes a player for the live stream. The default, **true**, creates a hosted page. Specify **false** to not create a hosted web page.",
"example": ""
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.",
"example": ""
},
"logo_image_url": {
"type": "string",
"description": "The path to a GIF, JPEG, or PNG logo file that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller."
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.",
"example": ""
},
"title": {
"type": "string",
"description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.",
"example": ""
},
"url": {
"type": "string",
"description": "The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.",
"example": ""
}
}
},
"player_response_object": {
"type": "object",
"description": "Configuration of the player.\nIf you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "properties": { "customizations": { "type": "object", "description": "Configuration of the player customizations.", "properties": { "play_icon": { "type": "string", "description": "A play icon that appears on the video preview. The default, **solid**, uses the standard play (solid triangle) icon. **outlined** uses an alternate (outlined triangle) play icon. **ring** uses an alternate (small solid triangle enclosed in a circle) play icon.", "example": "", "enum": [ "solid", "outlined", "ring" ] }, "thin_timeline": { "type": "boolean", "description": "A control bar that appears on the video. Specify **true** to display the control bar on the video. The default is **false**.", "example": "" }, "drag_handle": { "type": "boolean", "description": "A drag handle that you can use to drag the progress of the video on the timeline. Specify **true** to display the drag handle. The default is **false**.", "example": "" }, "volume": { "type": "boolean", "description": "A volume button that appears on the video. Specify **true** to display the volume button. The default is **true**.", "example": "" }, "mute": { "type": "boolean", "description": "A mute button that appears on the video. Specify **true** to display the mute button. The default is **true**.", "example": "" }, "fullscreen": { "type": "boolean", "description": "A fullscreen button that appears on the video. Specify **true** to display the fullscreen button. The default is **true**.", "example": "" }, "show_player_title": { "type": "boolean", "description": "The player title that appears on the video. Specify **true** to display the player title. The default is **false**.", "example": "" }, "color": { "type": "string", "description": "The color of the timeline and volume bar of the player. You can set the color of your choice by passing a hex code for that specific color. ", "example": "" } } }, "countdown": { "type": "boolean", "description": "A clock that appears in the player before the event and counts down to the start of the stream. Specify **true** to display the countdown clock. The default is **false**.", "example": "" }, "countdown_at": { "type": "string", "description": "The date and time that the event starts, used by the countdown clock. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC.", "example": "" }, "embed_code": { "type": "string", "description": "The HTML code that can be used in an external webpage to host the Wowza Flowplayer.", "example": "" }, "hls_playback_url": { "type": "string", "description": "The address that can be used to configure playback of the stream using the HLS protocol.", "example": "" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the player.", "example": "" }, "logo_image_url": { "type": "string", "description": "The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.", "example": "" }, "logo_position": { "type": "string", "description": "The corner of the player in which you want the player logo to appear. The default is **top-left**.", "example": "", "enum": [ "top-left", "top-right", "bottom-left", "bottom-right" ] }, "plugins": { "type": "object", "description": "Configuration of the plugins.", "properties": { "airplay": { "type": "boolean", "description": "If **true**, enables Airplay functionality in the player which allows you to cast to an Airplay device. The default is **false**.", "example": "" }, "chromecast": { "type": "boolean", "description": "If **true**, enables Chromecast functionality in the player which allows you to cast to a Chromecast device. The default is **false**.", "example": "" } } }, "responsive": { "type": "boolean", "description": "A player whose size adjusts according to the device on which it's being viewed. If **true**, creates a responsive player. If **false**, specify a *player_width*.", "example": "" }, "type": { "type": "string", "description": "The player you want to use.\n\n**Wowza Video subscribers** Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.", "example": "" }, "video_poster_image_url": { "type": "string", "description": "The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.", "example": "" }, "width": { "type": "integer", "description": "The width, in pixels, of a fixed-size player. The default is **640**.", "example": "", "format": "int32" } } }, "live_stream": { "type": "object", "description": "", "properties": { "aspect_ratio_height": { "type": "integer", "description": "The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_width**, makes up the input resolution.", "example": "", "format": "int32" }, "aspect_ratio_width": { "type": "integer", "description": "The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_height**, makes up the input resolution.", "example": "", "format": "int32" }, "asset_id": { "type": "string", "description": "Only applies to live streams created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management." }, "billing_mode": { "type": "string", "description": "\nThe billing mode for the stream. The default is **pay_as_you_go**.\n\n\n \n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n \n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.", "example": "", "enum": [ "pay_as_you_go", "twentyfour_seven" ] }, "broadcast_location": { "$ref": "#/components/schemas/broadcast_location" }, "closed_caption_type": { "type": "string", "description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.", "example": "", "enum": [ "none", "cea", "on_text", "both" ] }, "connection_code": { "type": "string", "description": "A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created.", "example": "" }, "connection_code_expires_at": { "type": "string", "description": "The date and time that the *connection_code* expires.", "example": "", "format": "date-time" }, "created_at": { "type": "string", "description": "The date and time that the live stream was created.", "example": "", "format": "date-time" }, "delivery_method": { "type": "string", "description": "The type of connection between the video source and the transcoder. The default, **push**, instructs the source to push the stream to the transcoder. **pull** instructs the transcoder to pull the video from the source. **cdn** uses a stream source to deliver the stream to the transcoder.", "example": "", "enum": [ "pull", "cdn", "push" ] }, "delivery_protocols": { "type": "array", "description": "An array of direct delivery protocols enabled for this live stream. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are enabled.", "items": { "type": "string" } }, "direct_playback_urls": { "type": "object", "description": "A list of direct playback URLs for the live stream's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.", "properties": { "delivery_protocol": { "type": "array", "description": "The name of the direct playback protocol.", "items": { "type": "object", "title": "direct_playback_url", "properties": { "name": { "type": "string", "description": "The name of the playback URL: **source**, **default**,\n or the output rendition's resolution.", "example": "" }, "output_id": { "type": "string", "description": "Only for output rendition-based playback URLs, not source playback URLs. The unique alphanumeric string that identifies the output rendition.", "example": "dcxq5q6c" }, "url": { "type": "string", "description": "The playback URL for the source or output rendition.", "example": "https://abcdef.dev.entrypoint.video.wowza.com/app-B8P6K226/ngrp:43a23e5a_all/playlist.m3u8" }, "application_name": { "type": "string", "description": "(WebRTC only) The application name for the WebRTC output.", "example": "" }, "stream_name": { "type": "string", "description": "(WebRTC only) The stream name for the WebRTC output rendition.", "example": "" } } } } } }, "encoder": { "type": "string", "description": "The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose **ipcamera**, **other_rtmp**, or **other_rtsp**.", "example": "", "enum": [ "wowza_clearcaster", "wowza_gocoder", "wowza_streaming_engine", "media_ds", "axis", "epiphan", "file", "hauppauge", "jvc", "live_u", "matrox", "newtek_tricaster", "osprey", "sony", "telestream_wirecast", "teradek_cube", "vmix", "x_split", "ipcamera", "other_rtmp", "other_rtsp", "other_webrtc", "other_udp", "other_srt" ] }, "hosted_page": { "$ref": "#/components/schemas/hosted_page_response_object" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the live stream.", "example": "" }, "low_latency": { "type": "boolean", "description": "For streams whose *target_delivery_protocol* is **hls-https**. If **true**, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is **false**.", "example": "" }, "name": { "type": "string", "description": "A descriptive name for the live stream. Maximum 200 characters.", "example": "" }, "playback_stream_name": { "type": "string", "description": "The stream name used in the direct playback URL.", "example": "" }, "player": { "$ref": "#/components/schemas/player_response_object" }, "recording": { "type": "boolean", "description": "If **true**, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.\n\nRecordings created from a live stream capture up to eight hours of content.\nIf a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.\n\nDefault: **false**.\n\n> **Note**: If **save_asset** is **true**, that field overrides a true **recording** value and the asset is saved in Asset Management.", "example": "" }, "reference_id": { "type": "string", "description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.", "example": "" }, "save_asset": { "type": "boolean", "description": "If **true**, saves an MP4 recording and a VOD asset in Asset Management. The default is **false**. You can't set **save_asset** for a live stream created from re-streaming an asset in Asset Management.\n> **Note**: If this value is true, **recording** and/or **vod_stream** are set to false. You need a Wowza Video subscription to access Asset Management.\n\nAvailable from version 1.8." }, "source_connection_information": { "type": "object", "description": "Details that you can use to manually configure and connect a video source to the live stream.", "example": "" }, "stream_source_id": { "type": "string", "description": "The unique alphanumeric string that identifies the stream source, if a stream source is used.", "example": "" }, "stream_targets": { "type": "array", "description": "An array of unique alphanumeric strings that identify the stream targets used by the live stream.", "items": { "type": "object", "title": "stream_targets", "properties": { "id": { "type": "string", "description": "The unique alphanumeric string that identifies the stream target.", "example": "dcxq5q6c" } } } }, "target_delivery_protocol": { "type": "string", "description": "The type of stream being delivered from Wowza Video. The default and only valid value is **hls-https**.", "example": "", "enum": [ "hls-https" ] }, "transcoder_type": { "type": "string", "description": "The type of transcoder, either **transcoded** for streams that are transcoded into adaptive bitrate renditions or **passthrough** for streams that aren't processed by the transcoder. The default is **transcoded**.", "example": "", "enum": [ "transcoded", "passthrough" ] }, "updated_at": { "type": "string", "description": "The date and time that the live stream was updated.", "example": "", "format": "date-time" }, "use_stream_source": { "type": "boolean", "description": "If **true**, uses a stream source to deliver the stream to Wowza Video. The default, **false**, pushes directly to Wowza Video.", "example": "" }, "vod_stream": { "type": "boolean", "description": "If **true**, creates a VOD stream after the live stream ends. The default is **false**. VOD streams require a Fastly stream target with HLS as a delivery protocol.\n> **Note**: If **save_asset** is **true**, that field overrides a true **vod_stream** value and the asset is saved in Asset Management.", "example": "" } }, "example": { "aspect_ratio_height": 1080, "aspect_ratio_width": 1920, "billing_mode": "pay_as_you_go", "broadcast_location": "us_west_california", "closed_caption_type": "cea", "connection_code": "0e15cb", "connection_code_expires_at": "2020-11-30T17:16:21.956Z", "created_at": "2020-01-29T17:16:21.956Z", "delivery_method": "push", "delivery_protocols": [ "rtmp", "rtsp", "wowz", "webrtc" ], "direct_playback_urls": { "rtmp": [ { "name": "source", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789" }, { "name": "webrtc", "output_id": "dcxq5q6c", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1" }, { "name": "V:1280x720+A:128K", "output_id": "0g116zkf", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2" }, { "name": "V:854x480+A:128K", "output_id": "4qqkwndt", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3" }, { "name": "V:640x360+A:128K", "output_id": "0pv8djpg", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4" }, { "name": "V:512x288+A:128K", "output_id": "b09xrxjf", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5" }, { "name": "V:320x180+A:128K", "output_id": "bvkh2nsz", "url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6" } ], "rtsp": [ { "name": "source", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789" }, { "name": "webrtc", "output_id": "dcxq5q6c", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1" }, { "name": "V:1280x720+A:128K", "output_id": "0g116zkf", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2" }, { "name": "V:854x480+A:128K", "output_id": "4qqkwndt", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3" }, { "name": "V:640x360+A:128K", "output_id": "0pv8djpg", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4" }, { "name": "V:512x288+A:128K", "output_id": "b09xrxjf", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5" }, { "name": "V:320x180+A:128K", "output_id": "bvkh2nsz", "url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6" } ], "wowz": [ { "name": "source", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789" }, { "name": "webrtc", "output_id": "dcxq5q6c", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1" }, { "name": "V:1280x720+A:128K", "output_id": "0g116zkf", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2" }, { "name": "V:854x480+A:128K", "output_id": "4qqkwndt", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3" }, { "name": "V:640x360+A:128K", "output_id": "0pv8djpg", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4" }, { "name": "V:512x288+A:128K", "output_id": "b09xrxjf", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5" }, { "name": "V:320x180+A:128K", "output_id": "bvkh2nsz", "url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6" } ], "webrtc": [ { "name": "source", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead" }, { "name": "webrtc", "output_id": "dcxq5q6c", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream1" }, { "name": "V:1280x720+A:128K", "output_id": "0g116zkf", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream2" }, { "name": "V:854x480+A:128K", "output_id": "4qqkwndt", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream3" }, { "name": "V:640x360+A:128K", "output_id": "0pv8djpg", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream4" }, { "name": "V:512x288+A:128K", "output_id": "b09xrxjf", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream5" }, { "name": "V:320x180+A:128K", "output_id": "bvkh2nsz", "url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json", "application_name": "app-B8P6K226", "stream_name": "1722aead_stream6" } ] }, "encoder": "other_rtmp", "hosted_page": { "enabled": true, "description": "My Hosted Page Description", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg", "sharing_icons": true, "title": "My Hosted Page", "url": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html" }, "id": "wdjfqvsv", "name": "My PAYG Transcoded WSE Live Stream", "playback_stream_name": "wxyz6789", "player": { "customizations": { "play_icon": "solid", "thin_timeline": false, "drag_handle": false, "volume": true, "mute": true, "fullscreen": true, "show_player_title": false, "color": "4d4d4d" }, "countdown": true, "countdown_at": "2020-02-01T17:00:00.000Z", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "id": "kwb6pwnv", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "plugins": { "airplay": false, "chromecast": false }, "responsive": false, "type": "wowza_flowplayer", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640 }, "recording": true, "reference_id": "mySystemID_01", "save_asset": false, "stream_source_id": "5skrfpyf", "stream_targets": [ { "id": "klbmg2h8" }, { "id": "bnjtdmmc" } ], "target_delivery_protocol": "hls-https", "transcoder_type": "transcoded", "updated_at": "2020-01-31T06:12:39.956Z", "use_stream_source": true, "vod_stream": true } }, "Error422": { "type": "object", "description": "", "required": [ "meta" ], "properties": { "meta": { "type": "object", "title": "meta", "description": "", "properties": { "status": { "type": "integer", "description": "", "example": "", "format": "int32" }, "code": { "type": "string", "description": "", "example": "" }, "title": { "type": "string", "description": "", "example": "" }, "message": { "type": "string", "description": "", "example": "" }, "description": { "type": "string", "description": "", "example": "" }, "links": { "type": "array", "description": "", "example": "", "items": {} } } } }, "example": { "Example Response 1": { "meta": { "status": 422, "code": "ERR-422-RecordInvalid", "title": "Record Invalid Error", "message": "The request couldn't be processed. ... can't be blank", "description": "", "links": [] } }, "Example Response 2": { "meta": { "status": 422, "code": "ERR-422-RecordInvalid", "title": "Record Invalid Error", "message": "The request couldn't be processed. Provider wowza_video is not allowed", "description": "", "links": [] } } } }, "Error403": { "type": "object", "description": "", "required": [ "meta" ], "properties": { "meta": { "type": "object", "title": "meta", "description": "", "properties": { "status": { "type": "integer", "description": "", "example": "", "format": "int32" }, "code": { "type": "string", "description": "", "example": "" }, "title": { "type": "string", "description": "", "example": "" }, "message": { "type": "string", "description": "", "example": "" }, "description": { "type": "string", "description": "", "example": "" }, "links": { "type": "array", "description": "", "example": "", "items": {} } } } }, "example": { "Example Response 1": { "meta": { "status": 403, "code": "ERR-403-RecordUnaccessible", "title": "Record Unaccessible Error", "message": "The requested resource isn't accessible.", "description": "", "links": [] } } } }, "Error404": { "type": "object", "description": "", "required": [ "meta" ], "properties": { "meta": { "type": "object", "title": "meta", "description": "", "properties": { "status": { "type": "integer", "description": "", "example": "", "format": "int32" }, "code": { "type": "string", "description": "", "example": "" }, "title": { "type": "string", "description": "", "example": "" }, "message": { "type": "string", "description": "", "example": "" }, "description": { "type": "string", "description": "", "example": "" }, "links": { "type": "array", "description": "", "example": "", "items": {} } } } }, "example": { "Example Response 1": { "meta": { "status": 404, "code": "ERR-404-RecordNotFound", "title": "Record Not Found Error", "message": "The requested resource couldn't be found.", "description": "", "links": [] } } } }, "Error410": { "type": "object", "description": "", "required": [ "meta" ], "properties": { "meta": { "type": "object", "title": "meta", "description": "", "properties": { "status": { "type": "integer", "description": "", "example": "", "format": "int32" }, "code": { "type": "string", "description": "", "example": "" }, "title": { "type": "string", "description": "", "example": "" }, "message": { "type": "string", "description": "", "example": "" }, "description": { "type": "string", "description": "", "example": "" }, "links": { "type": "array", "description": "", "example": "", "items": {} } } } }, "example": { "Example Response 1": { "meta": { "status": 410, "code": "ERR-410-RecordDeleted", "title": "Record Deleted Error", "message": "The requested resource has been deleted.", "description": "", "links": [] } } } }, "hosted_page_request_object": { "type": "object", "description": "Configuration of the hosted page.", "properties": { "enabled": { "type": "boolean", "description": "A web page hosted by Wowza Video that includes a player for the live stream. The default, **true**, creates a hosted page. Specify **false** to not create a hosted web page.\n\n**Example:**
\"enabled\": true",
"example": ""
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"description\": \"My Hosted Page Description\"",
"example": ""
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
},
"remove_logo_image": {
"type": "boolean",
"description": "If **true**, removes the logo file from the hosted page. The default is **false**.\n\n**Example:** \"remove_logo_image\": true",
"example": true
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.\n\n**Example:** \"sharing_icons\": false",
"example": ""
},
"title": {
"type": "string",
"description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"title\": \"My Hosted Page\"",
"example": ""
}
}
},
"player_request_object": {
"type": "object",
"description": "Configuration of the player.\nIf you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "properties": { "customizations": { "type": "object", "description": "Configuration of the player customizations.", "properties": { "play_icon": { "type": "string", "description": "A play icon that is displayed on the video preview. The default, **solid**, uses the standard play (solid triangle) icon. **outlined** uses an alternate (outlined triangle) play icon. **ring** uses an alternate (small solid triangle enclosed in a circle) play icon.\n\nDefault: **solid**\n\n**Example:**
\"play_icon\": \"solid\"",
"example": "solid",
"enum": [
"solid",
"outlined",
"ring"
]
},
"thin_timeline": {
"type": "boolean",
"description": "If **true**, displays a thinner control bar than the default in the video. The default is **false**.\n\n**Example:** \"thin_timeline\": false",
"example": ""
},
"drag_handle": {
"type": "boolean",
"description": "If **true**, displays a drag handle on the progress bar. The default is **false**.\n\n**Example:** \"drag_handle\": false",
"example": ""
},
"volume": {
"type": "boolean",
"description": "If **true**, displays a volume button on the video. The default is **true**.\n\n**Example:** \"volume\": true",
"example": ""
},
"mute": {
"type": "boolean",
"description": "If **true**, displays a mute button on the video. The default is **true**.\n\n**Example:** \"mute\": true",
"example": ""
},
"fullscreen": {
"type": "boolean",
"description": "If **true**, displays a fullscreen button on the video. The default is **true**.\n\n**Example:** \"fullscreen\": true",
"example": ""
},
"show_player_title": {
"type": "boolean",
"description": "If **true**, displays a preview title on the video. The default is **false**.\n\n**Example:** \"show_player_title\": false",
"example": ""
},
"color": {
"type": "string",
"description": "The color of the timeline and volume bar of the player. You can set the color of your choice by passing a hex code for that specific color.\n\n**Example:** \"color\": \"4d4d4d\"",
"example": ""
}
}
},
"countdown": {
"type": "boolean",
"description": "A clock that appears in the player before the event and counts down to the start of the stream. Specify **true** to display the countdown clock. The default is **false**.\n\n**Example:** \"countdown\": false",
"example": ""
},
"countdown_at": {
"type": "string",
"description": "The date and time that the event starts, used by the countdown clock. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC.\n\n**Example:** \"countdown_at\": \"2020-02-01T17:00:00.000Z\"",
"example": ""
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\" ",
"example": ""
},
"logo_position": {
"type": "string",
"description": "The corner of the player in which you want the player logo to appear. The default is **top-left**.\n\n**Example:** \"logo_position\": \"top-right\"",
"example": "",
"enum": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
]
},
"plugins": {
"type": "object",
"description": "Configuration of the plugins.",
"properties": {
"airplay": {
"type": "boolean",
"description": "If **true**, enables Airplay functionality in the player which allows you to cast to an Airplay device. The default is **false**.\n\n**Example:** \"airplay\": false",
"example": ""
},
"chromecast": {
"type": "boolean",
"description": "If **true**, enables Chromecast functionality in the player which allows you to cast to a Chromecast device. The default is **false**.\n\n**Example:** \"chromecast\": false",
"example": ""
}
}
},
"remove_logo_image": {
"type": "boolean",
"description": "If **true**, removes the logo file from the player. The default is **false**.\n\n**Example:** \"remove_logo_image\": true",
"example": true
},
"remove_video_poster_image": {
"type": "boolean",
"description": "If **true**, removes the poster image. The default is **false**.\n\n**Example:** \"remove_video_poster_image\": true",
"example": true
},
"responsive": {
"type": "boolean",
"description": "A player whose size adjusts according to the device on which it's being viewed. If **true**, creates a responsive player. If **false**, specify a *player_width*.\n\n\n **Example:** \"type\": false",
"example": ""
},
"type": {
"type": "string",
"description": "The player you want to use.\n\n**Wowza Video subscribers** Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.\n\n**Example:** \"type\": \"wowza_flowplayer\"",
"example": ""
},
"video_poster_image": {
"type": "string",
"description": "The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.\n\n**Example:** \"video_poster_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": ""
},
"width": {
"type": "integer",
"description": "The width, in pixels, of a fixed-size player. The default is **640**.\n\n**Example:** \"width\": 640",
"example": "",
"format": "int32"
}
}
},
"live_stream_update_input": {
"type": "object",
"description": "",
"required": [
"live_stream"
],
"properties": {
"live_stream": {
"type": "object",
"title": "live_stream",
"description": "",
"properties": {
"aspect_ratio_height": {
"type": "integer",
"description": "The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_width**, makes up the input resolution.\n\n**Example:** \"aspect_ratio_height\": 1080",
"example": 1080,
"format": "int32"
},
"aspect_ratio_width": {
"type": "integer",
"description": "The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with **aspect_ratio_height**, makes up the input resolution.\n\n**Example:** \"aspect_ratio_width\": 1920",
"example": 1920,
"format": "int32"
},
"encoder": {
"type": "string",
"description": "The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose **ipcamera**, **other_rtmp**, or **other_rtsp**.\n\n**Example:** \"encoder\": \"other_rtmp\"",
"example": "other_rtmp",
"enum": [
"wowza_clearcaster",
"wowza_gocoder",
"wowza_streaming_engine",
"media_ds",
"axis",
"epiphan",
"file",
"hauppauge",
"jvc",
"live_u",
"matrox",
"newtek_tricaster",
"osprey",
"sony",
"telestream_wirecast",
"teradek_cube",
"vmix",
"x_split",
"ipcamera",
"other_rtmp",
"other_rtsp",
"other_webrtc",
"other_udp",
"other_srt"
]
},
"name": {
"type": "string",
"description": "A descriptive name for the live stream. Maximum 200 characters.\n\n**Example:** \"name\": \"My Updated Live Stream\"",
"example": "My Live Stream"
},
"closed_caption_type": {
"type": "string",
"description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.\n\n**Example:** \"closed_caption_type\": \"cea\"",
"example": "cea",
"enum": [
"none",
"cea",
"on_text",
"both"
]
},
"delivery_method": {
"type": "string",
"description": "The type of connection between the video source and the transcoder. The default, **push**, instructs the source to push the stream to the transcoder. **pull** instructs the transcoder to pull the video from the source. **cdn** uses a stream source to deliver the stream to the transcoder.\n\n**Example:** \"delivery_method\": \"pull\"",
"example": "push",
"enum": [
"pull",
"cdn",
"push"
]
},
"delivery_protocols": {
"type": "array",
"description": "An array of direct delivery protocols enabled for this live stream. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are enabled.\n\n**Example:** See response body sample",
"items": {
"type": "string"
}
},
"disable_authentication": {
"type": "boolean",
"description": "Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Video. Specify **true** to disable authentication with the video source.\n\n**Example:** \"disable_authentication\": false",
"example": false
},
"hosted_page": {
"$ref": "#/components/schemas/hosted_page_request_object"
},
"password": {
"type": "string",
"description": "A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"password\": 68332313",
"example": "68332313"
},
"player": {
"$ref": "#/components/schemas/player_request_object"
},
"recording": {
"type": "boolean",
"description": "If **true**, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.\n\nRecordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.\n\nDefault: **false**\n\n> **Note**: If **save_asset** is **true**, that field overrides a true **recording** value and the asset is saved in Asset Management.\n\n**Example:** \"recording\": true",
"example": true
},
"reference_id": {
"type": "string",
"description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.\n\n**Example:** \"reference_id\": \"mySystemID_01\"",
"example": "mySystemID_01"
},
"save_asset": {
"type": "boolean",
"description": "If **true**, saves an MP4 recording and a VOD asset in Asset Management. The default is **false**. You can't set **save_asset** for a live stream created from re-streaming an asset in Asset Management\n> **Note**: If this value is true, **recording** and/or **vod_stream** are set to false. You need a Wowza Video subscription to access Asset Management.\n\nAvailable from version 1.8.\n\n**Example:** \"save_asset\": true"
},
"source_url": {
"type": "string",
"description": "For the *delivery_method* **pull** or *encoder* **file**.\n\nFor **pull**, enter the URL of an IP camera or video encoder using an RTMP and RTSP pull connection to Wowza Video. Consult the camera or encoder documentation for the URL syntax.\n\nFor **file**, enter the source file URL, including the protocol (http, https, gs, s3).\n\n\n**Example:** \"source_url\": \"xyz.streamlock.net/vod/mp4:Movie.mov\"",
"example": "xyz.streamlock.net/vod/mp4:Movie.mov"
},
"target_delivery_protocol": {
"type": "string",
"description": "The type of stream being delivered from Wowza Video. The default and only valid value is **hls-https**.\n\n**Example:** \"target_delivery_protocol\": \"hls-https\"",
"example": "hls-https",
"enum": [
"hls-https"
]
},
"use_stream_source": {
"type": "boolean",
"description": "If **true**, uses a stream source to deliver the stream to Wowza Video. The default, **false**, pushes directly to Wowza Video.\n\n**Example:** \"use_stream_source\": false",
"example": false
},
"username": {
"type": "string",
"description": "A user name for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"username\": \"client2\"",
"example": "client2"
},
"vod_stream": {
"type": "boolean",
"description": "If **true**, creates a VOD stream after the live stream ends. The default is **false**.VOD streams require a Fastly stream target with HLS as a delivery protocol.\n> **Note**: If **save_asset** is **true**, that field overrides a true **vod_stream** value and the asset is saved in Asset Management.\n\n**Example:** \"vod_stream\": true",
"example": true
}
}
}
},
"example": {
"live_stream": {
"name": "My Updated Live Stream",
"recording": true
}
}
},
"audio_codec_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": ""
},
"value": {
"type": "string",
"description": "The value of the associated key.",
"example": "aac"
}
}
},
"bits_in_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "Kbps"
},
"value": {
"type": "number",
"description": "The value of the associated key.",
"example": 317.3,
"format": "float"
}
}
},
"bits_out_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "Kbps"
},
"value": {
"type": "number",
"description": "The value of the associated key.",
"example": 856,
"format": "float"
}
}
},
"bytes_in_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "KBps"
},
"value": {
"type": "number",
"description": "The value of the associated key.",
"example": 317.3,
"format": "float"
}
}
},
"bytes_out_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "KBps"
},
"value": {
"type": "number",
"description": "The value of the associated key.",
"example": 856,
"format": "float"
}
}
},
"configured_bytes_out_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "warning"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": "Outbound bitrate is lower than the configured bitrate. There might be a problem with the stream targets."
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "Kbps"
},
"value": {
"type": "integer",
"description": "The value of the associated key.",
"example": 8192
}
}
},
"connected_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": ""
},
"value": {
"type": "string",
"description": "The value of the associated key.",
"example": "Yes"
}
}
},
"frame_size_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "warning"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": "Configured frame size is different from what Wowza Video is receiving from the source: 1280x720."
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": ""
},
"value": {
"type": "string",
"description": "The value of the associated key.",
"example": "1280x720"
}
}
},
"frame_rate_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "FPS"
},
"value": {
"type": "integer",
"description": "The value of the associated key.",
"example": 30
}
}
},
"height_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "warning"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": "Configured height is different from what Wowza Video is receiving from the source: 720."
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "px"
},
"value": {
"type": "integer",
"description": "The value of the associated key.",
"example": 720
}
}
},
"keyframe_interval_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "GOP"
},
"value": {
"type": "integer",
"description": "The value of the associated key.",
"example": 69
}
}
},
"stream_target_status_OUTPUTIDX_STREAMTARGETIDX_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": ""
},
"value": {
"type": "string",
"description": "The value of the associated key.",
"example": "Active"
}
}
},
"unique_views_metric": {
"type": "object",
"description": "The number of unique viewers in the last 5 minutes.\n> **Note:** This parameter only returns data for Fastly stream targets.",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": "%"
},
"value": {
"type": "integer",
"description": "The value of the associated key.",
"example": 1030
}
}
},
"video_codec_metric": {
"type": "object",
"description": "",
"properties": {
"status": {
"type": "string",
"description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).",
"example": "normal"
},
"text": {
"type": "string",
"description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.",
"example": ""
},
"units": {
"type": "string",
"description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.",
"example": ""
},
"value": {
"type": "string",
"description": "The value of the associated key.\n\nNote: You might see avc1 or h264 returned interchangeably.", "example": "h264" } } }, "width_metric": { "type": "object", "description": "", "properties": { "status": { "type": "string", "description": "The status of the current key. Possible values are **normal** (everything is fine), **warning** (something may be misconfigured), and **no_data** (no data was returned, perhaps because the instance isn't running).", "example": "warning" }, "text": { "type": "string", "description": "A message related to the value and status of the current key. Usually blank unless there's a warning status.", "example": "Configured width is different from what Wowza Video is receiving from the source: 1280." }, "units": { "type": "string", "description": "The unit of the returned value, such as **Kbps**, **bps**, **%**, **FPS**, or **GOP**.", "example": "px" }, "value": { "type": "integer", "description": "The value of the associated key.", "example": 1280 } } }, "shm_metrics": { "type": "object", "description": "", "properties": { "audio_codec": { "$ref": "#/components/schemas/audio_codec_metric" }, "bits_in_rate": { "$ref": "#/components/schemas/bits_in_rate_metric" }, "bits_out_rate": { "$ref": "#/components/schemas/bits_out_rate_metric" }, "bytes_in_rate": { "$ref": "#/components/schemas/bytes_in_rate_metric" }, "bytes_out_rate": { "$ref": "#/components/schemas/bytes_out_rate_metric" }, "configured_bytes_out_rate": { "$ref": "#/components/schemas/configured_bytes_out_rate_metric" }, "connected": { "$ref": "#/components/schemas/connected_metric" }, "frame_size": { "$ref": "#/components/schemas/frame_size_metric" }, "frame_rate": { "$ref": "#/components/schemas/frame_rate_metric" }, "height": { "$ref": "#/components/schemas/height_metric" }, "keyframe_interval": { "$ref": "#/components/schemas/keyframe_interval_metric" }, "stream_target_status_OUTPUTIDX_STREAMTARGETIDX": { "$ref": "#/components/schemas/stream_target_status_OUTPUTIDX_STREAMTARGETIDX_metric" }, "unique_views": { "$ref": "#/components/schemas/unique_views_metric" }, "video_codec": { "$ref": "#/components/schemas/video_codec_metric" }, "width": { "$ref": "#/components/schemas/width_metric" } } }, "index_player": { "type": "object", "title": "players", "description": "", "properties": { "created_at": { "type": "string", "description": "The date and time that the player was created.", "example": "", "format": "date-time" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the player.", "example": "" }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder.", "example": "" }, "type": { "type": "string", "description": "The player you want to use.\n\n\n **Wowza Video subscribers**\nWowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.", "example": "" }, "updated_at": { "type": "string", "description": "The date and time that the player was updated.", "example": "", "format": "date-time" } } }, "players": { "type": "object", "description": "", "required": [ "players" ], "properties": { "players": { "type": "array", "description": "", "example": "", "items": { "$ref": "#/components/schemas/index_player" } } }, "example": { "players": [ { "created_at": "2020-01-29T17:16:21.968Z", "id": "e8dk5bf6", "transcoder_id": "6Qbymbbq", "type": "wowza_flowplayer", "updated_at": "2020-01-31T07:42:03.968Z" }, { "created_at": "2020-01-29T17:16:21.968Z", "id": "s3jmdnbl", "transcoder_id": "3kbb0hvf", "type": "wowza_flowplayer", "updated_at": "2020-01-31T02:22:29.968Z" } ] } }, "player": { "type": "object", "description": "", "properties": { "customizations": { "type": "object", "description": "Configuration of the player customizations.\n
If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.", "properties": { "play_icon": { "type": "string", "description": "A play icon that is displayed on the video preview. The default, **solid**, uses the standard play (solid triangle) icon. **outlined** uses an alternate (outlined triangle) play icon. **ring** uses an alternate (small solid triangle enclosed in a circle) play icon.\n\nDefault: **solid**", "example": "solid", "enum": [ "solid", "outlined", "ring" ] }, "thin_timeline": { "type": "boolean", "description": "If **true**, displays a control bar on the video. The default is **false**.", "example": "" }, "drag_handle": { "type": "boolean", "description": "If **true**, displays a drag handle on the progress bar. The default is **false**.", "example": "" }, "volume": { "type": "boolean", "description": "If **true**, displays a volume button on the video. The default is **true**.", "example": "" }, "mute": { "type": "boolean", "description": "If **true**, displays a mute button on the video. The default is **true**.", "example": "" }, "fullscreen": { "type": "boolean", "description": "If **true**, displays a fullscreen button on the video. The default is **true**.", "example": "" }, "show_player_title": { "type": "boolean", "description": "If **true**, displays a preview title on the video. The default is **false**.", "example": "" }, "color": { "type": "string", "description": "The color of the timeline and volume bar of the player.", "example": "" } } }, "countdown": { "type": "boolean", "description": "A clock that appears in the player before the event and counts down to the start of the stream. Specify **true** to display the countdown clock. The default is **false**.", "example": "" }, "countdown_at": { "type": "string", "description": "The date and time that the event starts, used by the countdown clock. Enter **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.", "example": "", "format": "date-time" }, "created_at": { "type": "string", "description": "The date and time that the player was created.", "example": "", "format": "date-time" }, "embed_code": { "type": "string", "description": "The HTML code that can be used in an external webpage to host the Wowza Flowplayer.", "example": "" }, "hls_playback_url": { "type": "string", "description": "The address that can be used to configure playback of the stream using the HLS protocol.", "example": "" }, "hosted_page": { "$ref": "#/components/schemas/hosted_page_response_object" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the player.", "example": "" }, "logo_image_url": { "type": "string", "description": "The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.", "example": "" }, "logo_position": { "type": "string", "description": "The corner of the player in which you want the player logo to appear. The default is **top-left**.", "example": "" }, "plugins": { "type": "object", "description": "Configuration of the plugins.", "properties": { "airplay": { "type": "boolean", "description": "If **true**, enables Airplay functionality in the player which allows you to cast to an Airplay device. The default is **false**.", "example": "" }, "chromecast": { "type": "boolean", "description": "If **true**, enables Chromecast functionality in the player which allows you to cast to a Chromecast device. The default is **false**.", "example": "" } } }, "responsive": { "type": "boolean", "description": "A player whose size adjusts according to the device on which it's being viewed. If **true**, creates a responsive player. If **false**, specify a **width**.", "example": "" }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder.", "example": "" }, "type": { "type": "string", "description": "The player you want to use.\n\n**Wowza Video subscribers** Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.", "example": "" }, "updated_at": { "type": "string", "description": "The date and time that the player was updated.", "example": "", "format": "date-time" }, "video_poster_image_url": { "type": "string", "description": "The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.", "example": "" }, "width": { "type": "integer", "description": "The width, in pixels, of a fixed-size player. The default is **640**.", "example": "", "format": "int32" } }, "example": { "customizations": { "play_icon": "solid", "thin_timeline": false, "drag_handle": false, "volume": true, "mute": true, "fullscreen": true, "show_player_title": false, "color": "4d4d4d" }, "countdown": true, "countdown_at": "2020-02-01T17:00:00.000Z", "created_at": "2020-01-29T17:16:21.968Z", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "hosted_page": { "enabled": true, "description": "My Hosted Page Description", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg", "sharing_icons": false, "title": "My Hosted Page", "url": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html" }, "id": "e8dk5bf6", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "plugins": { "airplay": false, "chromecast": false }, "responsive": false, "transcoder_id": "6Qbymbbq", "type": "wowza_flowplayer", "updated_at": "2020-01-31T16:08:26.990Z", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640 } }, "player_update_input": { "type": "object", "description": "", "required": [ "player" ], "properties": { "player": { "type": "object", "title": "player", "description": "", "properties": { "customizations": { "type": "object", "description": "Configuration of the player customizations.", "properties": { "play_icon": { "type": "string", "description": "A play icon that is displayed on the video preview. The default, **solid**, uses the standard play (solid triangle) icon. **outlined** uses an alternate (outlined triangle) play icon. **ring** uses an alternate (small solid triangle enclosed in a circle) play icon.\n\nDefault: **solid**\n\n**Example:**
\"play_icon\": \"solid\"",
"example": "solid",
"enum": [
"solid",
"outlined",
"ring"
]
},
"thin_timeline": {
"type": "boolean",
"description": "If **true**, displays a control bar on the video. The default is **false**.\n\n**Example:** \"thin_timeline\": false",
"example": ""
},
"drag_handle": {
"type": "boolean",
"description": "If **true**, displays a drag handle on the progress bar. The default is **false**.\n\n**Example:** \"drag_handle\": false",
"example": ""
},
"volume": {
"type": "boolean",
"description": "If **true**, displays a volume button on the video. The default is **true**.\n\n**Example:** \"volume\": true",
"example": ""
},
"mute": {
"type": "boolean",
"description": "If **true**, displays a mute button on the video. The default is **true**.\n\n**Example:** \"mute\": true",
"example": ""
},
"fullscreen": {
"type": "boolean",
"description": "If **true**, displays a fullscreen button on the video. The default is **true**.\n\n**Example:** \"fullscreen\": true",
"example": ""
},
"show_player_title": {
"type": "boolean",
"description": "If **true**, displays a preview title on the video. The default is **false**.\n\n**Example:** \"show_player_title\": false",
"example": ""
},
"color": {
"type": "string",
"description": "The color of the timeline and volume bar of the player. You can set the color of your choice by passing a hex code for that specific color.\n**Example:** \"color\": \"4d4d4d\"",
"example": ""
}
}
},
"countdown": {
"type": "boolean",
"description": "A clock that appears in the player before the event and counts down to the start of the stream. Specify **true** to display the countdown clock. The default is **false**.\n\n**Example:** \"countdown\": true",
"example": true
},
"countdown_at": {
"type": "string",
"description": "The date and time that the event starts, used by the countdown clock. Enter **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.\n\n**Example:** \"countdown_at\": \"2020-02-01T17:00:00.000Z\"",
"example": "2020-02-01T17:00:00.000Z",
"format": "date-time"
},
"hosted_page": {
"$ref": "#/components/schemas/hosted_page_request_object"
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of an image]\"",
"example": "[Base64-encoded string representation of an image]"
},
"logo_position": {
"type": "string",
"description": "The corner of the player in which you want the player logo to appear. The default is **top-left**.\n\n**Example:** \"logo_position\": \"top-left\"",
"example": "top-left"
},
"plugins": {
"type": "object",
"description": "Configuration of the plugins.",
"properties": {
"airplay": {
"type": "boolean",
"description": "If **true**, enables Airplay functionality in the player which allows you to cast to an Airplay device. The default is **false**.\n\n**Example:** \"airplay\": false",
"example": ""
},
"chromecast": {
"type": "boolean",
"description": "If **true**, enables Chromecast functionality in the player which allows you to cast to a Chromecast device. The default is **false**.\n\n**Example:** \"chromecast\": false",
"example": ""
}
}
},
"remove_logo_image": {
"type": "boolean",
"description": "If **true**, removes the logo file from the output. The default is **false**.\n\n**Example:** \"remove_logo_image\": true",
"example": true
},
"remove_video_poster_image": {
"type": "boolean",
"description": "If **true**, removes the poster image from the output. The default is **false**.\n\n**Example:** \"remove_video_poster_image\": true",
"example": true
},
"responsive": {
"type": "boolean",
"description": "A player whose size adjusts according to the device on which it's being viewed. If **true**, creates a responsive player. If **false**, specify a **width**.\n\n**Example:** \"responsive\": true",
"example": false
},
"type": {
"type": "string",
"description": "The player you want to use.\n\n**Wowza Video subscribers** Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.\n\nThe Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be [customized](https://www.wowza.com/docs/embed-and-customize-wowza-flowplayer-in-your-site) if you embed it in your site.\n\n> **Note**: If you update a live stream from **original_html5** or **wowza_player** to **wowza_flowplayer**, it cannot be changed later.\n\n**Other subscribers** original _html5 and wowza_player are the only valid options and original_html5 is the default. **original_html5** provides HTML5 playback and falls back to Flash on older browsers. **wowza_player** requires that *target_delivery_protocol* be **hls-https** and *closed_caption_type* be **none**.\n\n**Example:** \"type\": \"wowza_flowplayer\"",
"example": "wowza_flowplayer"
},
"video_poster_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.\n\n**Example:** \"video_poster_image\": \"[Base64-encoded string representation of an image]\"",
"example": "[Base64-encoded string representation of an image]"
},
"width": {
"type": "integer",
"description": "The width, in pixels, of a fixed-size player. The default is **640**.\n\n**Example:** \"width\": 640",
"example": 640,
"format": "int32"
}
}
}
},
"example": {
"player": {
"hosted_page": {
"title": "My Updated Hosted Page"
},
"responsive": true
}
}
},
"url": {
"type": "object",
"description": "",
"properties": {
"bitrate": {
"type": "integer",
"description": "The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": "",
"format": "int32"
},
"created_at": {
"type": "string",
"description": "The date and time that the player URL was created.",
"example": "",
"format": "date-time"
},
"height": {
"type": "integer",
"description": "The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": "",
"format": "int32"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the player URL.",
"example": ""
},
"label": {
"type": "string",
"description": "A descriptive name for the player URL. Maximum 255 characters.",
"example": ""
},
"player_id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the player.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the player URL was updated.",
"example": "",
"format": "date-time"
},
"url": {
"type": "string",
"description": "The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.",
"example": ""
},
"width": {
"type": "integer",
"description": "The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": "",
"format": "int32"
}
},
"example": {
"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
},
"urls": {
"type": "object",
"description": "",
"required": [
"urls"
],
"properties": {
"urls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/url"
}
}
},
"example": {
"urls": [
{
"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
},
{
"bitrate": 4138,
"height": 1080,
"id": "PPqV0kcm",
"label": "iPhone",
"player_id": "Jm1tPblTJm1t",
"transcoder_id": "yjCVYf5l",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
]
}
},
"url_input": {
"type": "object",
"description": "",
"required": [
"url"
],
"properties": {
"url": {
"type": "object",
"title": "url",
"description": "",
"properties": {
"bitrate": {
"type": "integer",
"description": "The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": 4128,
"format": "int32"
},
"height": {
"type": "integer",
"description": "The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": 1080,
"format": "int32"
},
"label": {
"type": "string",
"description": "A descriptive name for the player URL. Maximum 255 characters.",
"example": "1920"
},
"url": {
"type": "string",
"description": "The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.",
"example": "http://somedomain.com/path/to/stream.m3u8"
},
"width": {
"type": "integer",
"description": "The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than **0**.",
"example": 1920,
"format": "int32"
}
}
}
}
},
"url_create_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/url_input"
}
]
},
"url_update_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/url_input"
}
]
},
"index_asset": {
"type": "object",
"title": "assets",
"description": "",
"properties": {
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the asset",
"example": "i4qsbwvi"
},
"name": {
"type": "string",
"description": "A descriptive name for the asset. Maximum 200 characters.",
"example": "MyAsset"
},
"created_at": {
"type": "string",
"description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMT HH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. .",
"example": "",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date and time that the asset was updated in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMT HH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. .",
"example": "2022-02-26T01:38:40.310Z",
"format": "date-time"
},
"published": {
"type": "boolean",
"description": "Specifies whether an asset is published, which enables playback."
},
"thumbnail_url": {
"type": "string",
"description": "The URL to receive the preview thumbnail.",
"example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg"
},
"state": {
"type": "string",
"description": "The state of the asset.",
"example": "completed",
"enum": [
"uploading",
"processing",
"completed",
"failed"
]
},
"reason": {
"type": "string",
"description": "The reason that an asset has the state **failed**. Only returned when state is **failed** after processing is attempted.",
"example": ""
},
"processing_percentage": {
"type": "integer",
"description": "A percentage that describes how soon transcoding will complete.",
"example": "100.0"
},
"file_size": {
"type": "integer",
"description": "The file size of the asset in bytes. For example, 2372820 bytes equals 2.4 megabytes.",
"example": "",
"format": "int64"
},
"playback_url": {
"type": "string",
"description": "The address that can be used to configure playback of the stream.",
"example": ""
},
"download_url": {
"type": "string",
"description": "The URL that can be used to download the asset as a .MP4 file.",
"example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset.mp4"
},
"file_name": {
"type": "string",
"description": "The name of the mp4 file you uploaded.\n\nNote: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" } } }, "assets": { "type": "object", "description": "", "required": [ "assets" ], "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/index_asset" } } }, "example": { "assets": [ { "id": "wdjfqvsv", "name": "MyAsset", "created_at": "2020-01-29T17:16:21.849Z", "updated_at": "2020-01-31T16:06:47.849Z", "published": true, "thumbnail_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg.jpg", "state": "completed", "processing_percentage": 0.1, "file_size": 1570024, "playback_url": "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8", "download_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset.mp4", "file_name": "MyFile.mp4" }, { "id": "KyxWKtHQ", "name": "MyAsset2", "created_at": "2020-01-29T17:16:21.849Z", "updated_at": "2020-01-31T02:26:05.849Z", "published": true, "thumbnail_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg.jpg", "state": "completed", "processing_percentage": 0.3, "file_size": 70284, "playback_url": "https://wowzasubdomain/1/U0VmOU90TmtvSzJP/Y2ltUkl2/hls/live/playlist.m3u8", "download_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset2.mp4", "file_name": "MyFile2.mp4" }, { "id": "Ly40ZDSg", "name": "MyAsset3", "created_at": "2020-01-29T17:16:21.849Z", "updated_at": "2020-01-30T18:13:18.849Z", "published": true, "thumbnail_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg.jpg", "state": "completed", "processing_percentage": 0, "file_size": 882391, "playback_url": "https://wowzasubdomain/1/PmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8", "download_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset3.mp4", "file_name": "MyFile3.mp4" } ] } }, "asset_create_input": { "type": "object", "description": "", "properties": { "asset": { "type": "object", "title": "asset", "description": "", "required": [ "file_name" ], "properties": { "file_name": { "type": "string", "description": "The name of the mp4 file you are uploading.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" } } } }, "example": { "asset": { "file_name": "MyAsset.mp4" } } }, "asset_create_output": { "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The unique identifier of the asset. Use this ID to perform other operations on the stream, like getting the details of the asset or deleting it.", "example": "wdjfqvsv" }, "created_at": { "type": "string", "description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows:Â YYYY-DD-MMT HH:MM:SSZÂ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset.", "example": "2021-06-30T18:02:20.000Z", "format": "date-time" }, "file_name": { "type": "string", "description": "The name of the mp4 file you are uploading.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" }, "upload_url": { "type": "string", "description": "The upload location for the asset. Use this URL to upload the .mp4 assets to the Wowza Video Asset Manager.", "example": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/k9bGRcyPFPtdeQeTRgAVTByIVVS0Z_EKrLBu3TusTrRfBuIpoDyio_ZY3qJM55tp/n/a1b2c3d4e5f6/b/recordings-qa-S7I69eYn/o/uploads/recording_bry7vv0s/MyAsset.mp4" } }, "example": { "id": "2adffc17", "created_at": "2021-06-30T18:02:20.000Z", "file_name": "MyAsset.mp4", "upload_url": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/k9bGRcyPFPtdeQeTRgAVTByIVVS0Z_EKrLBu3TusTrRfBuIpoDyio_ZY3qJM55tp/n/a1b2c3d4e5f6/b/recordings-qa-S7I69eYn/o/uploads/recording_bry7vv0s/MyAsset.mp4" } }, "renditions": { "type": "object", "description": "", "properties": { "height": { "type": "integer", "description": "The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1080**.", "example": "", "format": "int32" }, "width": { "type": "integer", "description": "The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1920**.", "example": "", "format": "int32" }, "bitrate_kbps": { "type": "integer", "description": "The video bitrate, in kilobits per second (Kbps). Must be between **1** and **10240**. The default is **4000**.", "example": "", "format": "int32" } }, "example": { "height": 480, "width": 848, "bitrate_kbps": 1600 } }, "asset": { "type": "object", "description": "", "properties": { "available_renditions": { "type": "array", "description": "The renditions available for the asset.", "items": { "$ref": "#/components/schemas/renditions" } }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the asset", "example": "i4qsbwvi" }, "name": { "type": "string", "description": "A descriptive name for the live stream. Maximum 200 characters.", "example": "My Asset" }, "description": { "type": "string", "description": "A description of the asset. Maximum 16,000 characters.", "example": "My Asset Description" }, "published": { "type": "boolean", "description": "Specifies whether an asset is published, which enables playback." }, "tags": { "type": "array", "description": "A list of tags associated with the asset.", "example": [ "Tag1", "Tag2", "Tag3" ] }, "upload_url": { "type": "string", "description": "The upload location for the asset. Use this URL to upload the .mp4 assets to the Wowza Video Asset Manager.\n\nOnly returned when the asset is in the **uploading** state, and returns a new upload URL. Useful if the previous upload URL expired and you need a new one.", "example": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/k9bGRcyPFPtdeQeTRgAVTByIVVS0Z_EKrLBu3TusTrRfBuIpoDyio_ZY3qJM55tp/n/a1b2c3d4e5f6/b/recordings-qa-S7I69eYn/o/uploads/recording_bry7vv0s/MyAsset.mp4" }, "vod_stream_id": { "type": "string", "description": "An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.", "example": "l9qsbwvf" }, "recording_id": { "type": "string", "description": "An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.", "example": "l8qsbwvu" }, "state": { "type": "string", "description": "The state of the asset.", "example": "completed", "enum": [ "uploading", "processing", "completed", "failed" ] }, "reason": { "type": "string", "description": "The reason that an asset has the state **failed**. Only returned when state is **failed** after processing is attempted.", "example": "" }, "created_at": { "type": "string", "description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset.", "example": "2021-06-30T18:02:20.000Z", "format": "date-time" }, "updated_at": { "type": "string", "description": "The date and time that the asset was updated in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. ", "example": "2021-06-30T18:02:20.000Z", "format": "date-time" }, "download_url": { "type": "string", "description": "The URL that can be used to download the asset as a .MP4 file.", "example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset.mp4" }, "file_size": { "type": "integer", "description": "The file size of the asset in bytes. For example, 2372820 bytes equals 2.4 megabytes.", "example": 2372820 }, "duration": { "type": "integer", "description": "The length of an asset in seconds. For example, 9241 would represent 9,241 seconds or roughly 2.5 hours.", "example": 9241 }, "thumbnail_url": { "type": "string", "description": "The URL to receive the preview thumbnail.", "example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg" }, "unique_viewers": { "type": "integer", "description": "The unique_viewers parameter is deprecated. To get unique viewers for an asset, use the GET /analytics/viewers/vod_stream/{id} endpoint.", "example": 5986 }, "total_viewing_time": { "type": "integer", "description": "The total_viewing_time parameter is deprecated.", "example": 4492549 }, "average_view_time": { "type": "integer", "description": "The average_view_time parameter is deprecated.", "example": 12580, "format": "time" }, "playback_url": { "type": "string", "description": "The HLS URL for the stream associated with the asset.", "example": "https://cdn3-qa.wowza.com/2/T1R6V2hBV2hEdmJ0/ZnJUOE9q/hls/g7z7bwbz/playlist.m3u8" }, "total_storage_size": { "type": "integer", "description": "The total storage size for the asset in bytes. In this example, 19513598 equals 19.5 megabytes.", "example": 19513598 }, "file_name": { "type": "string", "description": "The name of the mp4 file you uploaded.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" }, "processing_percentage": { "type": "integer", "description": "A percentage that describes how soon transcoding will complete.", "example": 100 }, "player_embed_code": { "type": "string", "description": "The HTML code that can be used in external webpage to host the Wowza Flowplayer.", "example": "\\n\\n" }, "hosted_page": { "type": "object", "description": "Configuration of the hosted page.", "properties": { "title": { "type": "string", "description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:**
\"title\": \"My Hosted Page\"",
"example": "My Hosted Page"
},
"url": {
"type": "string",
"description": "The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.",
"example": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"description\": \"My Hosted Page Description\"",
"example": "This is my hosted page."
},
"logo_image_url": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.\n\n**Example:** \"sharing_icons\": false",
"example": false
}
}
}
}
},
"Error422_asset_not_available": {
"type": "object",
"description": "",
"required": [
"meta"
],
"properties": {
"meta": {
"type": "object",
"title": "meta",
"description": "",
"properties": {
"status": {
"type": "integer",
"description": "",
"example": "",
"format": "int32"
},
"code": {
"type": "string",
"description": "",
"example": ""
},
"title": {
"type": "string",
"description": "",
"example": ""
},
"message": {
"type": "string",
"description": "",
"example": ""
},
"description": {
"type": "string",
"description": "",
"example": ""
},
"links": {
"type": "array",
"description": "",
"example": "",
"items": {}
}
}
}
},
"example": {
"Example Response 1": {
"meta": {
"status": 422,
"code": "ERR-422-NotAvailable",
"title": "Asset Not Available",
"message": "The asset isn't available for editing, deleting, or restreaming. Wait until the processing for the asset is complete and try again.",
"description": "",
"links": []
}
}
}
},
"asset_update_input": {
"type": "object",
"description": "",
"required": [
"asset"
],
"properties": {
"asset": {
"type": "object",
"title": "asset",
"description": "",
"properties": {
"description": {
"type": "string",
"description": "A description of the asset. Maximum 16,000 characters.\n\n**Example:** \"description\": \"My updated asset description\"",
"example": "My Asset Description"
},
"name": {
"type": "string",
"description": "A descriptive name for the live stream. Maximum 200 characters.\n\n**Example:** \"name\": \"My Updated Live Stream Asset\"",
"example": "My Live Stream"
},
"published": {
"type": "boolean",
"description": "Specifies whether an asset is published, which enables playback.\n\n**Example:** \"published\": true"
},
"tags": {
"type": "array",
"description": "A list of tags associated with the asset.\n\n**Example:** \"tags\": [\"Tag1\", \"Tag2\", \"Tag3\"]",
"example": [
"Tag1",
"Tag2",
"Tag3"
]
},
"hosted_page": {
"type": "object",
"description": "Configuration of the hosted page.",
"properties": {
"title": {
"type": "string",
"description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"title\": \"My Hosted Page\"",
"example": "My Hosted Page"
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"description\": \"My Hosted Page Description\"",
"example": ""
},
"logo_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
},
"remove_logo_image": {
"type": "boolean",
"description": "If **true**, removes the logo file from the hosted page. The default is **false**.\n\n**Example:** \"remove_logo_image\": true",
"example": true
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.\n\n**Example:** \"sharing_icons\": false",
"example": false
}
}
}
}
}
}
},
"asset_update_output": {
"type": "object",
"description": "",
"properties": {
"available_renditions": {
"type": "array",
"description": "The renditions available for the asset.",
"items": {
"$ref": "#/components/schemas/renditions"
}
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the asset",
"example": "i4qsbwvi"
},
"name": {
"type": "string",
"description": "A descriptive name for the live stream. Maximum 200 characters.",
"example": "My Asset"
},
"description": {
"type": "string",
"description": "A description of the asset. Maximum 16,000 characters.",
"example": "My Asset Description"
},
"published": {
"type": "boolean",
"description": "Specifies whether an asset is published, which enables playback."
},
"tags": {
"type": "array",
"description": "A list of tags associated with the asset.",
"example": [
"Tag1",
"Tag2",
"Tag3"
]
},
"vod_stream_id": {
"type": "string",
"description": "An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.",
"example": "l9qsbwvf"
},
"recording_id": {
"type": "string",
"description": "An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.",
"example": "l8qsbwvu"
},
"state": {
"type": "string",
"description": "The state of the asset.",
"example": "completed",
"enum": [
"uploading",
"processing",
"completed",
"failed"
]
},
"created_at": {
"type": "string",
"description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows:Â YYYY-DD-MMTHH:MM:SSZÂ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset.",
"example": "2021-06-30T18:02:20.000Z",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date and time that the asset was updated in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. ",
"example": "2021-06-30T18:02:20.000Z",
"format": "date-time"
},
"download_url": {
"type": "string",
"description": "The URL that can be used to download the asset as a .MP4 file.",
"example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset.mp4"
},
"file_size": {
"type": "integer",
"description": "The file size of the asset in bytes. For example, 2372820 bytes equals 2.4 megabytes.",
"example": 2372820
},
"duration": {
"type": "integer",
"description": "The length of an asset in seconds. For example, 9241 would represent 9,241 seconds or roughly 2.5 hours.",
"example": 9241
},
"thumbnail_url": {
"type": "string",
"description": "The URL to receive the preview thumbnail.",
"example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/0pfxrlw2_thumbnail.jpg"
},
"unique_viewers": {
"type": "integer",
"description": "The number of unique viewers for the stream.",
"example": 5986
},
"total_viewing_time": {
"type": "integer",
"description": "The total time that the asset has been viewed by anyone, in seconds. In this example 4492549 would equal 1,248 total hours of view time.",
"example": 4492549
},
"average_view_time": {
"type": "integer",
"description": "The average time that the asset has been viewed in seconds. For example, 12580 seconds would be 3.5 hours.",
"example": 12580,
"format": "time"
},
"playback_url": {
"type": "string",
"description": "The HLS URL for the stream associated with the asset.",
"example": "https://cdn3-qa.wowza.com/2/T1R6V2hBV2hEdmJ0/ZnJUOE9q/hls/g7z7bwbz/playlist.m3u8"
},
"total_storage_size": {
"type": "integer",
"description": "The total storage size for the asset in bytes. In this example, 19513598 equals 19.5 megabytes.",
"example": 19513598
},
"file_name": {
"type": "string",
"description": "The name of the mp4 file you uploaded.\n\nNote: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" }, "processing_percentage": { "type": "integer", "description": "A percentage that describes how soon transcoding will complete.", "example": 100 }, "player_embed_code": { "type": "string", "description": "The HTML code that can be used in external webpage to host the Wowza Flowplayer.", "example": "\\n\\n" }, "hosted_page": { "type": "object", "description": "Configuration of the hosted page.", "properties": { "title": { "type": "string", "description": "A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:**
\"title\": \"My Hosted Page\"",
"example": "My Hosted Page"
},
"description": {
"type": "string",
"description": "A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.\n\n**Example:** \"description\": \"My Hosted Page Description\"",
"example": "This is my hosted page."
},
"logo_image_url": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.\n\n**Example:** \"logo_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
},
"sharing_icons": {
"type": "boolean",
"description": "Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons.\n\n**Example:** \"sharing_icons\": false",
"example": false
},
"url": {
"type": "string",
"description": "The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.",
"example": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"
}
}
}
}
},
"asset_restream": {
"type": "object",
"description": "",
"title": "assets_restream",
"properties": {
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the live stream associated with the asset.",
"example": "Yx6rTGKL"
},
"name": {
"type": "string",
"description": "A name for the live stream assosicated with the asset. This is generated by Wowza Video.",
"example": "CMS Restreamed (ucknggax)"
}
}
},
"asset_tags": {
"type": "object",
"description": "",
"properties": {
"asset_tags": {
"type": "array",
"description": "An array of asset tags the organization has created."
}
},
"example": {
"asset_tags": [
"tag1",
"tag2",
"tag3"
]
}
},
"asset_report_uploaded_input": {
"description": "",
"required": [
"asset"
],
"properties": {
"asset": {
"type": "object",
"title": "asset",
"description": "",
"required": [
"duration"
],
"properties": {
"duration": {
"type": "integer",
"description": "The length of an asset in seconds. In this example, 9241 would represent 9,241 seconds or roughly 2.5 hours.",
"example": 9241
}
}
}
}
},
"asset_report_uploaded_output": {
"type": "object",
"description": "",
"properties": {
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the asset",
"example": "i4qsbwvi"
},
"name": {
"type": "string",
"description": "A descriptive name for the live stream. Maximum 200 characters.",
"example": "My Asset"
},
"tags": {
"type": "array",
"description": "A list of tags associated with the asset.",
"example": [
"Tag1",
"Tag2",
"Tag3"
]
},
"vod_stream_id": {
"type": "string",
"description": "An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.",
"example": "l9qsbwvf"
},
"recording_id": {
"type": "string",
"description": "An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.",
"example": "l8qsbwvu"
},
"state": {
"type": "string",
"description": "The state of the asset.",
"example": "processing",
"enum": [
"uploading",
"processing",
"completed",
"failed"
]
},
"created_at": {
"type": "string",
"description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows:Â YYYY-DD-MMTHH:MM:SSZÂ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset.",
"example": "2021-06-30T18:02:20.000Z",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date and time that the asset was updated in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. ",
"example": "2021-06-30T18:02:20.000Z",
"format": "date-time"
},
"download_url": {
"type": "string",
"description": "The URL that can be used to download the asset as a .MP4 file.",
"example": "https://objectstorage.us-ashburn-1.oraclecloud.com/n/idcrz33q3xdo/b/recordings-qa-S7I69eYn/o/abcd1234/recording_0pfxrlw2/MyAsset.mp4"
},
"file_size": {
"type": "integer",
"description": "The file size of the asset in bytes. For example, 2372820 bytes equals 2.4 megabytes.",
"example": 2372820
},
"duration": {
"type": "integer",
"description": "The length of an asset in seconds. For example, 9241 would represent 9,241 seconds or roughly 2.5 hours.",
"example": 9241
},
"average_view_time": {
"type": "integer",
"description": "The average time that the asset has been viewed in seconds. For example, 12580 seconds would be 3.5 hours.",
"example": 12580,
"format": "time"
},
"file_name": {
"type": "string",
"description": "The name of the mp4 file you uploaded.\n\nNote: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" }, "processing_percentage": { "type": "integer", "description": "A percentage that describes how soon transcoding will complete.", "example": 100 } } }, "asset_report_upload_failed_input": { "type": "object", "description": "", "required": [ "asset" ], "properties": { "asset": { "type": "object", "title": "asset", "description": "", "required": [ "reason", "status" ], "properties": { "reason": { "type": "string", "description": "A description of why the upload failed.", "example": "Token expired" }, "status": { "type": "string", "description": "The status code returned by the server.", "example": 404 } } } } }, "asset_report_upload_failed_output": { "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The unique alphanumeric string that identifies the asset", "example": "i4qsbwvi" }, "name": { "type": "string", "description": "A descriptive name for the live stream. Maximum 200 characters.", "example": "My Asset" }, "tags": { "type": "array", "description": "A list of tags associated with the asset.", "example": [ "Tag1", "Tag2", "Tag3" ] }, "recording_id": { "type": "string", "description": "An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.", "example": "l8qsbwvu" }, "state": { "type": "string", "description": "The state of the asset.", "example": "failed", "enum": [ "uploading", "processing", "completed", "failed" ] }, "created_at": { "type": "string", "description": "The date and time that the asset was created in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset.", "example": "2021-06-30T18:02:20.000Z", "format": "date-time" }, "updated_at": { "type": "string", "description": "The date and time that the asset was updated in Coordinated Universal Time (UTC) format. Dates are formatted as follows: YYYY-DD-MMTHH:MM:SSZ using 24-hour clock (\"military\") time and including the T and Z. The T marks the end of the date portion and the Z represents zero UTC time offset. ", "example": "2021-06-30T18:02:20.000Z", "format": "date-time" }, "average_view_time": { "type": "integer", "description": "The average time that the asset has been viewed in seconds. For example, 12580 seconds would be 3.5 hours.", "example": 12580, "format": "time" }, "file_name": { "type": "string", "description": "The name of the mp4 file you uploaded.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "MyAsset.mp4" }, "processing_percentage": { "type": "integer", "description": "A percentage that describes how soon transcoding will complete.", "example": 100 } } }, "index_recordings": { "type": "object", "description": "", "title": "recordings", "properties": { "created_at": { "type": "string", "description": "The date and time that the recording was created.", "example": "2020-01-29T17:16:21.993Z", "format": "date-time" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the recording.", "example": "4Jjzstdt" }, "asset_id": { "type": "string", "description": "Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management.", "example": "tk1plmzr" }, "file_name": { "type": "string", "description": "The file name of the recording.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "" }, "real_time_stream_id": { "type": "string", "description": "Only applies to Real-Time Streaming at Scale. The unique alphanumeric string that identifies the real-time stream that was recorded.", "example": "cj39nmrt" }, "reason": { "type": "string", "description": "The reason that a recording has the state **failed**.", "example": "" }, "state": { "type": "string", "description": "The state of the recording.", "example": "completed", "enum": [ "uploading", "converting", "removing", "completed", "failed" ] }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder that was recorded.", "example": "bjaplmrw" }, "updated_at": { "type": "string", "description": "The date and time that the recording was updated.", "example": "2020-01-31T14:14:01.993Z", "format": "date-time" } } }, "recordings": { "type": "object", "description": "", "required": [ "recordings" ], "properties": { "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/index_recordings" } } }, "example": { "recordings": [ { "id": "4Jjzstdt", "transcoder_id": "bjaplmrw", "state": "converting", "reason": "", "file_name": "31a4f9f4.stream.0.mp4", "created_at": "2023-01-29T17:16:21.993Z", "updated_at": "2023-01-31T10:37:57.993Z" }, { "id": "fFWxVsyj", "state": "completed", "reason": "", "file_name": "my_rts_recording.mp4", "asset_id": "thfsm6c2", "real_time_asset_id": "xbzk91ts", "created_at": "2023-01-28T17:16:21.993Z", "updated_at": "2023-01-30T21:34:45.993Z" } ] } }, "recording": { "type": "object", "description": "", "properties": { "asset_id": { "type": "string", "description": "Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management." }, "created_at": { "type": "string", "description": "The date and time that the recording was created.", "example": "", "format": "date-time" }, "download_url": { "type": "string", "description": "The URL that can be used to download the recording.", "example": "" }, "duration": { "type": "integer", "description": "The length of the recording, in hours, minutes, and seconds.", "example": "", "format": "int64" }, "file_name": { "type": "string", "description": "The file name of the recording.\n\n
Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.", "example": "" }, "file_size": { "type": "integer", "description": "The file size of the recording.", "example": "", "format": "int64" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the recording.", "example": "" }, "real_time_stream_id": { "type": "string", "description": "Only applies to Real-Time Streaming at Scale. The unique alphanumeric string that identifies the real-time stream that was recorded.", "example": "cj39nmrt" }, "reason": { "type": "string", "description": "The reason that a recording has the state **failed**.", "example": "" }, "starts_at": { "type": "string", "description": "The date and time that the recording started.", "example": "" }, "state": { "type": "string", "description": "The state of the recording.", "example": "", "enum": [ "uploading", "converting", "removing", "completed", "failed" ] }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder that was recorded.", "example": "" }, "transcoder_name": { "type": "string", "description": "The descriptive name of the transcoder that was recorded.", "example": "" }, "transcoding_uptime_id": { "type": "string", "description": "The unique identifier associated with the transcoding uptime for this recording.", "example": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "The date and time that the recording was updated.", "example": "", "format": "date-time" } }, "example": { "created_at": "2020-01-29T17:16:21.993Z", "download_url": "https://s3.amazonaws.com/prod-wse-recordings/transcoder_035163/64886_00a613bf@367500.stream.0.mp4", "duration": 362905, "file_name": "00a613bf@367500.stream.0.mp4", "file_size": 53113429, "id": "4Jjzstdt", "reason": "", "starts_at": "2020-02-01T00:00:00.000Z", "transcoding_uptime_id": "vxyz9876", "state": "completed", "transcoder_id": "bjQplmRw", "transcoder_name": "My Camera", "updated_at": "2020-01-30T17:22:20.993Z" } }, "schedule": { "type": "object", "description": "", "properties": { "action_type": { "type": "string", "description": "The type of action that the schedule should trigger on the transcoder. The default is **start**.", "example": "start_stop", "enum": [ "start", "stop", "start_stop" ] }, "created_at": { "type": "string", "description": "The date and time that the schedule was created.", "example": "2020-01-29T17:16:21.995Z", "format": "date-time" }, "end_repeat": { "type": "string", "description": "The month, day, and year that a recurring schedule should stop running. Specify **YYYY-MM-DD**.", "example": "2020-02-29T00:00:00.000Z", "format": "date" }, "id": { "type": "string", "description": "The unique alphanumeric string that identifies the schedule.", "example": "vhB0jSlB" }, "name": { "type": "string", "description": "A descriptive name for the schedule. Maximum 255 characters.", "example": "Scheduled start for my camera" }, "recurrence_data": { "type": "string", "description": "The day or days of the week that a recurring schedule should run.", "example": "monday,tuesday,wednesday,thursday,friday", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] }, "recurrence_type": { "type": "string", "description": "A schedule can run one time only (**once**) or repeat (**recur**) until a specified *end_repeat* date. The default is **once**.", "example": "recur", "enum": [ "once", "recur" ] }, "start_repeat": { "type": "string", "description": "The month, day, and year that the recurring schedule should go into effect. Specify **YYYY-MM-DD**.", "example": "2020-02-01T00:00:00.000Z", "format": "date" }, "start_transcoder": { "type": "string", "description": "The month, day, year, and time of day that the *action_type* **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.", "example": "2020-02-01T00:00:00.000Z", "format": "date-time" }, "state": { "type": "string", "description": "A schedule must be **enabled** to run. Specify **enabled** to run the schedule or **disabled** to turn off the schedule so that it doesn't run.", "example": "enabled", "enum": [ "enabled", "disabled", "expired" ] }, "stop_transcoder": { "type": "string", "description": "The month, day, year, and time of day that the *action_type* **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.", "example": "2020-02-29T23:59:59.999Z", "format": "date-time" }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder being scheduled.", "example": "P0NrTP7m" }, "transcoder_name": { "type": "string", "description": "The name of the transcoder being scheduled.", "example": "My Camera" }, "updated_at": { "type": "string", "description": "The date and time that the schedule was updated.", "example": "2020-01-30T16:44:37.995Z", "format": "date-time" } }, "example": { "id": "28bwb5WT", "state": "disabled", "name": "Scheduled recurring start for my camera", "transcoder_id": "VGB21JFJ", "transcoder_name": "My Camera", "recurrence_type": "recur", "recurrence_data": "monday,tuesday,wednesday,thursday,friday", "action_type": "start_stop", "start_transcoder": "2020-02-01T00:00:00.000Z", "stop_transcoder": "2020-02-29T23:59:59.999Z", "start_repeat": "2020-02-01T00:00:00.000Z", "end_repeat": "2020-02-29T00:00:00.000Z", "created_at": "2020-01-29T17:16:21.995Z", "updated_at": "2020-01-31T07:00:48.995Z" } }, "schedules": { "type": "object", "description": "", "required": [ "schedules" ], "properties": { "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/schedule" } } }, "example": { "schedules": [ { "id": "28bwb5WT", "state": "disabled", "name": "Scheduled recurring start for my camera", "transcoder_id": "VGB21JFJ", "transcoder_name": "My Camera", "recurrence_type": "recur", "recurrence_data": "monday,tuesday,wednesday,thursday,friday", "action_type": "start_stop", "start_transcoder": "2020-02-01T00:00:00.000Z", "stop_transcoder": "2020-02-29T23:59:59.999Z", "start_repeat": "2020-02-01T00:00:00.000Z", "end_repeat": "2020-02-29T00:00:00.000Z", "created_at": "2020-01-29T17:16:21.995Z", "updated_at": "2020-01-31T14:58:43.995Z" }, { "id": "4RCWgfS5", "state": "enabled", "name": "Scheduled stop for my live event", "transcoder_id": "Qjl5J38Z", "transcoder_name": "Awesome Live Event", "recurrence_type": "once", "action_type": "stop", "start_transcoder": "2020-02-01T00:00:00.000Z", "stop_transcoder": "2020-02-29T23:59:59.999Z", "created_at": "2020-01-29T17:16:21.995Z", "updated_at": "2020-01-31T08:25:45.995Z" } ] } }, "schedule_create_input": { "type": "object", "description": "", "required": [ "schedule" ], "properties": { "schedule": { "type": "object", "title": "schedule", "description": "", "required": [ "name", "transcoder_id", "action_type", "recurrence_type" ], "properties": { "action_type": { "type": "string", "description": "The type of action that the schedule should trigger on the transcoder. The default is **start**.", "example": "start_stop", "enum": [ "start", "stop", "start_stop" ] }, "name": { "type": "string", "description": "A descriptive name for the schedule. Maximum 255 characters.", "example": "Scheduled start for my camera" }, "recurrence_type": { "type": "string", "description": "A schedule can run one time only (**once**) or repeat (**recur**) until a specified *end_repeat* date. The default is **once**.", "example": "recur", "enum": [ "once", "recur" ] }, "transcoder_id": { "type": "string", "description": "The unique alphanumeric string that identifies the transcoder being scheduled.", "example": "km1FSSVL" }, "end_repeat": { "type": "string", "description": "The month, day, and year that a recurring schedule should stop running. Specify **YYYY-MM-DD**.\n\n**Example:**
\"end_repeat\": \"2020-02-29T00:00:00.000Z\"",
"example": "2020-02-29T00:00:00.000Z",
"format": "date"
},
"recurrence_data": {
"type": "string",
"description": "The day or days of the week that a recurring schedule should run.\n\n**Example:** \"recurrence_data\": \"monday,tuesday,wednesday,thursday,friday\"",
"example": "monday,tuesday,wednesday,thursday,friday",
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
},
"start_repeat": {
"type": "string",
"description": "The month, day, and year that the recurring schedule should go into effect. Specify **YYYY-MM-DD**.\n\n**Example:** \"start_repeat\": \"2020-02-01T00:00:00.000Z\"",
"example": "2020-02-01T00:00:00.000Z",
"format": "date"
},
"start_transcoder": {
"type": "string",
"description": "The month, day, year, and time of day that the *action_type* **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.\n\nRequired when **action_type** is **start** or **start_stop**.\n\n**Example:** \"start_transcoder\": \"2020-02-01T00:00:00.000Z\"",
"example": "2020-02-01T00:00:00.000Z",
"format": "date-time"
},
"stop_transcoder": {
"type": "string",
"description": "The month, day, year, and time of day that the *action_type* **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.\n\nRequired when **action_type** is **stop** or **start_stop**.\n\n**Example:** \"start_transcoder\": \"2020-02-29T23:59:59.999Z\"",
"example": "2020-02-29T23:59:59.999Z",
"format": "date-time"
}
}
}
}
},
"schedule_update_input": {
"type": "object",
"description": "",
"required": [
"schedule"
],
"properties": {
"schedule": {
"type": "object",
"title": "schedule",
"description": "",
"properties": {
"action_type": {
"type": "string",
"description": "The type of action that the schedule should trigger on the transcoder. The default is **start**.\n\n**Example:** \"action_type\": \"stop\"",
"example": "start_stop",
"enum": [
"start",
"stop",
"start_stop"
]
},
"name": {
"type": "string",
"description": "A descriptive name for the schedule. Maximum 255 characters.\n\n**Example:** \"name\": \"My Updated Schedule\"",
"example": "Scheduled start for my camera"
},
"end_repeat": {
"type": "string",
"description": "The month, day, and year that a recurring schedule should stop running. Specify **YYYY-MM-DD**.\n\n**Example:** \"end_repeat\": \"2020-02-29T00:00:00.000Z\"",
"example": "2020-02-29T00:00:00.000Z",
"format": "date"
},
"recurrence_data": {
"type": "string",
"description": "The day or days of the week that a recurring schedule should run.\n\n**Example:** \"recurrence_data\": \"monday,tuesday,wednesday,thursday,friday\"",
"example": "monday,tuesday,wednesday,thursday,friday",
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
]
},
"start_repeat": {
"type": "string",
"description": "The month, day, and year that the recurring schedule should go into effect. Specify **YYYY-MM-DD**.\n\n**Example:** \"start_repeat\": \"2020-02-01T00:00:00.000Z\"",
"example": "2020-02-01T00:00:00.000Z",
"format": "date"
},
"start_transcoder": {
"type": "string",
"description": "The month, day, year, and time of day that the *action_type* **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.\n\n**Example:** \"start_transcoder\": \"2020-02-01T00:00:00.000Z\"",
"example": "2020-02-01T00:00:00.000Z",
"format": "date-time"
},
"stop_transcoder": {
"type": "string",
"description": "The month, day, year, and time of day that the *action_type* **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH** is a 24-hour clock in UTC.\n\n**Example:** \"start_transcoder\": \"2020-02-29T23:59:59.999Z\"",
"example": "2020-02-29T23:59:59.999Z",
"format": "date-time"
}
}
}
}
},
"index_stream_source": {
"type": "object",
"description": "",
"title": "stream_sources",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the stream source was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream source.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the stream source. Maximum 255 characters.",
"example": ""
},
"type": {
"type": "string",
"description": "An **akamai** stream source is a Wowza Video edge resource that sends streams to a Wowza Video transcoder using the RTMP protocol. A **wowza** stream source enables automatic transcoder start, stop, and broadcast location detection.",
"example": "",
"enum": [
"akamai",
"wowza"
]
},
"updated_at": {
"type": "string",
"description": "The date and time that the stream source was updated.",
"example": "",
"format": "date-time"
}
}
},
"stream_sources": {
"type": "object",
"description": "",
"required": [
"stream_sources"
],
"properties": {
"stream_sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_stream_source"
}
}
},
"example": {
"stream_sources": [
{
"id": "cJYndjJt",
"name": "My region-based Stream Source",
"type": "wowza",
"created_at": "2020-01-29T17:16:22.000Z",
"updated_at": "2020-01-31T02:37:48.000Z"
},
{
"id": "pvVWPLZC",
"name": "My IP address based Stream Source",
"type": "wowza",
"created_at": "2020-01-28T17:16:22.000Z",
"updated_at": "2020-01-30T14:13:07.000Z"
}
]
}
},
"index_wowza_stream_source": {
"type": "object",
"description": "",
"title": "stream_sources_wowza",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the Wowza stream source.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the Wowza stream source. Maximum 255 characters.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was updated.",
"example": "",
"format": "date-time"
}
}
},
"stream_sources_wowza": {
"type": "object",
"description": "",
"required": [
"stream_sources_wowza"
],
"properties": {
"stream_sources_wowza": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_wowza_stream_source"
}
}
},
"example": {
"stream_sources_wowza": [
{
"created_at": "2020-01-29T17:16:22.001Z",
"id": "cJYndjJt",
"name": "My Wowza Stream Source",
"updated_at": "2020-01-30T19:44:59.001Z"
},
{
"created_at": "2020-01-28T17:16:22.001Z",
"id": "pvVWPLZC",
"name": "My other Wowza Stream Source",
"updated_at": "2020-01-31T01:17:45.001Z"
}
]
}
},
"wowza_stream_source_create_input": {
"type": "object",
"description": "",
"required": [
"stream_source_wowza"
],
"properties": {
"stream_source_wowza": {
"type": "object",
"title": "stream_source_wowza",
"description": "",
"example": {
"name": "My Wowza Stream Source"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the Wowza stream source. Maximum 255 characters.",
"example": "My region-based Akamai Stream Source"
}
}
}
}
},
"stream_source_wowza": {
"type": "object",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the Wowza stream source.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the Wowza stream source. Maximum 255 characters.",
"example": ""
},
"primary_url": {
"type": "string",
"description": "The origin URL where you send your source stream.",
"example": ""
},
"state": {
"type": "string",
"description": "The current state of the Wowza stream source.",
"example": "",
"enum": [
"started",
"stopped",
"error"
]
},
"stream_name": {
"type": "string",
"description": "The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was updated.",
"example": "",
"format": "date-time"
}
},
"example": {
"created_at": "2020-01-29T17:16:22.001Z",
"id": "brcndjJt",
"name": "My Wowza Stream Source",
"primary_url": "rtmp://origin.cdn.wowza.com:1935/live",
"state": "stopped",
"stream_name": "0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102",
"updated_at": "2020-01-31T07:32:43.001Z"
}
},
"wowza_stream_source_update_input": {
"type": "object",
"description": "",
"required": [
"stream_source_wowza"
],
"properties": {
"stream_source_wowza": {
"type": "object",
"title": "stream_source_wowza",
"description": "",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the Wowza stream source. Maximum 255 characters.",
"example": "My Updated Wowza Stream Source"
}
}
}
}
},
"wowza_stream_source_patch_response": {
"type": "object",
"title": "stream_source_wowza",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the Wowza stream source.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the Wowza stream source. Maximum 255 characters.",
"example": ""
},
"primary_url": {
"type": "string",
"description": "The origin URL where you send your source stream.",
"example": ""
},
"state": {
"type": "string",
"description": "The current state of the Wowza stream source.",
"example": "",
"enum": [
"started",
"stopped",
"error"
]
},
"stream_name": {
"type": "string",
"description": "The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the Wowza stream source was updated.",
"example": "",
"format": "date-time"
}
},
"example": {
"created_at": "2020-01-29T17:16:22.001Z",
"id": "brcndjJt",
"name": "My Updated Wowza Stream Source",
"primary_url": "rtmp://origin.cdn.wowza.com:1935/live",
"state": "stopped",
"stream_name": "0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102",
"updated_at": "2020-01-31T14:56:21.001Z"
}
},
"index_stream_target": {
"type": "object",
"description": "",
"title": "stream_targets",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the stream target was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the stream target. Maximum 255 characters.",
"example": ""
},
"state": {
"type": "string",
"description": "The state of the stream target.",
"example": "activated",
"enum": [
"activated",
"archived"
]
},
"type": {
"type": "string",
"description": "**custom** is an external, third-party destination and **fastly** is a Wowza CDN on Fastly target. ",
"example": "",
"enum": [
"custom",
"fastly"
]
},
"updated_at": {
"type": "string",
"description": "The date and time that the stream target was updated.",
"example": "",
"format": "date-time"
}
}
},
"stream_targets": {
"type": "object",
"description": "",
"required": [
"stream_targets"
],
"properties": {
"stream_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_stream_target"
}
}
},
"example": {
"stream_targets": [
{
"created_at": "2020-01-29T17:16:22.007Z",
"id": "qvvjyjjk",
"name": "My RTMP Stream Target",
"state": "deactivated",
"type": "wowza",
"updated_at": "2020-01-31T02:05:18.007Z"
},
{
"created_at": "2020-01-28T17:16:22.007Z",
"id": "j75mlh3v",
"name": "My HLS Push Stream Target",
"state": "activated",
"type": "custom",
"updated_at": "2020-01-31T11:02:53.007Z"
}
]
}
},
"index_custom_stream_target": {
"type": "object",
"description": "",
"title": "stream_targets_custom",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the custom stream target was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the custom stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the custom stream target. Maximum 255 characters.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the custom stream target was updated.",
"example": "",
"format": "date-time"
}
}
},
"stream_targets_custom": {
"type": "object",
"description": "",
"required": [
"stream_targets_custom"
],
"properties": {
"stream_targets_custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_custom_stream_target"
}
}
},
"example": {
"stream_targets_custom": [
{
"created_at": "2020-01-28T17:16:22.008Z",
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"updated_at": "2020-01-31T00:44:50.008Z"
},
{
"created_at": "2020-01-28T17:16:22.008Z",
"id": "ABC45lxyz",
"name": "My Second Custom Stream Target",
"updated_at": "2020-01-31T02:05:33.008Z"
}
]
}
},
"custom_stream_target_input": {
"type": "object",
"description": "",
"required": [
"stream_target_custom"
],
"properties": {
"stream_target_custom": {
"type": "object",
"title": "stream_target_custom",
"description": "",
"required": [
"name",
"primary_url",
"provider",
"stream_name"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the custom stream target. Maximum 255 characters.",
"example": "My Custom Stream Target"
},
"primary_url": {
"type": "string",
"description": "The primary RTMP ingest URL. Hostnames can't contain underscores.",
"example": "rtmp://p.ep337857.i.akamaientrypoint.net/EntryPoint"
},
"provider": {
"type": "string",
"description": "The CDN for the target.",
"example": "rtmp",
"enum": [
"akamai_cupertino",
"rtmp",
"rtmps"
]
},
"stream_name": {
"type": "string",
"description": "The name of the stream as defined in the target's ingestion settings. The protocol, host name, and path components of the stream name URL must be 255 characters or less. The query strings and parameter components of the stream name URL must be 1024 characters or less.",
"example": "c8467d50@337857"
},
"backup_url": {
"type": "string",
"description": "The backup RTMP ingest URL of the custom stream target. Not all providers or third-party CDNs provide backup URLs. Not for use with the akamai_cuptertino custom *provider*.\n\n**Note:** When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with *use_stream_target_backup_url* as **false** (the default) and once with *use_stream_target_backup_url* as **true**. See POST /transcoders/[ID]/outputs/[ID]/output_stream_targets for more information.\n\n**Example:** \"backup_url\": \"rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint\"",
"example": "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"
},
"playback_urls": {
"type": "object",
"title": "Hash of playback URLs",
"description": "Web addresses that the target uses to play streams. Available from version 1.7.\n\n**Example:** See response body sample",
"properties": {
"hls": {
"type": "string",
"description": "Web address that the target uses to play HLS streams. \"password\": \"cb1e77e98d\"",
"example": "cb1e77e98d"
},
"username": {
"type": "string",
"description": "The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.",
"example": "319699"
}
}
}
}
},
"custom_stream_target_create_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/custom_stream_target_input"
}
],
"example": {
"stream_target_custom": {
"name": "My Custom Stream Target",
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456"
}
}
},
"stream_target_custom": {
"type": "object",
"description": "",
"properties": {
"backup_url": {
"type": "string",
"description": "The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
},
"created_at": {
"type": "string",
"description": "The date and time that the custom stream target was created.",
"example": "",
"format": "date-time"
},
"delivery_protocols": {
"type": "array",
"description": "An array of the delivery protocols available for this stream target. Available from version 1.7.",
"example": "",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the custom stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the custom stream target. Maximum 255 characters.",
"example": ""
},
"password": {
"type": "string",
"description": "A *username* must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
},
"playback_urls": {
"type": "object",
"description": "Web addresses that the target uses to play streams. Available from version 1.7.",
"properties": {
"hls": {
"type": "array",
"description": "Web address that the target uses to play HLS streams.",
"items": {
"type": "object",
"title": "hls",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
},
"hds": {
"type": "array",
"description": "Web address that the target uses to play HDS streams. Not for use with the akamai_cupertino custom *provider*.",
"items": {
"type": "object",
"title": "hds",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
},
"rtmp": {
"type": "array",
"description": "Web address that the target uses to play RTMP streams.",
"items": {
"type": "object",
"title": "rtmp",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
}
}
},
"primary_url": {
"type": "string",
"description": "The primary ingest URL of the custom stream target.",
"example": ""
},
"provider": {
"type": "string",
"description": "The CDN for the target.",
"example": ""
},
"stream_name": {
"type": "string",
"description": "The name of the stream being ingested into the target.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the custom stream target was updated.",
"example": "",
"format": "date-time"
},
"username": {
"type": "string",
"description": "The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
}
},
"example": {
"created_at": "2020-01-28T17:16:22.011Z",
"delivery_protocols": [
"rtmp"
],
"id": "RMS45lfvx",
"name": "My Custom Stream Target",
"playback_urls": {
"rtmp": [
{
"name": "default",
"url": "rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"
}
]
},
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456",
"updated_at": "2020-01-30T19:14:11.011Z"
}
},
"custom_stream_target_update_input": {
"type": "object",
"description": "",
"required": [
"stream_target_custom"
],
"properties": {
"stream_target_custom": {
"type": "object",
"title": "stream_target_custom",
"description": "",
"properties": {
"backup_url": {
"type": "string",
"description": "The backup RTMP ingest URL of the custom stream target. Not all providers or third-party CDNs provide backup URLs. Not for use with the akamai_cupertino custom *provider*.\n\n**Note:** When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with *use_stream_target_backup_url* as **false** (the default) and once with *use_stream_target_backup_url* as **true**. See POST /transcoders/[ID]/outputs/[ID]/output_stream_targets for more information.\n\n**Example:** \"backup_url\": \"rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint\"",
"example": "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"
},
"name": {
"type": "string",
"description": "A descriptive name for the custom stream target. Maximum 255 characters.\n\n**Example:** \"name\": \"My Updated Custom Stream Target\"",
"example": "My Updated Custom Stream Target"
},
"password": {
"type": "string",
"description": "A *username* must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.\n\n**Note:** If you want to clear both username and password for RTMP authentication, send an empty string for both username and password fields.\n\n**Example:** \"password\": \"cb1e77e98d\"",
"example": "cb1e77e98d"
},
"playback_urls": {
"type": "object",
"title": "Hash of playback URLs",
"description": "Web addresses that the target uses to play streams. Available from version 1.7.\n\n\n**Example:** See response body sample",
"properties": {
"hls": {
"type": "string",
"description": "Web address that the target uses to play HLS streams. \"primary_url\": \"rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint\"",
"example": "rtmp://p.ep337857.i.akamaientrypoint.net/EntryPoint"
},
"provider": {
"type": "string",
"description": "The CDN for the target.\n\n**Example:** \"provider\": \"akamai_cupertino\"",
"example": "rtmp",
"enum": [
"akamai_cupertino",
"rtmp",
"rtmps"
]
},
"stream_name": {
"type": "string",
"description": "The name of the stream as defined in the target's ingestion settings. The protocol, host name, and path components of the stream name URL must be 255 characters or less. The query strings and parameter components of the stream name URL must be 1024 characters or less.\n\n**Example:** \"stream_name\": \"c8467d50@337857\"",
"example": "c8467d50@337857"
},
"username": {
"type": "string",
"description": "The username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.\n\n**Note:** If you want to clear both username and password for RTMP authentication, send an empty string for both username and password fields.\n\n**Example:** \"username\": \"319699\"",
"example": "319699"
}
},
"example": {
"name": "My Updated Custom Stream Target"
}
}
}
},
"custom_stream_target_patch_response": {
"type": "object",
"title": "stream_target_custom",
"description": "",
"properties": {
"backup_url": {
"type": "string",
"description": "The backup ingest URL for a custom stream target. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
},
"created_at": {
"type": "string",
"description": "The date and time that the custom stream target was created.",
"example": "",
"format": "date-time"
},
"delivery_protocols": {
"type": "array",
"description": "An array of the delivery protocols available for this stream target. Available from version 1.7.",
"example": "",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the custom stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the custom stream target. Maximum 255 characters.",
"example": ""
},
"password": {
"type": "string",
"description": "A *username* must be present. The password associated with the target username for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
},
"playback_urls": {
"type": "object",
"description": "Web addresses that the target uses to play streams. Available from version 1.7.",
"properties": {
"hls": {
"type": "array",
"description": "Web address that the target uses to play HLS streams.",
"items": {
"type": "object",
"title": "hls",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
},
"hds": {
"type": "array",
"description": "Web address that the target uses to play HDS streams. Not for use with the akamai_cupertino custom *provider*.",
"items": {
"type": "object",
"title": "hds",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
},
"rtmp": {
"type": "array",
"description": "Web address that the target uses to play RTMP streams.",
"items": {
"type": "object",
"title": "rtmp",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
}
}
},
"primary_url": {
"type": "string",
"description": "The primary ingest URL of the custom stream target.",
"example": ""
},
"provider": {
"type": "string",
"description": "The CDN for the target.",
"example": ""
},
"stream_name": {
"type": "string",
"description": "The name of the stream being ingested into the target.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the custom stream target was updated.",
"example": "",
"format": "date-time"
},
"username": {
"type": "string",
"description": "he username or ID that the target uses for RTMP authentication. Not for use with the akamai_cupertino custom *provider*.",
"example": ""
}
},
"example": {
"created_at": "2020-01-28T17:16:22.011Z",
"delivery_protocols": [
"rtmp"
],
"id": "RMS45lfvx",
"name": "My Updated Custom Stream Target",
"playback_urls": {
"rtmp": [
{
"name": "default",
"url": "rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321"
}
]
},
"primary_url": "rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint",
"provider": "rtmp",
"stream_name": "c8467d50@123456",
"updated_at": "2020-01-30T19:46:22.012Z"
}
},
"index_fastly_stream_target": {
"type": "object",
"description": "",
"title": "stream_targets_fastly",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the stream target was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the stream target. Maximum 255 characters.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the stream target was updated.",
"example": "",
"format": "date-time"
}
}
},
"stream_targets_fastly": {
"type": "object",
"description": "",
"required": [
"stream_targets_fastly"
],
"properties": {
"stream_targets_fastly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_fastly_stream_target"
}
}
},
"example": {
"stream_targets_fastly": [
{
"created_at": "2020-01-28T17:16:22.010Z",
"id": "abc45lfyz",
"name": "My Wowza CDN on Fastly Stream Target",
"updated_at": "2020-01-31T12:37:22.010Z"
},
{
"created_at": "2020-01-28T17:16:22.010Z",
"id": "rdm45lxyz",
"name": "My Second Wowza CDN on Fastly Stream Target",
"updated_at": "2020-01-31T14:17:28.010Z"
}
]
}
},
"stream_target_property_fastly": {
"type": "object",
"title": "property",
"description": "",
"required": [
"key",
"section",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "The key of the property.\n\nThe following table lists the available property keys.\n\nKey | Description\n----------------|-------------\n**acao** | Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request.\n**chunkSize** | Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target.\n**convertAMFData** | Determines whether Wowza Video converts incoming AMF data into ID3 tags.\n**playlistSeconds** | Defines the maximum allowable length of the playlist.\n**relativePlaylists** | Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls.",
"example": "",
"enum": [
"acao",
"chunkSize",
"convertAMFData",
"playlistSeconds",
"relativePlaylists"
]
},
"section": {
"type": "string",
"description": "The section of the stream target configuration table that contains the\nproperty.\n\n\nSection | Valid keys for the section\n----------------|-------------\n**hls** | **acao**, **chunkSize**, and **convertAMFData**\n**playlist** | **playlistSeconds** and **relativePlaylists**",
"example": "",
"enum": [
"hls",
"playlist"
]
},
"value": {
"type": "string",
"description": "\nThe value of the property.\n\nThe following table provides information about valid values for each property key.\n\nKey(s) | Values for the key\n----------------|-------------\n**acao** | Displays as **http://<_origin_>**\n**chunkSize** | Valid values are the integers **2**, **4**, **6**, **8**, and **10**.\n**convertAMFData** \"custom_origin_region\": \"us\""
},
"custom_origin_url": {
"type": "string",
"description": "The Wowza Streaming Engine instance's domain or IP address starting with http:// or https://. Available from version 1.6.\n\n**Note:** You can find the **Host - Server** address on the home page of Wowza Streaming Engine under **Application Connection Settings**."
},
"delivery_protocols": {
"type": "array",
"description": "Specifies the protocols sent to the stream target. Valid values are **hls** and **dash** (MPEG-DASH). The default is **hls**. Available from version 1.7.\n\n**Note:** If you enable more than one protocol, you'll incur egress charges for each protocol you select.\n\nSee Protect streams for Google Widevine and Microsoft PlayReady devices with EZDRM and the Wowza Video REST API for an example of setting MPEG-DASH as a delivery protocol for digital rights management (DRM) use.\n\n**Example:** See response body sample",
"items": {
"type": "string",
"properties": {
"hls": {
"type": "string",
"description": "Sends an HLS stream to the stream target."
},
"dash": {
"type": "string",
"description": "Sends a MPEG-DASH stream to the target."
}
}
}
},
"force_ssl_playback": {
"type": "boolean",
"description": "If **true**, requires users to play the stream over HTTPS. If **false**, the default, users can play the stream over HTTPS or HTTP.\n\n**Example:** \"force_ssl_playback\": true",
"example": ""
},
"geoblock_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific locations and, optionally, IP addresses. The default is **false**.\n\n**Example:** \"geoblock_enabled\": true",
"example": ""
},
"geoblock_by_location": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific locations. The default is **disabled**.\n\n**Example:** \"geoblock_location\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_country_codes": {
"type": "string",
"description": "Required when *geoblock_by_location* is **allow** or **deny**. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.\n\n**Example:** \"geoblock_country_codes\": \"CA, DE\"",
"example": ""
},
"geoblock_ip_override": {
"type": "string",
"description": "Specifies whether specific IP addresses can override the locations that are allowed or restricted. **allow** permits access from IP addresses within a location that's been blocked, while **deny** restricts access from IP addresses within locations that are allowed. The default is **disabled**.\n\n**Example:** \"geoblock_ip_override\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_ip_addresses": {
"type": "string",
"description": "Required when *geoblock_ip_override* is **allow** or **deny**. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of up to about 40 IPv4 and IPv6 IP addresses that always allow or deny streaming based on the *geoblock_ip_override* value. \n\nTroubleshooting: The limit of 40 IP addresses is approximate because all the security information (SSL playback, geoblocking countries and IP addresses, referer header, and token auth) count toward an overall metadata limit. If you have fewer than 40 IP addresses and still receive a 422: Invalid Record (Geoblock IP addresses) error, see Geo-block Wowza CDN on Fastly stream targets with the Wowza Video REST API for more ways to lower the character count.\n\n**Example:**
\"geoblock_ip_addresses\": \"77.12.34.567, 78.23.45.678\"",
"example": ""
},
"properties": {
"type": "array",
"description": "Configures one or more stream target properties. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in. Available from version 1.7.\n\n**Example:** See response body sample",
"items": {
"$ref": "#/components/schemas/stream_target_property_fastly"
}
},
"referer_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is **false**.\n\n**Note:** If you change *referer_enabled* to **false** after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well.\n\nAvailable from version 1.7.\n\nFor more information about the Referer header, see the [HTTP specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).\n\n**Example:** \"referer_enabled\": true",
"example": ""
},
"referer_allow_empty": {
"type": "boolean",
"description": "The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is **false** when *referer_enabled* is **true**. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify **true** to allow an empty Referer header so those viewers can still access the stream.\n\nAvailable from version 1.7.\n\n**Example:** \"referer_allow_empty\": true",
"example": ""
},
"referer_policy": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific domains. The default is **allow** when *referer_enabled* is **true**. Specify the domains to allow or deny in *referer_domains*.\n\nAvailable from version 1.7.\n\n**Example:** \"referer_policy\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny"
]
},
"referer_domains": {
"type": "string",
"description": "Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the *referer_policy* value. Required when *referer_enabled* is **true**.\n\nWe recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (_mysubdomain.example.com_) to specify that single, specific subdomain or you can use a wildcard (*) to cover all subdomains at a specific level (_*.example.com_).\n\n**Example:** _example.com, *.example.com, *.mysubdomain.example.com_\n\nIf you entered the above example value for *referer_domains*, and *referer_policy* is **allow**, the following domains are allowed access to the stream: \"referer_domains\": \"example.com, example2.com\"",
"example": ""
},
"token_auth_enabled": {
"type": "boolean",
"description": "If **true**, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is **false**.\n\n**Example:** \"token_auth_enabled\": true",
"example": ""
},
"token_auth_shared_secret": {
"type": "string",
"description": "The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.\n\n**Example:** \"token_auth_shared_secret\": \"12345678ABCDEF\"",
"example": ""
},
"token_auth_playlist_only": {
"type": "boolean",
"description": "If **true**, Wowza Video uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the *withCredentials* property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is **false**.\n\n**Note**: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.\n\n**Example:** \"token_auth_playlist_only\": true",
"example": ""
}
}
}
}
},
"fastly_stream_target_create_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/fastly_stream_target_input"
}
],
"example": {
"stream_target_fastly": {
"name": "My Wowza CDN on Fastly Stream Target"
}
}
},
"stream_target_fastly": {
"type": "object",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the stream target was created.",
"example": "",
"format": "date-time"
},
"custom_origin_region": {
"type": "string",
"description": "The region where your Wowza Streaming Engine instance is located. Available from version 1.6.",
"example": "",
"format": "string"
},
"custom_origin_url": {
"type": "string",
"description": "The Wowza Streaming Engine instance's domain or IP address. Available from version 1.6.",
"example": "",
"format": "string"
},
"delivery_protocols": {
"type": "array",
"description": "An array of the delivery protocols available for this stream target. Available from version 1.7.",
"example": "",
"items": {
"type": "string"
}
},
"force_ssl_playback": {
"type": "boolean",
"description": "If **true**, requires users to play the stream over HTTPS. If **false**, the default, users can play the stream over HTTPS or HTTP.",
"example": ""
},
"geoblock_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific locations and, optionally, IP addresses. The default is **false**.",
"example": ""
},
"geoblock_by_location": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific locations. The default is **disabled**.",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_country_codes": {
"type": "string",
"description": "Required when *geoblock_by_location* is **allow** or **deny**. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.",
"example": ""
},
"geoblock_ip_override": {
"type": "string",
"description": "Specifies whether specific IP addresses can override the locations that are allowed or restricted. **allow** permits access from IP addresses within a location that's been blocked, while **deny** restricts access from IP addresses within locations that are allowed. The default is **disabled**.",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_ip_addresses": {
"type": "string",
"description": "Required when *geoblock_ip_override* is **allow** or **deny**. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the *geoblock_ip_override* value.",
"example": ""
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the stream target. Maximum 255 characters.",
"example": ""
},
"playback_urls": {
"type": "object",
"description": "Web addresses that the target uses to play streams.",
"properties": {
"hls": {
"type": "array",
"description": "Web address that the target uses to play HLS streams.",
"items": {
"type": "object",
"title": "hls",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
}
}
},
"state": {
"type": "string",
"description": "The state of the stream target.",
"example": "",
"enum": [
"activated",
"archived"
]
},
"stream_name": {
"type": "string",
"description": "The name of the stream being ingested into the target.",
"example": ""
},
"referer_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is **false**.\n\n**Note:** If you change *referer_enabled* to **false** after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well.\nAvailable from version 1.7. For more information about the Referer header, see the [HTTP specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).",
"example": ""
},
"referer_allow_empty": {
"type": "boolean",
"description": "The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is **false** when *referer_enabled* is **true**. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify **true** to allow an empty Referer header so those viewers can still access the stream.\n\nAvailable from version 1.7.",
"example": ""
},
"referer_policy": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific domains. The default is **allow** when *referer_enabled* is **true**. Specify the domains to allow or deny in *referer_domains*.\n\nAvailable from version 1.7.",
"example": "",
"enum": [
"allow",
"deny"
]
},
"referer_domains": {
"type": "string",
"description": "Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the *referer_policy* value. Required when *referer_enabled* is **true**.\n\nWe recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (_mysubdomain.example.com_) to specify that single, specific subdomain or you can use a wildcard (*) to cover all subdomains at a specific level (_*.example.com_).\n\n**Example:** _example.com, *.example.com, *.mysubdomain.example.com_\n\nIf you entered the above example value for *referer_domains*, and *referer_policy* is **allow**, the following domains are allowed access to the stream: \"name\": \"My Updated Fastly Stream Target\"",
"example": "My Updated Fastly Stream Target"
},
"custom_origin_region": {
"type": "string",
"description": "The region where your Wowza Streaming Engine instance is located. Available from version 1.6.\n\nValid values:\n * **us** - United States\n * **eu** - Europe\n * **asia** - Asia\n * **sa** - South America\n * **india** - India\n\n\n**Example:** \"custom_origin_region\": \"us\""
},
"custom_origin_url": {
"type": "string",
"description": "The Wowza Streaming Engine instance's domain or IP address starting with http:// or https://. Available from version 1.6.\n\n**Note:** You can find the **Host - Server** address on the home page of Wowza Streaming Engine under **Application Connection Settings**."
},
"delivery_protocols": {
"type": "array",
"description": "Specifies the protocols sent to the stream target. Valid values are **hls** and **dash** (MPEG-DASH). The default is **hls**. Available from version 1.7.\n\n**Note:** If you enable more than one protocol, you'll incur egress charges for each protocol you select.\n\nSee Protect streams for Google Widevine and Microsoft PlayReady devices with EZDRM and the Wowza Video REST API for an example of setting MPEG-DASH as a delivery protocol for digital rights management (DRM) use.\n\n**Example:** See response body sample",
"items": {
"type": "string",
"properties": {
"hls": {
"type": "string",
"description": "Sends an HLS stream to the stream target."
},
"dash": {
"type": "string",
"description": "Sends a MPEG-DASH stream to the target."
}
}
}
},
"force_ssl_playback": {
"type": "boolean",
"description": "If **true**, requires users to play the stream over HTTPS. If **false**, the default, users can play the stream over HTTPS or HTTP.\n\n**Example:** \"force_ssl_playback\": true",
"example": ""
},
"geoblock_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific locations and, optionally, IP addresses. The default is **false**.\n\n**Example:** \"geoblock_enabled\": true",
"example": ""
},
"geoblock_by_location": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific locations. The default is **disabled**.\n\n**Example:** \"geoblock_location\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_country_codes": {
"type": "string",
"description": "Required when *geoblock_by_location* is **allow** or **deny**. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.\n\n**Example:** \"geoblock_country_codes\": \"CA, DE\"",
"example": ""
},
"geoblock_ip_override": {
"type": "string",
"description": "Specifies whether specific IP addresses can override the locations that are allowed or restricted. **allow** permits access from IP addresses within a location that's been blocked, while **deny** restricts access from IP addresses within locations that are allowed. The default is **disabled**.\n\n**Example:** \"geoblock_ip_override\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_ip_addresses": {
"type": "string",
"description": "Required when *geoblock_ip_override* is **allow** or **deny**. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of up to about 40 IPv4 and IPv6 IP addresses that always allow or deny streaming based on the *geoblock_ip_override* value.\n\nTroubleshooting: The limit of 40 IP addresses is approximate because all the security information (SSL playback, geoblocking countries and IP addresses, referer header, and token auth) count toward an overall metadata limit. If you have fewer than 40 IP addresses and still receive a 422: Invalid Record (Geoblock IP addresses) error, see Geo-block Wowza CDN on Fastly stream targets with the Wowza Video REST API for more ways to lower the character count.\n\n**Example:**
\"geoblock_ip_addresses\": \"77.12.34.567, 78.23.45.678\"",
"example": ""
},
"properties": {
"type": "array",
"description": "Configures one or more stream target properties. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in. Available from version 1.7.\n\n**Example:** See response body sample",
"items": {
"$ref": "#/components/schemas/stream_target_property_fastly"
}
},
"referer_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is **false**.\n\n**Note:** If you change *referer_enabled* to **false** after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well.\n\nAvailable from version 1.7. For more information about the Referer header, see the [HTTP specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).\n\n**Example:** \"referer_enabled\": true",
"example": ""
},
"referer_allow_empty": {
"type": "boolean",
"description": "The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is **false** when *referer_enabled* is **true**. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify **true** to allow an empty Referer header so those viewers can still access the stream.\n\nAvailable from version 1.7.\n\n**Example:** \"referer_allow_empty\": true",
"example": ""
},
"referer_policy": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific domains. The default is **allow** when *referer_enabled* is **true**. Specify the domains to allow or deny in *referer_domains*.\n\nAvailable from version 1.7.\n\n**Example:** \"referer_policy\": \"allow\"",
"example": "",
"enum": [
"allow",
"deny"
]
},
"referer_domains": {
"type": "string",
"description": "Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the *referer_policy* value. Required when *referer_enabled* is **true**.\n\nWe recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (_mysubdomain.example.com_) to specify that single, specific subdomain or you can use a wildcard (*) to cover all subdomains at a specific level (_*.example.com_).\n\n**Example:** _example.com, *.example.com, *.mysubdomain.example.com_\n\nIf you entered the above example value for *referer_domains*, and *referer_policy* is **allow**, the following domains are allowed access to the stream: \"referer_domains\": \"example.com, example2.com\"",
"example": ""
},
"token_auth_enabled": {
"type": "boolean",
"description": "If **true**, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is **false**.\n\n**Example:** \"token_auth_enabled\": true",
"example": ""
},
"token_auth_shared_secret": {
"type": "string",
"description": "The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32.\n\n**Example:** \"token_auth_shared_secret\": \"12345678ABCDEF\"",
"example": ""
},
"token_auth_playlist_only": {
"type": "boolean",
"description": "If **true**, Wowza Video uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the *withCredentials* property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is **false**.\n\n**Note**: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.\n\n**Example:** \"token_auth_playlist_only\": true",
"example": ""
}
},
"example": {
"name": "My Updated Wowza CDN on Fastly Stream Target"
}
}
}
},
"fastly_stream_target_patch_response": {
"type": "object",
"title": "stream_target_fastly",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the stream target was created.",
"example": "",
"format": "date-time"
},
"custom_origin_region": {
"type": "string",
"description": "The region where your Wowza Streaming Engine instance is located. Available from version 1.6.",
"example": "",
"format": "string"
},
"custom_origin_url": {
"type": "string",
"description": "The Wowza Streaming Engine instance's domain or IP address. Available from version 1.6.",
"example": "",
"format": "string"
},
"delivery_protocols": {
"type": "array",
"description": "An array of the delivery protocols available for this stream target. Available from version 1.7.",
"example": "",
"items": {
"type": "string"
}
},
"force_ssl_playback": {
"type": "boolean",
"description": "If **true**, requires users to play the stream over HTTPS. If **false**, the default, users can play the stream over HTTPS or HTTP.",
"example": ""
},
"geoblock_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific locations and, optionally, IP addresses. The default is **false**.",
"example": ""
},
"geoblock_by_location": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific locations. The default is **disabled**.",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_country_codes": {
"type": "string",
"description": "Required when *geoblock_by_location* is **allow** or **deny**. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.",
"example": ""
},
"geoblock_ip_override": {
"type": "string",
"description": "Specifies whether specific IP addresses can override the locations that are allowed or restricted. **allow** permits access from IP addresses within a location that's been blocked, while **deny** restricts access from IP addresses within locations that are allowed. The default is **disabled**.",
"example": "",
"enum": [
"allow",
"deny",
"disabled"
]
},
"geoblock_ip_addresses": {
"type": "string",
"description": "Required when *geoblock_ip_override* is **allow** or **deny**. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the *geoblock_ip_override* value.",
"example": ""
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the stream target. Maximum 255 characters.",
"example": ""
},
"playback_urls": {
"type": "object",
"description": "Web addresses that the target uses to play streams.",
"properties": {
"hls": {
"type": "array",
"description": "Web address that the target uses to play HLS streams.",
"items": {
"type": "object",
"title": "hls",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL.",
"example": "default"
},
"url": {
"type": "string",
"description": "The playback URL.",
"example": ""
}
}
}
}
}
},
"referer_enabled": {
"type": "boolean",
"description": "If **true**, controls access to the stream from specific domains. The client or player requesting access to the stream must send the Referer header so the origin of the request can be validated. The default is **false**.\n\n**Note:** If you change *referer_enabled* to **false** after configuring the referer policy, then later re-enable it, you'll need to re-configure the other referer policy values as well.\n\nAvailable from version 1.7. For more information about the Referer header, see the [HTTP specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).",
"example": ""
},
"referer_allow_empty": {
"type": "boolean",
"description": "The Referer header sent by the client or player can be empty and not identify the origin of the request. The default is **false** when *referer_enabled* is **true**. While less secure, if you know you'll have viewers with a client or player that won't send a Referer header, you can specify **true** to allow an empty Referer header so those viewers can still access the stream.\n\nAvailable from version 1.7.",
"example": ""
},
"referer_policy": {
"type": "string",
"description": "Specifies whether to **allow** or **deny** access to the stream from specific domains. The default is **allow** when *referer_enabled* is **true**. Specify the domains to allow or deny in *referer_domains*.\n\nAvailable from version 1.7.",
"example": "",
"enum": [
"allow",
"deny"
]
},
"referer_domains": {
"type": "string",
"description": "Domains that are either allowed or blocked from accessing the stream. Enter a comma-separated list of domains that are always allowed or denied access based on the *referer_policy* value. Required when *referer_enabled* is **true**.\n\nWe recommend you enter the simplest form of the domain as possible, but you do need to build out the domain to the level of subdomains you want to allow or deny. You can fully express to the subdomain (_mysubdomain.example.com_) to specify that single, specific subdomain or you can use a wildcard (*) to cover all subdomains at a specific level (_*.example.com_).\n\n**Example:** _example.com, *.example.com, *.mysubdomain.example.com_\n\nIf you entered the above example value for *referer_domains*, and *referer_policy* is **allow**, the following domains are allowed access to the stream: \"buffer_size\": 4000",
"example": "",
"enum": [
0,
1000,
2000,
3000,
4000,
5000,
6000,
7000,
8000
],
"format": "int32"
},
"closed_caption_type": {
"type": "string",
"description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.\n\n**Example:** \"closed_caption_type\": \"cea\"",
"example": "",
"enum": [
"none",
"cea",
"on_text",
"both"
]
},
"delivery_protocols": {
"type": "array",
"description": "An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, and **wowz** are returned.\n\n**Example:** See response body sample ",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "An optional description of the transcoder.\n\n**Example:** \"description\": \"This transcoder runs our 24/7 stream.\"",
"example": ""
},
"disable_authentication": {
"type": "boolean",
"description": "Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source.\n\n**Example:** \"disable_authentication\": false",
"example": ""
},
"idle_timeout": {
"type": "integer",
"description": "The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes).\n\n**Example:** \"idle_timeout\": 1600",
"example": "",
"format": "int32"
},
"low_latency": {
"type": "boolean",
"description": "If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**.\n\n**Example:** \"low_latency\": false",
"example": ""
},
"password": {
"type": "string",
"description": "A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"password\": 68332313",
"example": ""
},
"play_maximum_connections": {
"type": "integer",
"description": "The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.\n\n**Example:** \"play_maximum_connections\": 30",
"example": "",
"format": "int32"
},
"properties": {
"type": "array",
"description": "An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.\n\nAvailable from version 1.5.\n\n**Example:** See response body sample",
"items": {
"$ref": "#/components/schemas/transcoder_property"
}
},
"reference_id": {
"type": "string",
"description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.\n\n**Example:** \"reference_id\": \"mySystemID_01\"",
"example": ""
},
"source_url": {
"type": "string",
"description": "For the *delivery_method* **pull** or *protocol* **file**.\n\nFor **pull**, enter the source's web address without the protocol or the trailing slash (/).\n\nFor **file**, enter the source file URL, including the protocol (http, https, gs, s3).\n\n\n**Example:** \"source_url\": \"xyz.streamlock.net/vod/mp4:Movie.mov\"",
"example": ""
},
"stream_extension": {
"type": "string",
"description": "For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.\n\n**Example:** \"stream_extension\": \".sdp\"",
"example": ""
},
"stream_smoother": {
"type": "boolean",
"description": "A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify **true** to enable stream smoothing. The default is **false**.\n\n**Example:** \"stream_smoother\": false",
"example": ""
},
"stream_source_id": {
"type": "string",
"description": "For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.\n\n**Example:** \"stream_source_id\": \"rxHQQpWw\"",
"example": ""
},
"suppress_stream_target_start": {
"type": "boolean",
"description": "If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts.\n\n**Example:** \"suppress_stream_target_start\": false",
"example": ""
},
"username": {
"type": "string",
"description": "A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"username\": \"client2\"",
"example": ""
},
"watermark": {
"type": "boolean",
"description": "Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image.\n\n\n**Example:** \"watermark\": true",
"example": ""
},
"watermark_height": {
"type": "integer",
"description": "The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.\n\n**Example:** \"watermark_height\": 80",
"example": "",
"format": "int32"
},
"watermark_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.\n\n**Example:** \"watermark_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": ""
},
"watermark_opacity": {
"type": "integer",
"description": "The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque.\n\n**Example:** \"watermark_opacity\": 75",
"example": "",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100
],
"format": "int32"
},
"watermark_position": {
"type": "string",
"description": "The corner of the video frame in which you want the watermark to appear. The default is **top-left**.\n\n**Example:** \"watermark_position\": \"top-left\"",
"example": "",
"enum": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
]
},
"watermark_width": {
"type": "integer",
"description": "The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.\n\n**Example:** \"watermark_width\": 100",
"example": "",
"format": "int32"
}
}
}
},
"example": {
"transcoder": {
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"delivery_method": "pull",
"name": "My PAYG Transcoder",
"protocol": "rtmp",
"transcoder_type": "transcoded"
}
}
},
"output_stream_target": {
"type": "object",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the output stream target was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the output stream target.",
"example": ""
},
"stream_target": {
"$ref": "#/components/schemas/index_stream_target"
},
"stream_target_id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the output stream target was updated.",
"example": "",
"format": "date-time"
},
"use_stream_target_backup_url": {
"type": "boolean",
"description": "Specifies whether the output stream target uses the stream target's primary or backup URL.",
"example": ""
}
},
"example": {
"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": true,
"stream_target": {
"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T04:06:40.965Z"
}
}
},
"output": {
"type": "object",
"description": "",
"properties": {
"aspect_ratio_height": {
"type": "integer",
"description": "The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1080**. Combined with **aspect_ratio_width**, makes up the input resolution.",
"example": "",
"format": "int32"
},
"aspect_ratio_width": {
"type": "integer",
"description": "The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1920**. Combined with **aspect_ratio_height**, makes up the input resolution.",
"example": "",
"format": "int32"
},
"bitrate_audio": {
"type": "integer",
"description": "The audio bitrate, in kilobits per second (Kbps). Must be between **1** and **9999**. If the **audio_codec** is **opus**, the default is **510**, otherwise the default is **128**.",
"example": "",
"format": "int32"
},
"bitrate_video": {
"type": "integer",
"description": "The video bitrate, in kilobits per second (Kbps). Must be between **1** and **10240**. The default is **4000**.",
"example": "",
"format": "int32"
},
"created_at": {
"type": "string",
"description": "The date and time that the output rendition was created.",
"example": "",
"format": "date-time"
},
"framerate_reduction": {
"type": "string",
"description": "Reduce the frame rate of the transcoded output rendition. The default, **0**, uses the encoded stream's frame rate without reduction.",
"example": "",
"enum": [
"0",
"1/2",
"1/4",
"1/25",
"1/30",
"1/50",
"1/60"
]
},
"h264_profile": {
"type": "string",
"description": "The encoding method. Specify **main** for desktop streaming, **baseline** for playback on mobile devices, or **high** for HD playback. The default is **high**.",
"example": "",
"enum": [
"main",
"baseline",
"high"
]
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the output rendition.",
"example": ""
},
"keyframes": {
"type": "string",
"description": "The interval used to define the compression applied to a group of frames. The default, **follow_source**, uses the keyframe interval of the source video.",
"example": "",
"enum": [
"follow_source",
"25",
"30",
"50",
"60",
"100",
"120"
]
},
"name": {
"type": "string",
"description": "A descriptive name for the output (generated, not writable).",
"example": ""
},
"output_stream_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/output_stream_target"
}
},
"video_codec": {
"type": "string",
"description": "The codec used to encode the video stream. **disabled** sends the stream without a video track and **passthrough** sends the stream without transcoding the video track. Available from version 1.6.",
"example": "",
"enum": [
"h264",
"passthrough",
"disabled"
]
},
"audio_codec": {
"type": "string",
"description": "The codec used to encode the audio stream. **disabled** sends the stream without an audio track and **passthrough** sends the stream without transcoding the audio track. **aac** is the most commonly compatible audio codec for protocols, while **opus** is for WebRTC streams. Available from version 1.6.",
"example": "",
"enum": [
"aac",
"opus",
"passthrough",
"disabled"
]
},
"transcoder_id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the transcoder.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the output rendition was updated.",
"example": "",
"format": "date-time"
}
},
"example": {
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.964Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [
{}
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T13:47:33.964Z"
}
},
"transcoder": {
"type": "object",
"description": "",
"properties": {
"application_name": {
"type": "string",
"description": "The application name from the pull stream source URL.",
"example": ""
},
"asset_id": {
"type": "string",
"description": "Only applies to the transcoder of a live stream created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management."
},
"billing_mode": {
"type": "string",
"description": "The billing mode for the transcoder. The default is **pay_as_you_go**.\n\n\n \n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n \n\n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.",
"example": "",
"enum": [
"pay_as_you_go",
"twentyfour_seven"
]
},
"broadcast_location": {
"type": "string",
"description": "The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.",
"example": "",
"enum": [
"asia_pacific_australia",
"asia_pacific_india",
"asia_pacific_japan",
"asia_pacific_singapore",
"asia_pacific_s_korea",
"asia_pacific_taiwan",
"eu_belgium",
"eu_germany",
"eu_ireland",
"south_america_brazil",
"us_central_iowa",
"us_east_s_carolina",
"us_east_virginia",
"us_west_california",
"us_west_oregon"
]
},
"buffer_size": {
"type": "integer",
"description": "The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds).",
"example": "",
"enum": [
0,
1000,
2000,
3000,
4000,
5000,
6000,
7000,
8000
],
"format": "int32"
},
"closed_caption_type": {
"type": "string",
"description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.",
"example": "",
"enum": [
"none",
"cea",
"on_text",
"both"
]
},
"created_at": {
"type": "string",
"description": "The date and time that the transcoder was created.",
"example": "",
"format": "date-time"
},
"delivery_method": {
"type": "string",
"description": "The type of connection between the source encoder and the transcoder. The default, **pull**, instructs the transcoder to pull the video from the source. **push** instructs the source to push the stream to the transcoder. **cdn** uses a stream source to deliver the stream to the transcoder.",
"example": "",
"enum": [
"pull",
"cdn",
"push"
]
},
"delivery_protocols": {
"type": "array",
"description": "An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are returned.",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "An optional description of the transcoder.",
"example": ""
},
"direct_playback_urls": {
"type": "object",
"description": "A list of direct playback URLs for the transcoder's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.",
"properties": {
"delivery_protocol": {
"type": "array",
"description": "The name of the direct playback protocol.",
"items": {
"type": "object",
"title": "direct_playback_url",
"properties": {
"name": {
"type": "string",
"description": "The name of the playback URL: **source**, **default**, or the output rendition's resolution.",
"example": ""
},
"output_id": {
"type": "string",
"description": "Only for output rendition-based playback URLs, not source playback URLs. The unique alphanumeric string that identifies the output rendition.",
"example": "dcxq5q6c"
},
"url": {
"type": "string",
"description": "The playback URL for the source or output rendition.",
"example": "https://abcdef.dev.entrypoint.video.wowza.com/app-B8P6K226/ngrp:43a23e5a_all/playlist.m3u8"
},
"application_name": {
"type": "string",
"description": "(WebRTC only) The application name for the WebRTC output.",
"example": ""
},
"stream_name": {
"type": "string",
"description": "(WebRTC only) The stream name for the WebRTC output rendition.",
"example": ""
}
}
}
}
}
},
"disable_authentication": {
"type": "boolean",
"description": "Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source.",
"example": ""
},
"domain_name": {
"type": "string",
"description": "The domain name from the pull stream source URL.",
"example": ""
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the transcoder.",
"example": ""
},
"idle_timeout": {
"type": "integer",
"description": "The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes).",
"example": "",
"format": "int32"
},
"low_latency": {
"type": "boolean",
"description": "If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the transcoder. Maximum 200 characters.",
"example": ""
},
"outputs": {
"type": "array",
"description": "Output renditions associated with the transcoder.",
"items": {
"$ref": "#/components/schemas/output"
}
},
"password": {
"type": "string",
"description": "A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.",
"example": ""
},
"playback_stream_name": {
"type": "string",
"description": "The stream name used in the direct playback URL.",
"example": ""
},
"play_maximum_connections": {
"type": "integer",
"description": "The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.",
"example": "",
"format": "int32"
},
"protocol": {
"type": "string",
"description": "The transport protocol for the source video. The default is **rtmp**.",
"example": "",
"enum": [
"file",
"rtmp",
"rtsp",
"srt",
"udp",
"webrtc"
]
},
"reference_id": {
"type": "string",
"description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.",
"example": ""
},
"source_port": {
"type": "integer",
"description": "The port used for RTMP pull connections to Wowza Video.",
"example": "",
"format": "int32"
},
"source_url": {
"type": "string",
"description": "For the *delivery_method* **pull** or *protocol* **file**.\n\nFor **pull**, enter the source's web address without the preceding protocol or the trailing slash (/).\n\nFor **file**, enter the source file URL, including the protocol (http, https, gs, s3).",
"example": ""
},
"stream_extension": {
"type": "string",
"description": "For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.",
"example": ""
},
"stream_name": {
"type": "string",
"description": "The stream name from the pull stream source URL.",
"example": ""
},
"stream_smoother": {
"type": "boolean",
"description": "A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify **true** to enable stream smoothing. The default is **false**.",
"example": ""
},
"stream_source_id": {
"type": "string",
"description": "For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.",
"example": ""
},
"suppress_stream_target_start": {
"type": "boolean",
"description": "If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts.",
"example": ""
},
"transcoder_type": {
"type": "string",
"description": "The type of transcoder, either **transcoded** for streams that are transcoded into adaptive bitrate renditions or **passthrough** for streams that aren't processed by the transcoder. The default is **transcoded**.",
"example": "",
"enum": [
"transcoded",
"passthrough"
]
},
"updated_at": {
"type": "string",
"description": "The date and time that the transcoder was updated.",
"example": "",
"format": "date-time"
},
"username": {
"type": "string",
"description": "A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.",
"example": ""
},
"watermark": {
"type": "boolean",
"description": "Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image.",
"example": ""
},
"watermark_height": {
"type": "integer",
"description": "The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.",
"example": "",
"format": "int32"
},
"watermark_image_url": {
"type": "string",
"description": "The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.",
"example": ""
},
"watermark_opacity": {
"type": "integer",
"description": "The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque.",
"example": "",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100
],
"format": "int32"
},
"watermark_position": {
"type": "string",
"description": "The corner of the video frame in which you want the watermark to appear. The default is **top-left**.",
"example": "",
"enum": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
]
},
"watermark_width": {
"type": "integer",
"description": "The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.",
"example": "",
"format": "int32"
}
},
"example": {
"application_name": "app-B8P6K226",
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"buffer_size": 4000,
"closed_caption_type": "cea",
"created_at": "2020-01-28T17:16:22.098Z",
"delivery_method": "push",
"delivery_protocols": [
"rtmp",
"rtsp",
"wowz",
"webrtc"
],
"description": "My Transcoder Description",
"direct_playback_urls": {
"rtmp": [
{
"name": "source",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"
},
{
"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{
"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{
"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{
"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{
"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{
"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [
{
"name": "source",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{
"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{
"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{
"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{
"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{
"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{
"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [
{
"name": "source",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{
"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{
"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{
"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{
"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{
"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{
"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [
{
"name": "source",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{
"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream1"
},
{
"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream2"
},
{
"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream3"
},
{
"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream4"
},
{
"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream5"
},
{
"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"disable_authentication": false,
"domain_name": "f92334.entrypoint.video.wowza.com",
"id": "2lsWj3F9",
"idle_timeout": 1200,
"low_latency": false,
"name": "My PAYG Transcoder",
"outputs": [
{}
],
"password": "82e0e971",
"playback_stream_name": "wxyz6789",
"play_maximum_connections": 20,
"properties": [
{
"key": "fitMode",
"section": "output",
"value": "letterbox"
},
{
"key": "rtpIgnoreProfileLevelId",
"section": "rtsp",
"value": true
}
],
"protocol": "rtmp",
"reference_id": "mySystemID_01",
"source_port": 1935,
"stream_extension": ".sdp",
"stream_name": "10eb0ed8",
"stream_smoother": false,
"suppress_stream_target_start": false,
"transcoder_type": "transcoded",
"updated_at": "2020-01-31T15:46:50.098Z",
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg",
"watermark_opacity": 75,
"watermark_position": "top-right",
"watermark_width": 100
}
},
"transcoder_update_input": {
"type": "object",
"description": "",
"required": [
"transcoder"
],
"properties": {
"transcoder": {
"type": "object",
"title": "transcoder",
"description": "",
"properties": {
"delivery_method": {
"type": "string",
"description": "The type of connection between the source encoder and the transcoder. The default, **pull**, instructs the transcoder to pull the video from the source. **push** instructs the source to push the stream to the transcoder. **cdn** uses a stream source to deliver the stream to the transcoder.\n\n**Example:** \"delivery_method\": \"pull\"",
"example": "",
"enum": [
"pull",
"cdn",
"push"
]
},
"name": {
"type": "string",
"description": "A descriptive name for the transcoder. Maximum 200 characters.\n\n**Example:** \"name\": \"My Updated Transcoder\"",
"example": ""
},
"protocol": {
"type": "string",
"description": "The transport protocol for the source video. The default is **rtmp**.\n\n**Example:** \"protocol\": \"webrtc\"",
"example": "",
"enum": [
"file",
"rtmp",
"rtsp",
"srt",
"udp",
"webrtc"
]
},
"broadcast_location": {
"type": "string",
"description": "The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.\n\n**Example:** \"broadcast_location\": \"us_central_iowa\"",
"example": "",
"enum": [
"asia_pacific_australia",
"asia_pacific_india",
"asia_pacific_japan",
"asia_pacific_singapore",
"asia_pacific_s_korea",
"asia_pacific_taiwan",
"eu_belgium",
"eu_germany",
"eu_ireland",
"south_america_brazil",
"us_central_iowa",
"us_east_s_carolina",
"us_east_virginia",
"us_west_california",
"us_west_oregon"
]
},
"buffer_size": {
"type": "integer",
"description": "The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds).\n\n**Example:** \"buffer_size\": 4000",
"example": "",
"enum": [
0,
1000,
2000,
3000,
4000,
5000,
6000,
7000,
8000
],
"format": "int32"
},
"closed_caption_type": {
"type": "string",
"description": "The type of closed caption data being passed from the source. The default, **none**, indicates that no data is being provided. **cea** indicates that a CEA closed captioning data stream is being provided. **on_text** indicates that an onTextData closed captioning data stream is being provided. **both** indicates that both CEA and onTextData closed captioning data streams are being provided.\n\n**Example:** \"closed_caption_type\": \"cea\"",
"example": "",
"enum": [
"none",
"cea",
"on_text",
"both"
]
},
"delivery_protocols": {
"type": "array",
"description": "An array of playback protocols enabled for this transcoder. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are returned.\n\n**Example:** See response body sample ",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "An optional description of the transcoder.\n\n**Example:** \"description\": \"This transcoder runs our 24/7 stream.\"",
"example": ""
},
"disable_authentication": {
"type": "boolean",
"description": "Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify **true** to disable authentication with the video source.\n\n**Example:** \"disable_authentication\": false",
"example": ""
},
"idle_timeout": {
"type": "integer",
"description": "The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers **0** (never shuts down) to **172800** (48 hours). The default is **1200** (20 minutes).\n\n**Example:** \"idle_timeout\": 1600",
"example": "",
"format": "int32"
},
"low_latency": {
"type": "boolean",
"description": "If **true**, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is **false**.\n\n**Example:** \"low_latency\": false",
"example": ""
},
"password": {
"type": "string",
"description": "A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n**Example:** \"password\": 68332313",
"example": ""
},
"play_maximum_connections": {
"type": "integer",
"description": "The number of users who are allowed to connect directly to the transcoder. The minimum and default value is **10**. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.\n\n**Example:** \"play_maximum_connections\": 30",
"example": "",
"format": "int32"
},
"properties": {
"type": "array",
"description": "An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.\n\nAvailable from version 1.5.\n\n**Example:** See response body sample",
"items": {
"$ref": "#/components/schemas/transcoder_property"
}
},
"reference_id": {
"type": "string",
"description": "A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|\n\nYou can't use brackets or quotation marks.\n\nSee Wowza Video Webhook Event Reference Documentation to learn about webhooks.\n\nAvailable from version 1.7.\n\n**Example:** \"reference_id\": \"mySystemID_01\"",
"example": ""
},
"remove_watermark_image": {
"type": "boolean",
"description": "If **true**, removes the watermark from the output. The default is **false**.\n\n**Example:** \"remove_watermark_image\": true",
"example": ""
},
"source_url": {
"type": "string",
"description": "For the *delivery_method* **pull** or *protocol* **file**.\n\nFor **pull**, enter the source's web address without the protocol or the trailing slash (/).\n\nFor **file**, enter the source file URL, including the protocol (http, https, gs, s3).\n\n\n**Example:** \"source_url\": \"xyz.streamlock.net/vod/mp4:Movie.mov\"",
"example": ""
},
"stream_extension": {
"type": "string",
"description": "For the *delivery_method* **push**. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.\n\n**Example:** \"stream_extension\": \".sdp\"",
"example": ""
},
"stream_smoother": {
"type": "boolean",
"description": "A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify **true** to enable stream smoothing. The default is **false**.\n\n**Example:** \"stream_smoother\": false",
"example": ""
},
"stream_source_id": {
"type": "string",
"description": "For the *delivery_method* **cdn**. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.\n\n**Example:** \"stream_source_id\": \"rxHQQpWw\"",
"example": ""
},
"suppress_stream_target_start": {
"type": "boolean",
"description": "If **true**, disables stream targets when the transcoder starts. If **false** (the default), the targets start when the transcoder starts.\n\n**Example:** \"suppress_stream_target_start\": false",
"example": ""
},
"username": {
"type": "string",
"description": "A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.\n\n\n**Example:** \"username\": \"client2\"",
"example": ""
},
"watermark": {
"type": "boolean",
"description": "Embeds an image into the transcoded stream for copyright protection. Specify **true** to embed a watermark image.\n\n**Example:** \"watermark\": true",
"example": ""
},
"watermark_height": {
"type": "integer",
"description": "The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.\n\n**Example:** \"watermark_height\": 80",
"example": "",
"format": "int32"
},
"watermark_image": {
"type": "string",
"description": "A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.\n\n**Example:** \"watermark_image\": \"[Base64-encoded string representation of GIF, JPEG, or PNG file]\"",
"example": ""
},
"watermark_opacity": {
"type": "integer",
"description": "The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque.\n\n**Example:** \"watermark_opacity\": 75",
"example": "",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100
],
"format": "int32"
},
"watermark_position": {
"type": "string",
"description": "The corner of the video frame in which you want the watermark to appear. The default is **top-left**.\n\n**Example:** \"watermark_position\": \"top-left\"",
"example": "",
"enum": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
]
},
"watermark_width": {
"type": "integer",
"description": "The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.\n\n**Example:** \"watermark_width\": 100",
"example": "",
"format": "int32"
}
}
}
},
"example": {
"transcoder": {
"name": "My Updated Transcoder",
"watermark_position": "bottom-left"
}
}
},
"uptime": {
"type": "object",
"description": "",
"properties": {
"billed": {
"type": "boolean",
"description": "A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing.",
"example": ""
},
"created_at": {
"type": "string",
"description": "The date and time that the uptime record was created.",
"example": "",
"format": "date-time"
},
"ended_at": {
"type": "string",
"description": "The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the uptime record.",
"example": ""
},
"running": {
"type": "boolean",
"description": "A Boolean value that indicates if the transcoder is still running for this uptime.",
"example": ""
},
"started_at": {
"type": "string",
"description": "The date and time that the transcoder started for this uptime.",
"example": "",
"format": "date-time"
},
"transcoder_id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the transcoder.",
"example": ""
},
"updated_at": {
"type": "string",
"description": "The date and time that the uptime record was updated.",
"example": ""
}
},
"example": {
"billed": false,
"created_at": "2017-07-06T14:22:00.000Z",
"id": "1234abcd",
"running": true,
"started_at": "2017-07-06T14:22:00.000Z",
"transcoder_id": "2adffc17",
"updated_at": "2017-07-06T14:22:00.000Z"
}
},
"uptimes": {
"type": "object",
"description": "",
"required": [
"uptimes"
],
"properties": {
"uptimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/uptime"
}
}
},
"example": {
"uptimes": [
{
"billed": false,
"created_at": "2017-07-06T14:22:00.000Z",
"id": "1234abcd",
"running": true,
"started_at": "2017-07-06T14:22:00.000Z",
"transcoder_id": "2adffc17",
"updated_at": "2017-07-06T14:22:00.000Z"
},
{
"billed": true,
"created_at": "2017-07-08T14:22:00.000Z",
"ended_at": "2017-07-08T16:40:00.000Z",
"id": "5679wxyz",
"running": false,
"started_at": "2017-07-08T14:22:00.000Z",
"transcoder_id": "ff9l4838",
"updated_at": "2017-07-08T16:40:00.000Z"
}
]
}
},
"outputs": {
"type": "object",
"description": "",
"required": [
"outputs"
],
"properties": {
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/output"
}
}
},
"example": {
"outputs": [
{
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.958Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [
{}
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T03:29:50.958Z"
},
{
"created_at": "2020-01-29T17:16:21.958Z",
"id": "PPqV0kcm",
"name": "Standard Output: Video + Audio",
"output_stream_targets": [
{}
],
"video_codec": "passthrough",
"audio_codec": "passthrough",
"transcoder_id": "Yf5lyjCV",
"updated_at": "2020-01-31T03:55:05.958Z"
}
]
}
},
"output_input": {
"type": "object",
"description": "",
"required": [
"output"
],
"properties": {
"output": {
"type": "object",
"title": "output",
"description": "",
"required": [
"video_codec",
"audio_codec"
],
"properties": {
"video_codec": {
"type": "string",
"description": "The codec used to encode the video stream. **disabled** sends the stream without a video track and **passthrough** sends the stream without transcoding the video track. Available from version 1.6.",
"example": "h264",
"enum": [
"h264",
"passthrough",
"disabled"
]
},
"audio_codec": {
"type": "string",
"description": "The codec used to encode the audio stream. **disabled** sends the stream without an audio track and **passthrough** sends the stream without transcoding the audio track. **aac** is the most commonly compatible audio codec for protocols, while **opus** is for WebRTC streams. Available from version 1.6.",
"example": "aac",
"enum": [
"aac",
"opus",
"passthrough",
"disabled"
]
},
"aspect_ratio_height": {
"type": "integer",
"description": "The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1080**. Combined with **aspect_ratio_width**, makes up the input resolution.\n\n**Example:** \"aspect_ratio_height\": 1080",
"example": 480,
"format": "int32"
},
"aspect_ratio_width": {
"type": "integer",
"description": "The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is **1920**. Combined with **aspect_ratio_height**, makes up the input resolution.\n\n**Example:** \"aspect_ratio_width\": 1920",
"example": 848,
"format": "int32"
},
"bitrate_audio": {
"type": "integer",
"description": "The audio bitrate, in kilobits per second (Kbps). Must be between **1** and **9999**. If the **audio_codec** is **opus**, the default is **510**, otherwise the default is **128**.\n\n**Example:** \"bitrate_audio\": 128",
"example": 128,
"format": "int32"
},
"bitrate_video": {
"type": "integer",
"description": "The video bitrate, in kilobits per second (Kbps). Must be between **1** and **10240**. The default is **4000**.\n\n**Example:** \"bitrate_audio\": 1600",
"example": 1600,
"format": "int32"
},
"framerate_reduction": {
"type": "string",
"description": "Reduce the frame rate of the transcoded output rendition. The default, **0**, uses the encoded stream's frame rate without reduction.\n\n**Example:** \"frame_reduction\": \"1/2\"",
"example": "1/2",
"enum": [
"0",
"1/2",
"1/4",
"1/25",
"1/30",
"1/50",
"1/60"
]
},
"h264_profile": {
"type": "string",
"description": "The encoding method. Specify **main** for desktop streaming, **baseline** for playback on mobile devices, or **high** for HD playback. The default is **high**.\n\n**Example:** \"h264_profile\": \"main\"",
"example": "main",
"enum": [
"main",
"baseline",
"high"
]
},
"keyframes": {
"type": "string",
"description": "The interval used to define the compression applied to a group of frames. The default, **follow_source**, uses the keyframe interval of the source video.\n\n**Example:** \"keyframes\": \"follow_source\"",
"example": "follow_source",
"enum": [
"follow_source",
"25",
"30",
"50",
"60",
"100",
"120"
]
}
}
}
},
"example": {
"output": {
"video_codec": "h264",
"audio_codec": "aac",
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"framerate_reduction": "1/2",
"h264_profile": "main",
"keyframes": "follow_source"
}
}
},
"output_create_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/output_input"
}
]
},
"output_update_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/output_input"
}
]
},
"output_stream_targets": {
"type": "object",
"description": "",
"required": [
"output_stream_targets"
],
"properties": {
"output_stream_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/output_stream_target"
}
}
},
"example": {
"output_stream_targets": [
{
"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": false,
"stream_target": {
"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T05:45:33.965Z"
}
},
{
"id": "345Gd9Hs",
"stream_target_id": "R32u8HDk",
"use_stream_target_backup_url": false,
"stream_target": {
"id": "R32u8HDk",
"name": "My other provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T12:19:50.965Z"
}
}
]
}
},
"output_stream_target_input": {
"type": "object",
"description": "",
"required": [
"output_stream_target"
],
"properties": {
"output_stream_target": {
"type": "object",
"title": "output_stream_target",
"description": "",
"required": [
"stream_target_id"
],
"properties": {
"stream_target_id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the stream target.",
"example": "1234abcd"
},
"use_stream_target_backup_url": {
"type": "boolean",
"description": "\nSpecifies whether the output stream target uses the stream target's primary or backup URL.\n\nWhen both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with *use_stream_target_backup_url* as **false** (the default) and once with *use_stream_target_backup_url* as **true**.\n\n**Example:** \"use_stream_target_backup_url\": true",
"example": true
}
}
}
}
},
"output_stream_target_create_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/output_stream_target_input"
}
]
},
"output_stream_target_update_input": {
"description": "",
"allOf": [
{
"$ref": "#/components/schemas/output_stream_target_input"
}
]
},
"transcoder_configure_properties_post_response": {
"type": "object",
"title": "properties",
"description": "",
"properties": {
"properties": {
"type": "array",
"description": "An array of properties.",
"items": {
"$ref": "#/components/schemas/transcoder_property"
}
}
},
"example": {
"properties": [
{
"key": "fitMode",
"section": "output",
"value": "letterbox"
},
{
"key": "rtpIgnoreProfileLevelId",
"section": "rtsp",
"value": true
}
]
}
},
"transcoder_property_create_input": {
"type": "object",
"title": "property",
"description": "",
"properties": {
"property": {
"type": "object",
"title": "property",
"description": "\nThe single property to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.",
"required": [
"section",
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "The key of the property.\n\nThe following table lists the available property keys and what transcoder table section they're stored in.\n\nSection | Valid keys for the section\n----------------|-------------\n**asset_management** | Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days.\n\n\nDefault: Most recent 7 days", "properties": { "percent": { "type": "integer", "description": "A specific segment of the VOD asset. A VOD asset has 100 segments and each segment represents a completion percentage of the asset. For example, 1 is the data for 0 to 1% of the asset, 2 is the data for 1 to 2% and so on.\n\nTrend data is aggregated for each segment.\n\nUse _**duration_ms** / 1000 x **percent**_ to calculate a timestamp, in seconds, for the trend data.", "format": "int32" }, "viewers": { "type": "integer", "description": "The total number of unique viewers who watched this specific segment of the VOD asset. A unique viewer is a single IP address; multiple users that share the same IP address are counted once.", "example": "", "format": "int32" } } }, "limits": { "type": "object", "description": "The time frame represented in the response.", "properties": { "from": { "type": "string", "description": "The start of the range of time represented in the response.", "example": "", "format": "date-time" }, "to": { "type": "string", "description": "The end of the range of time represented in the response.", "example": "", "format": "date-time" } } } } } }, "example": { "vod_stream": { "id": "tvctq36g", "play_rate": 0.2, "completion_rate": 0.42, "duration_ms": 9761000, "avg_seconds_watched": 302, "avg_percentage_watched": 67, "total_seconds_watched": 77699, "trend": [ { "percent": 1, "viewers": 7 }, { "percent": 2, "viewers": 7 }, { "percent": 3, "viewers": 7 }, { "percent": 4, "viewers": 7 }, { "percent": 5, "viewers": 10 }, { "percent": 6, "viewers": 7 }, { "percent": 7, "viewers": 7 }, { "percent": 8, "viewers": 25 }, { "percent": 9, "viewers": 25 }, { "percent": 10, "viewers": 25 }, { "percent": 11, "viewers": 7 }, { "spercent": 12, "viewers": 7 }, { "percent": 13, "viewers": 7 } ] }, "limits": { "from": "2023-04-14T10:31:54.486Z", "to": "2023-07-13T10:31:54.486Z" } } }, "analytics_popularity_live_stream": { "type": "object", "description": "", "properties": { "live_stream": { "type": "object", "title": "live_stream", "description": "", "properties": { "id": { "type": "string", "description": "The unique alphanumeric string that identifies the live stream.", "format": "int32" }, "plays": { "type": "integer", "description": "The total number of plays for a live stream. A play is registered when the stream begins to play.", "example": "", "format": "int32" }, "displays": { "type": "integer", "description": "The total number of displays for a live stream. A display is registered when the player is completely loaded and ready to play the live stream.", "example": "", "format": "int32" }, "trend": { "type": "object", "title": "Array of viewer trends", "description": "An array of viewer trend data. The granularity of sampled data changes based on the from and to query values you use:\n\n1. Requests made for data _within_ the most recent 3 days returns sample intervals by the hour. You can return sample intervals by the minute by specifying a specific hour range.\n\n2. Requests made for data _beyond_ the most recent 3 days can only return sample intervals by the hour or day. The minute data is not retained beyond the 3rd day. \n\n\n
Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days.\n\n\nDefault: Most recent 7 days", "properties": { "plays": { "type": "integer", "description": "The total number of plays for a live stream at the time the trend data was sampled. A play is registered when the stream begins to play.", "example": "", "format": "int32" }, "displays": { "type": "integer", "description": "The total number of displays for a live stream at the time the trend data was sampled. A display is registered when the player is completely loaded and ready to play the live stream.", "example": "", "format": "int32" }, "sampled_at": { "type": "string", "description": "The date and time the trend data was sampled.", "format": "date-time" } } }, "limits": { "type": "object", "description": "The time frame represented in the response.", "properties": { "from": { "type": "string", "description": "The start of the range of time represented in the response.", "example": "", "format": "date-time" }, "to": { "type": "string", "description": "The end of the range of time represented in the response.", "example": "", "format": "date-time" } } } } } }, "example": { "live_stream": { "id": "tvctq36g", "plays": 2, "displays": 2, "trend": [ { "plays": 1, "displays": 1, "sampled_at": "2023-05-26T12:01:00Z" }, { "plays": 1, "displays": 1, "sampled_at": "2023-05-26T12:02:00Z" } ] }, "limits": { "from": "2023-04-14T10:31:54.486Z", "to": "2023-07-13T10:31:54.486Z" } } }, "analytics_popularity_vod_stream": { "type": "object", "description": "", "properties": { "vod_stream": { "type": "object", "title": "vod_stream", "description": "", "properties": { "id": { "type": "string", "description": "The unique alphanumeric string that identifies the VOD stream.", "format": "int32" }, "plays": { "type": "integer", "description": "The total number of plays for a VOD stream. A play is registered when the stream begins to play.", "example": "", "format": "int32" }, "displays": { "type": "integer", "description": "The total number of displays for a VOD stream. A display is registered when the player is completely loaded and ready to play the VOD stream.", "example": "", "format": "int32" }, "trend": { "type": "object", "title": "Array of viewer trends", "description": "An array of viewer trend data. The granularity of sampled data changes based on the from and to query values you use:\n\n1. Requests made for data _within_ the most recent 3 days returns sample intervals by the hour. You can return sample intervals by the minute by specifying a specific hour range.\n\n2. Requests made for data _beyond_ the most recent 3 days can only return sample intervals by the hour or day. The minute data is not retained beyond the 3rd day. \n\n\n
Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days.\n\n\n\nDefault: Most recent 7 days", "properties": { "plays": { "type": "integer", "description": "The total number of plays for a VOD stream at the time the trend data was sampled. A play is registered when the stream begins to play.", "example": "", "format": "int32" }, "displays": { "type": "integer", "description": "The total number of displays for a VOD stream at the time the trend data was sampled. A display is registered when the player is completely loaded and ready to play the VOD stream.", "example": "", "format": "int32" }, "sampled_at": { "type": "string", "description": "The date and time the trend data was sampled.", "format": "date-time" } } }, "limits": { "type": "object", "description": "The time frame represented in the response.", "properties": { "from": { "type": "string", "description": "The start of the range of time represented in the response.", "example": "", "format": "date-time" }, "to": { "type": "string", "description": "The end of the range of time represented in the response.", "example": "", "format": "date-time" } } } } } }, "example": { "vod_stream": { "id": "tvctq36g", "plays": 2, "displays": 2, "trend": [ { "plays": 1, "displays": 1, "sampled_at": "2023-05-26T12:01:00Z" }, { "plays": 1, "displays": 1, "sampled_at": "2023-05-26T12:02:00Z" } ] }, "limits": { "from": "2023-04-14T10:31:54.486Z", "to": "2023-07-13T10:31:54.486Z" } } }, "usage_transcoders": { "type": "object", "title": "transcoders", "description": "", "properties": { "transcoders": { "type": "object", "description": "", "properties": { "id": { "type": "integer", "description": "The unique alphanumeric string that identifies the transcoder.", "example": "", "format": "int32" }, "name": { "type": "string", "description": "A descriptive name for the transcoder.", "example": "" }, "archived": { "type": "boolean", "description": "A value of **true** indicates that the transcoder has been removed from Wowza Video.", "example": "" }, "billing_mode": { "type": "string", "description": "The billing mode for the transcoder. The default is **pay_as_you_go**.\n\n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n\n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.", "example": "", "enum": [ "pay_as_you_go", "twentyfour_seven" ] }, "transcoder_type": { "type": "string", "description": "The type of transcoder. The default is **transcoded**.", "example": "", "enum": [ "transcoded", "passthrough" ] }, "egress_bytes": { "type": "integer", "description": "The amount of content, in bytes, that went through the transcoder during the selected time frame.", "example": "", "format": "int32" }, "egress_seconds": { "type": "integer", "description": "The amount of time, in seconds, that it took for the stream to be processed.", "example": "" }, "egress_seconds_additional_targets": { "type": "integer", "description": "The length of time, in seconds, that additional stream targets pulled from storage during the selected time frame. Subscriptions prices include egress for one target; additional targets incur additional charges.", "example": "", "format": "int32" } } }, "pagination": { "type": "object", "description": "Page information for the results generated by the query.", "properties": { "payload_version": { "type": "integer", "description": "The pagination object version." }, "total_records": { "type": "integer", "description": "The total number of records in the database that match the query.", "example": "" }, "page": { "type": "integer", "description": "The page being displayed.", "example": "" }, "per_page": { "type": "integer", "description": "The number of records included on each page of results.", "example": "" }, "total_pages": { "type": "integer", "description": "The total number of pages generated by the query.", "example": "" }, "page_first_index": { "type": "integer", "description": "The 0-based index of the first record on the page returned.", "example": "" }, "page_last_index": { "type": "integer", "description": "The 0-based index of the last record on the page returned.", "example": "" } } }, "limits": { "type": "object", "description": "The time frame represented in the response.", "properties": { "from": { "type": "string", "description": "The start of the range of time represented in the response.", "example": "", "format": "date-time" }, "to": { "type": "string", "description": "The end of the range of time represented in the response.", "example": "", "format": "date-time" } } } }, "example": { "transcoders": [ { "id": "bbrjj3ml", "name": "transcoder name", "archived": false, "transcoder_type": "transcoded", "billing_mode": "pay_as_you_go", "egress_bytes": 0, "egress_seconds": 44, "egress_seconds_additional_targets": 23 }, { "id": "mertj8nd", "name": "my other transcoder", "archived": false, "transcoder_type": "transcoded", "billing_mode": "pay_as_you_go", "egress_bytes": 80384481, "egress_seconds": 158, "egress_seconds_additional_targets": 0 } ], "pagination": { "payload_version": "1.0", "total_records": 2130, "page": 3, "per_page": 3, "total_pages": 710, "page_first_index": 6, "page_last_index": 8 }, "limits": { "from": "2019-10-01T07:00:00.000Z", "to": "2019-10-16T11:00:00.000Z" } } }, "usage_transcoder": { "type": "object", "title": "transcoders", "description": "", "properties": { "transcoders": { "type": "object", "description": "", "properties": { "id": { "type": "integer", "description": "The unique alphanumeric string that identifies the transcoder.", "example": "", "format": "int32" }, "name": { "type": "string", "description": "A descriptive name for the transcoder.", "example": "" }, "archived": { "type": "boolean", "description": "A value of **true** indicates that the transcoder has been removed from Wowza Video.", "example": "" }, "billing_mode": { "type": "string", "description": "The billing mode for the transcoder. The default is **pay_as_you_go**.\n\n**pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.\n\n**twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.", "example": "", "enum": [ "pay_as_you_go", "twentyfour_seven" ] }, "transcoder_type": { "type": "string", "description": "The type of transcoder. The default is **transcoded**.", "example": "", "enum": [ "transcoded", "passthrough" ] }, "egress_bytes": { "type": "integer", "description": "The amount of content, in bytes, that went through the transcoder during the selected time frame.", "example": "", "format": "int32" }, "egress_seconds": { "type": "integer", "description": "The amount of time, in seconds, that it took for the stream to be processed.", "example": "" }, "egress_seconds_additional_targets": { "type": "integer", "description": "The length of time, in seconds, that additional stream targets pulled from storage during the selected time frame. Subscriptions prices include egress for one target; additional targets incur additional charges.", "example": "", "format": "int32" }, "viewing_seconds": { "type": "integer", "description": "The total length of time, in seconds, that the stream was played at the target. May be longer than the duration of the stream.", "example": "", "format": "int32" }, "viewing_bytes": { "type": "integer", "description": "The amount of content, in bytes, that went through the transcoder during the selected time frame.", "example": "", "format": "int32" }, "trend": { "type": "object", "title": "Array of viewer trends", "description": "An array of viewer trend data. The granularity of sampled data changes based on the from and to query values you use:\n\nRequests made for data within the past 30 days, return the following sample intervals:
\"name\": \"My updated VOD stream\"",
"example": "My VOD Stream 1"
},
"playback_enabled": {
"type": "boolean",
"description": "Specifies whether playback is enabled for the VOD stream.\n\n**Example:** \"playback_enabled\": true",
"example": true,
"enum": [
true,
false
]
}
}
}
}
},
"usage_vod_stream_trend": {
"type": "object",
"description": "",
"properties": {
"trend": {
"type": "object",
"title": "Array of trends",
"description": "An array of trend data",
"properties": {
"sampled_at": {
"type": "string",
"description": "The date and time the trend data was sampled.",
"format": "date-time"
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the stream at the target (for HTTP streams). A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
},
"viewing_seconds": {
"type": "integer",
"description": "The total length of time, in seconds, that the stream was played at the target. May be longer than the duration of the stream.",
"example": "",
"format": "int32"
},
"viewing_bytes": {
"type": "integer",
"description": "The amount of content, in bytes, that went through the stream target during the selected time frame.",
"example": "",
"format": "int32"
}
}
},
"limits": {
"type": "object",
"description": "The time frame represented in the response.",
"properties": {
"from": {
"type": "string",
"description": "The start of the range of time represented in the response.",
"example": "",
"format": "date-time"
},
"to": {
"type": "string",
"description": "The end of the range of time represented in the response.",
"example": "",
"format": "date-time"
}
}
}
},
"example": {
"trend": [
{
"sampled_at": "2022-03-01T00:00:00.000Z",
"unique_viewers": 358,
"viewing_seconds": 1288800,
"viewing_bytes": 8483993
},
{
"sampled_at": "2022-03-02T00:00:00.000Z",
"unique_viewers": 75,
"viewing_seconds": 270000,
"viewing_bytes": 6937994
},
{
"sampled_at": "2022-03-03T00:00:00.000Z",
"unique_viewers": 400,
"viewing_seconds": 1440000,
"viewing_bytes": 3958503
}
],
"limits": {
"from": "2022-03-01T00:00:00.000Z",
"to": "2022-03-05T00:00:00.000Z"
}
}
},
"usage_vod_streams_viewer_data": {
"type": "object",
"description": "",
"properties": {
"vod_stream": {
"type": "object",
"title": "vod_stream",
"description": "",
"properties": {
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the VOD stream.",
"format": "int32"
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the VOD stream. A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
},
"countries": {
"type": "object",
"title": "countries",
"description": "An array of viewer countries.",
"properties": {
"code": {
"type": "string",
"description": "A country code where the stream was requested.",
"example": ""
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the VOD stream. A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
}
}
},
"viewer_trend": {
"type": "object",
"title": "Array of viewer trends",
"description": "An array of viewer trend data. Returns one data point per minute for the past hour.",
"properties": {
"sampled_at": {
"type": "string",
"description": "The date and time the trend data was sampled.",
"format": "date-time"
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the VOD stream. A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
}
}
}
}
}
},
"example": {
"vod_stream": {
"id": "tvctq36g",
"unique_viewers": 7,
"countries": [
{
"code": "US",
"unique_viewers": 3
},
{
"code": "DE",
"unique_viewers": 4
}
],
"viewer_trend": [
{
"sampled_at": "2022-01-26T12:01:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:02:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:03:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:04:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:05:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:06:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:07:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:08:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:09:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:10:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:11:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:12:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:13:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:14:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:15:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:16:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:17:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:18:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:19:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:20:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:21:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:22:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:23:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:24:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:25:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:26:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:27:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:28:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:29:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:30:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:31:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:32:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:33:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:34:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:35:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:36:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:37:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:38:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:39:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:40:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:41:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:42:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:43:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:44:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:45:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:46:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:47:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:48:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:49:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:50:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:51:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:52:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:53:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:54:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:55:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:56:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:57:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:58:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:59:00Z",
"unique_viewers": 7
},
{
"sampled_at": "2022-01-26T12:60:00Z",
"unique_viewers": 7
}
]
}
}
},
"usage_vod_stream_countries": {
"type": "object",
"description": "",
"properties": {
"countries": {
"type": "object",
"title": "countries",
"description": "",
"properties": {
"code": {
"type": "string",
"description": "A country code where the stream was requested.",
"example": ""
},
"name": {
"type": "string",
"description": "The name of a country where the stream was requested.",
"example": ""
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the stream at the target (for HTTP streams). A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
},
"viewing_seconds": {
"type": "integer",
"description": "The total length of time, in seconds, that the stream was played at the target. May be longer than the duration of the stream.",
"example": "",
"format": "int32"
},
"avg_viewing_seconds": {
"type": "integer",
"description": "The average length of time, in seconds, that the stream was played at the target.",
"example": "",
"format": "int32"
},
"viewing_bytes": {
"type": "integer",
"description": "The amount of content, in bytes, that went through the stream target during the selected time frame.",
"example": "",
"format": "int32"
}
}
},
"limits": {
"type": "object",
"description": "The time frame represented in the response.",
"properties": {
"from": {
"type": "string",
"description": "The start of the range of time represented in the response.",
"example": "",
"format": "date-time"
},
"to": {
"type": "string",
"description": "The end of the range of time represented in the response.",
"example": "",
"format": "date-time"
}
}
}
},
"example": {
"countries": [
{
"code": "US",
"name": "United States",
"unique_viewers": 1,
"viewing_seconds": 222,
"avg_viewing_seconds": 222,
"viewing_bytes": 12886
},
{
"code": "CA",
"name": "Canada",
"unique_viewers": 14,
"viewing_seconds": 222,
"avg_viewing_seconds": 16,
"viewing_bytes": 22886
}
],
"limits": {
"from": "2021-01-07T00:00:00.000Z",
"to": "2021-10-05T00:00:00.000Z"
}
}
},
"usage_vod_stream_renditions": {
"type": "object",
"description": "",
"properties": {
"renditions": {
"type": "object",
"title": "renditions",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "The name of the VOD stream's output rendition. A rendition name is the smaller number of the resolution. The resolution is [width]x[height] in which the stream was played. Renditions names have to be unique. If you've created two renditions that have the same height and width, Wowza Video increments the value of the height and uses that as the rendition name.\n \n \nExample: Two renditions of 1280x720 will result in rendition names of 720 and 721.",
"example": ""
},
"unique_viewers": {
"type": "integer",
"description": "The total number of unique viewers to download at least one chunk of the stream at the target (for HTTP streams). A unique viewer is a single IP address; multiple users that share the same IP address are counted once.",
"example": "",
"format": "int32"
},
"viewing_seconds": {
"type": "integer",
"description": "The total length of time, in seconds, that the stream was played at the target. May be longer than the duration of the stream.",
"example": "",
"format": "int32"
},
"avg_viewing_seconds": {
"type": "integer",
"description": "The average length of time, in seconds, that the stream was played at the target.",
"example": "",
"format": "int32"
},
"viewing_bytes": {
"type": "integer",
"description": "The amount of content, in bytes, that went through the stream target during the selected time frame.",
"example": "",
"format": "int32"
}
}
},
"limits": {
"type": "object",
"description": "The time frame represented in the response.",
"properties": {
"from": {
"type": "string",
"description": "The start of the range of time represented in the response.",
"example": "",
"format": "date-time"
},
"to": {
"type": "string",
"description": "The end of the range of time represented in the response.",
"example": "",
"format": "date-time"
}
}
}
},
"example": {
"renditions": [
{
"name": "360",
"unique_viewers": 14,
"viewing_seconds": 222,
"avg_viewing_seconds": 16,
"viewing_bytes": 22886
},
{
"name": "720",
"unique_viewers": 14,
"viewing_seconds": 222,
"avg_viewing_seconds": 16,
"viewing_bytes": 22886
}
],
"limits": {
"from": "2021-01-07T00:00:00.000Z",
"to": "2021-10-05T00:00:00.000Z"
}
}
},
"index_real_time_stream": {
"type": "object",
"title": "real_time_streams",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the real-time stream was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique alphanumeric string that identifies the real-time stream.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the real-time stream.",
"example": ""
},
"state": {
"type": "string",
"description": "The state of the stream.",
"example": "",
"enum": [
"active",
"archived",
"disabled",
"stopped"
]
},
"updated_at": {
"type": "string",
"description": "The date and time that the real-time stream was updated.",
"example": "",
"format": "date-time"
}
}
},
"real_time_streams": {
"type": "object",
"description": "",
"required": [
"real_time_streams"
],
"properties": {
"real_time_streams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/index_real_time_stream"
}
}
},
"example": {
"real_time_streams": [
{
"id": "2adffc17",
"name": "MyRealTimeStream",
"state": "active",
"created_at": "2021-01-29T17:16:21.849Z",
"updated_at": "2021-01-31T16:06:47.849Z"
},
{
"id": "if7le8ip",
"name": "MyRealTimeStream2",
"state": "active",
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-31T02:26:05.849Z"
},
{
"id": "dd4udt1b",
"name": "MyRealTimeStream3",
"state": "active",
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-30T18:13:18.849Z"
}
]
}
},
"real_time_stream_create": {
"type": "object",
"description": "",
"properties": {
"real_time_stream": {
"type": "object",
"title": "real_time_stream",
"description": "",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the real-time stream. Maximum 255 characters.\n\nNote: If you record a real-time stream, the name is used to for the recording file name. To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names, so the recording file name might vary from the name you provided here.", "example": "" }, "disable_vod_encoder": { "type": "boolean", "description": "Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. \n\nCan only be set when **recording** is true and you can't change this value after you create the stream.\n\n**Default:** false\n\n**Example:**
\"disable_vod_encoder\": true"
},
"enable_secure_viewer": {
"type": "boolean",
"description": "Require viewers to pass a security token for playback.\n\n**Example:** \"enable_secure_viewer\": false"
},
"expires_on": {
"type": "string",
"description": "The date and time the security token expires. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC. If you don't specify **HH:MM:SS**, the token expires at 12AM UTC on the specified day.\n\nRequired when *enable_secure_viewer* is **true**.\n\n**Example:** \"expires_on\": \"2021-10-27 23:08:55 UTC\"",
"format": "date-time"
},
"region": {
"type": "string",
"description": "An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.\n\n**Default:** phoenix\n\n**Example:** \"region\": amsterdam",
"example": "",
"enum": [
"phoenix",
"amsterdam",
"singapore",
"bangalore",
"auto"
]
},
"recording": {
"type": "boolean",
"description": "If **true**, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops.\n\nRecordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. \n\n**Default:** false\n\nNote: You can't update this value after you create the stream.\n\n**Example:**
\"recording\": true"
}
}
}
},
"example": {
"real_time_stream": {
"name": "MyRealTimeStream"
}
}
},
"real_time_stream": {
"type": "object",
"description": "",
"properties": {
"created_at": {
"type": "string",
"description": "The date and time that the real-time stream was created.",
"example": "",
"format": "date-time"
},
"id": {
"type": "string",
"description": "The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.",
"example": ""
},
"name": {
"type": "string",
"description": "A descriptive name for the real-time stream.",
"example": ""
},
"stream_name": {
"type": "string",
"description": "The generated alphanumeric stream name you pass to the SDK.",
"example": ""
},
"token": {
"type": "string",
"description": "The authentication token you pass to the SDK.",
"example": ""
},
"subscribe_token": {
"type": "string",
"description": "A secure token that must be passed by viewers for playback. Generated after you set *enable_secure_viewer* to **true**."
},
"rtmp_url": {
"type": "string",
"description": "The URL you can use to configure an RTMP encoder as the source."
},
"enable_secure_viewer": {
"type": "boolean",
"description": "Require viewers to pass a security token for playback."
},
"expires_on": {
"type": "string",
"description": "The date and time the security token expires. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC. If you don't specify **HH:MM:SS**, the token expires at 12AM UTC on the specified day. Required when *enable_secure_viewer* is **true**.",
"format": "date-time"
},
"state": {
"type": "string",
"description": "The state of the stream.",
"example": "",
"enum": [
"active",
"archived",
"disabled",
"stopped"
]
},
"region": {
"type": "string",
"description": "An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.\n\n**Default:** phoenix\n\n**Example:** \"region\": amsterdam",
"example": "",
"enum": [
"phoenix",
"amsterdam",
"singapore",
"bangalore",
"auto"
]
},
"recording": {
"type": "boolean",
"description": "If **true**, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. \n\nRecordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording.\n\n**Default:** false\n\nNote: You can't update this value after you create the stream.\n\n**Example:**
\"recording\": true"
},
"disable_vod_encoder": {
"type": "boolean",
"description": "Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. \n\nCan only be set when **recording** is true and you can't change this value after you create the stream.\n\n**Default:** false\n\n**Example:** \"disable_vod_encoder\": true"
},
"updated_at": {
"type": "string",
"description": "The date and time the real-time stream was updated.",
"example": "",
"format": "date-time"
}
},
"example": {
"id": "2adffc17",
"name": "MyRealTimeStream",
"stream_name": "8d304b93f1684320a54f2798666eeca7",
"token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"enable_secure_viewer": false,
"state": "active",
"region": "amsterdam",
"recording": true,
"disable_vod_encoder": true,
"created_at": "2021-06-30T18:02:20.000Z",
"updated_at": "2021-06-30T20:03:16.000Z"
}
},
"real_time_stream_update": {
"type": "object",
"description": "",
"properties": {
"real_time_stream": {
"type": "object",
"title": "real_time_stream",
"description": "",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the real-time stream. Maximum 255 characters.\n\nNote: If you record a real-time stream, the name is used to for the recording file name. To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names, so the recording file name might vary from the name you provided here.", "example": "" }, "enable_secure_viewer": { "type": "boolean", "description": "Require viewers to pass a security token for playback.\n\n**Example:**
\"enable_secure_viewer\": false"
},
"expires_on": {
"type": "string",
"description": "The date and time the security token expires. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC. If you don't specify **HH:MM:SS**, the token expires at 12AM UTC on the specified day.\n\nRequired when *enable_secure_viewer* is **true**.\n\n**Example:** \"expires_on\": \"2021-10-27 23:08:55 UTC\"",
"format": "date-time"
},
"region": {
"type": "string",
"description": "An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.\n\n**Default:** phoenix\n\n**Example:** \"region\": amsterdam",
"example": "",
"enum": [
"phoenix",
"amsterdam",
"singapore",
"bangalore",
"auto"
]
}
}
}
},
"example": {
"real_time_stream": {
"name": "MyUpdatedRealTimeStream"
}
}
},
"Error423": {
"type": "object",
"description": "",
"required": [
"meta"
],
"properties": {
"meta": {
"type": "object",
"title": "meta",
"description": "",
"properties": {
"status": {
"type": "integer",
"description": "",
"example": "",
"format": "int32"
},
"code": {
"type": "string",
"description": "",
"example": ""
},
"title": {
"type": "string",
"description": "",
"example": ""
},
"message": {
"type": "string",
"description": "",
"example": ""
},
"description": {
"type": "string",
"description": "",
"example": ""
},
"links": {
"type": "array",
"description": "",
"example": "",
"items": {}
}
}
}
},
"example": {
"Example Response 1": {
"meta": {
"status": 423,
"code": "ERR-423-StreamAlreadyStopped",
"title": "Stream Already Stopped Error",
"message": "The request couldn't be processed. The stream has already been stopped.",
"description": "",
"links": []
}
}
}
}
}
},
"x-tagGroups": [
{
"name": "Resource Management",
"tags": [
"live_streams",
"players",
"transcoders",
"stream_sources",
"stream_targets",
"assets",
"recordings",
"schedules",
"vod_streams",
"real_time"
]
},
{
"name": "Analytics",
"tags": [
"analytics_viewers",
"analytics_ingest",
"analytics_engagement",
"analytics_popularity"
]
},
{
"name": "Usage",
"tags": [
"usage_account",
"usage_transcoders",
"usage",
"storage",
"usage_vod_streams",
"usage_real_time_streams"
]
}
]
}