@datafire/wowza
v5.0.0
Published
DataFire integration for Wowza Streaming Cloud REST API Reference Documentation
Downloads
28
Readme
@datafire/wowza
Client library for Wowza Streaming Cloud REST API Reference Documentation
Installation and Usage
npm install --save @datafire/wowza
let wowza = require('@datafire/wowza').create({
"wsc-access-key": "",
"wsc-api-key": ""
});
.then(data => {
console.log(data);
});
Description
About the REST API
The Wowza Streaming CloudTM REST API (application programming interface) offers complete programmatic control over live streams, transcoders, stream sources, and stream targets. Anything you can do in the Wowza Streaming Cloud UI can also be achieved by making HTTP-based requests to cloud-based servers through the REST API.
The Wowza Streaming Cloud REST API features cross-origin resource sharing, or CORS. CORS is a W3C specification that provides headers in HTTP requests to enable a web server to safely make a network request to another domain.
In order to protect shared resources, the Wowza Streaming Cloud REST API is subject to limits. For details, see Wowza Streaming Cloud REST API limits.
About this documentation
This reference documentation is based on the open-source Swagger framework. It allows you to view the operations, parameters, and request and reponse schemas for every resource. Request samples are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON.
For more information and examples on using the Wowza Streaming Cloud REST API, see our library of Wowza Streaming Cloud REST API technical articles.
Query requirements
The Wowza Streaming Cloud REST API uses HTTP requests to retrieve data from cloud-based servers. Requests must contain proper JSON, two authentication keys, and the correct version number in the base path.
JSON
The Wowza Streaming Cloud REST API uses the JSON API specification to request and return data. This means requests must include the header Content-Type: application/json
and must include a single resource object in JSON format as primary data.
Responses include HTTP status codes that indicate whether the query was successful. If there was an error, a description explains the problem so that you can fix it and try again.
Authentication
Requests to the Wowza Streaming Cloud REST API must be authenticated with two keys: an API key and an access key. Each key is a 64-character alphanumeric string that you can find on the API Access page in Wowza Streaming Cloud.
Use the wsc-api-key
and wsc-access-key
headers to authenticate requests, like this (in cURL):
curl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'
Version
The Wowza Streaming Cloud API is currently at version 1.0.0. Use v1
in your base path in every request, like this path to the live_streams endpoint:
https://api.cloud.wowza.com/api/v1/live_streams
Example query
Here is a complete example POST request, in cURL, with proper JSON syntax, headers, authentication, and version information:
curl -H 'wsc-api-key: [64-character-api-key-goes-here]' -H 'wsc-access-key: [64-character-access-key-goes-here]'
-H 'Content-Type: application/json' -X POST -d '{
"live_stream": {
"name": "My live Stream",
"...": "..."
}
}' https://api.cloud.wowza.com/api/v1/live_streams
Actions
specs
This operation shows the details of the Swagger specification.
wowza.specs(null, context)
Input
This action has no parameters
Output
- output Spec
listLiveStreams
This operation shows the details of all of your live streams.
wowza.listLiveStreams({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output live_streams
createLiveStream
This operation creates a live stream.
wowza.createLiveStream({
"live_stream": {
"live_stream": {
"name": "",
"transcoder_type": "",
"billing_mode": "",
"broadcast_location": "",
"encoder": "",
"aspect_ratio_width": 0,
"aspect_ratio_height": 0
}
}
}, context)
Input
- input
object
- live_stream required live_stream_create_input
Output
- output
object
- live_stream required live_stream
deleteLiveStream
This operation deletes a live stream, including all assigned outputs and targets.
wowza.deleteLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
Output schema unknown
showLiveStream
This operation shows the details of a specific live stream.
wowza.showLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required live_stream
updateLiveStream
This operation updates a live stream.
wowza.updateLiveStream({
"id": "",
"live_stream": {
"live_stream": {
"name": "",
"encoder": "",
"aspect_ratio_width": 0,
"aspect_ratio_height": 0
}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream. - live_stream required live_stream_update_input
- id required
Output
- output
object
- live_stream required live_stream
regenerateConnectionCodeLiveStream
This operation regenerates the connection code of a live stream.
wowza.regenerateConnectionCodeLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- connection_code
string
: A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Streaming Cloud. The code can be used once and expires 24 hours after it's created.
- connection_code
- live_stream required
resetLiveStream
This operation resets a live stream.
wowza.resetLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- state
string
(values: started, stopped, starting, stopping, resetting): The state of the live stream.
- state
- live_stream required
startLiveStream
This operation starts a live stream.
wowza.startLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- state
string
(values: started, stopped, starting, stopping, resetting): The state of the live stream.
- state
- live_stream required
showLiveStreamState
This operation shows the current state of a live stream.
wowza.showLiveStreamState({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- state
string
(values: started, stopped, starting, stopping, resetting): The state of the live stream.
- state
- live_stream required
showLiveStreamStats
This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value.
wowza.showLiveStreamStats({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required shm_metrics
stopLiveStream
This operation stops a live stream.
wowza.stopLiveStream({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- state
string
(values: started, stopped, starting, stopping, resetting): The state of the live stream.
- state
- live_stream required
showLiveStreamThumbnailUrl
This operation shows the thumbnail URL of a started live stream.
wowza.showLiveStreamThumbnailUrl({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the live stream.
- id required
Output
- output
object
- live_stream required
object
- thumbnail_url
string
: The URL to receive the preview thumbnail.
- thumbnail_url
- live_stream required
listPlayers
This operation shows the details of all of your players.
wowza.listPlayers({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output players
showPlayer
This operation shows details of a specific player.
wowza.showPlayer({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the player.
- id required
Output
- output
object
- player required player
updatePlayer
This operation updates a player.
wowza.updatePlayer({
"id": "",
"player": {
"player": {}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the player. - player required player_update_input
- id required
Output
- output
object
- player required player
requestPlayerRebuild
This operation rebuilds the player with the current configuration.
wowza.requestPlayerRebuild({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the player.
- id required
Output
- output
object
- player required
object
- state
string
(values: requested, already_requested, activated, archived): The state of the player.
- state
- player required
showPlayerState
This operation shows the current state of a player.
wowza.showPlayerState({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the player.
- id required
Output
- output
object
- player required
object
- state
string
(values: requested, already_requested, activated, archived): The state of the player.
- state
- player required
listPlayerUrls
This operation shows the details of all player URLs.
wowza.listPlayerUrls({
"player_id": ""
}, context)
Input
- input
object
- player_id required
string
: The unique alphanumeric string that identifies the player.
- player_id required
Output
- output urls
createPlayerUrl
This operation creates a new player URL.
wowza.createPlayerUrl({
"player_id": "",
"url": null
}, context)
Input
- input
object
- player_id required
string
: The unique alphanumeric string that identifies the player. - url required url_create_input
- player_id required
Output
- output
object
- url required url
deletePlayerUrl
This operation deletes a player URL.
wowza.deletePlayerUrl({
"player_id": "",
"id": ""
}, context)
Input
- input
object
- player_id required
string
: The unique alphanumeric string that identifies the player. - id required
string
: The unique alphanumeric string that identifies the player URL.
- player_id required
Output
Output schema unknown
showPlayerUrl
This operation shows the details of a player URL.
wowza.showPlayerUrl({
"player_id": "",
"id": ""
}, context)
Input
- input
object
- player_id required
string
: The unique alphanumeric string that identifies the player. - id required
string
: The unique alphanumeric string that identifies the player URL.
- player_id required
Output
- output
object
- url required url
updatePlayerUrl
This operation updates a player URL.
wowza.updatePlayerUrl({
"player_id": "",
"id": "",
"url": null
}, context)
Input
- input
object
- player_id required
string
: The unique alphanumeric string that identifies the player. - id required
string
: The unique alphanumeric string that identifies the player URL. - url required url_update_input
- player_id required
Output
- output
object
- url required url
listRecordings
This operation shows the details of all of your recordings.
wowza.listRecordings({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output recordings
deleteRecording
This operation deletes a recording.
wowza.deleteRecording({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the recording.
- id required
Output
Output schema unknown
showRecording
This operation shows the details of a specific recording.
wowza.showRecording({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the recording.
- id required
Output
- output
object
- recording required recording
showRecordingState
This operation shows the current state of a recording.
wowza.showRecordingState({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the recording.
- id required
Output
- output
object
- recording required
object
- state
string
(values: uploading, converting, removing, completed, failed): The state of the recording.
- state
- recording required
listSchedules
This operation shows the details of all of your schedules.
wowza.listSchedules({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output schedules
createSchedule
This operation creates a schedule.
wowza.createSchedule({
"schedule": {
"schedule": {
"name": "",
"transcoder_id": "",
"action_type": "",
"recurrence_type": ""
}
}
}, context)
Input
- input
object
- schedule required schedule_create_input
Output
- output
object
- schedule required schedule
deleteSchedule
This operation deletes a schedule.
wowza.deleteSchedule({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule.
- id required
Output
Output schema unknown
showSchedule
This operation shows the details of a specific schedule.
wowza.showSchedule({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule.
- id required
Output
- output
object
- schedule required schedule
updateSchedule
This operation updates a schedule.
wowza.updateSchedule({
"id": "",
"schedule": {
"schedule": {
"name": "",
"action_type": ""
}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule. - schedule required schedule_update_input
- id required
Output
- output
object
- schedule required schedule
disableSchedule
This operation disables a schedule.
wowza.disableSchedule({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule.
- id required
Output
- output
object
- schedule required
object
- state
string
(values: enabled, disabled, expired): 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.
- state
- schedule required
enableSchedule
This operation enables a schedule.
wowza.enableSchedule({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule.
- id required
Output
- output
object
- schedule required
object
- state
string
(values: enabled, disabled, expired): 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.
- state
- schedule required
showScheduleState
This operation shows the current state of a schedule.
wowza.showScheduleState({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the schedule.
- id required
Output
- output
object
- schedule required
object
- state
string
(values: enabled, disabled, expired): 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.
- state
- schedule required
listStreamSources
This operation shows the details of all of your stream sources.
wowza.listStreamSources({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output stream_sources
createStreamSource
This operation adds a stream source.
wowza.createStreamSource({
"stream_source": {
"stream_source": {
"name": "",
"location_method": ""
}
}
}, context)
Input
- input
object
- stream_source required stream_source_create_input
Output
- output
object
- stream_source required stream_source
addStreamSource
POST /stream_sources/add/ is deprecated. To add a stream source, use POST /stream_sources instead.
wowza.addStreamSource({
"stream_source": {
"stream_source": {
"name": "",
"location_method": ""
}
}
}, context)
Input
- input
object
- stream_source required stream_source_create_input
Output
- output
object
- stream_source required stream_source
deleteStreamSource
This operation deletes a stream source.
wowza.deleteStreamSource({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream source.
- id required
Output
Output schema unknown
showStreamSource
This operation shows details of a specific stream source.
wowza.showStreamSource({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream source.
- id required
Output
- output
object
- stream_source required stream_source
updateStreamSource
This operation updates a stream source.
wowza.updateStreamSource({
"id": "",
"stream_source": {
"stream_source": {
"name": ""
}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream source. - stream_source required stream_source_update_input
- id required
Output
- output
object
- stream_source required stream_source
listStreamTargets
This operation lists the details of all of your stream targets.
wowza.listStreamTargets({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output stream_targets
createStreamTarget
This operation creates a stream target. There are three types of targets that you can create: CustomStreamTarget for an an external, third-party destination; WowzaStreamTarget for a Wowza CDN target; or UltraLowLatencyStreamTarget for an ultra low latency Wowza CDN target. The availability of many parameters depends on the type of target you create.
wowza.createStreamTarget({
"stream_target": null
}, context)
Input
- input
object
- stream_target required stream_target_create_input
Output
- output
object
- stream_target required stream_target
addStreamTarget
POST /stream_targets/add/ is deprecated. To add a stream target, use POST /stream_targets instead.
wowza.addStreamTarget({
"stream_target": {
"stream_target": {
"name": "",
"location": ""
}
}
}, context)
Input
- input
object
- stream_target required wowza_stream_target_input
Output
- output
object
- stream_target required stream_target
deleteStreamTarget
This operation deletes a stream target.
wowza.deleteStreamTarget({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target.
- id required
Output
Output schema unknown
showStreamTarget
This operation shows details of a specific stream target.
wowza.showStreamTarget({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target.
- id required
Output
- output
object
- stream_target required stream_target
updateStreamTarget
This operation updates a stream target.
wowza.updateStreamTarget({
"id": "",
"stream_target": {
"stream_target": {}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target. - stream_target required stream_target_update_input
- id required
Output
- output
object
- stream_target required stream_target
showStreamTargetMetricsCurrent
This operation returns a snapshot of the current connection and throughput details for an active target whose type is UltraLowLatencyStreamTarget. The interval for current metrics is 30 seconds from the moment of the query.
wowza.showStreamTargetMetricsCurrent({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target.
- id required
Output
- output
object
- id
string
: The unique alphanumeric string that identifies the stream target. - metrics stream_target_metrics
- id
showStreamTargetMetricsHistoric
This operation shows historic connection and throughput details for target whose type is UltraLowLatencyStreamTarget.
wowza.showStreamTargetMetricsHistoric({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target. - from
string
: The start of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC. - to
string
: The end of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC. - interval
string
(values: second, minute, hour, day, month, #s, #m, #h, #d): The length of time for a block of metrics. The default is 10m (10 minutes).
- id required
Output
- output
object
- id
string
: The unique alphanumeric string that identifies the stream target. - interval
string
: The length of time for a block of metrics. The default is 10m (10 minutes). - metrics
array
- items stream_target_metrics
- id
regenerateConnectionCodeStreamTarget
This operation regenerates the connection code of a stream target.
wowza.regenerateConnectionCodeStreamTarget({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target.
- id required
Output
- output
object
- stream_target required
object
- connection_code
string
: A six-character, alphanumeric string that allows Wowza Streaming Engine to send a transcoded stream to a WowzaStreamTarget or for the Wowza GoCoder app to send an encoded stream to a UltraLowLatencyStreamTarget. The code can be used once and expires 24 hours after it's created.
- connection_code
- stream_target required
showStreamTargetGeoblock
This operation shows the details of geo-blocking applied to a specific stream target. Only stream targets whose type is WowzaStreamTarget can be geo-blocked.
wowza.showStreamTargetGeoblock({
"stream_target_id": ""
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- stream_target_id required
Output
- output
object
- geoblock required geoblock
updateStreamTargetGeoblock
This operation updates the geo-blocking applied to a stream target. Only stream targets whose type is WowzaStreamTarget can be geo-blocked.
wowza.updateStreamTargetGeoblock({
"stream_target_id": "",
"geoblock": null
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - geoblock required geoblock_update_input
- stream_target_id required
Output
- output
object
- geoblock required geoblock
createStreamTargetGeoblock
This operation allows you to block or whitelist viewing of a stream target by geographic location. Only stream targets whose type is WowzaStreamTarget can be geo-blocked. For more information see the technical article How to geo-block stream targets by using the Wowza Streaming Cloud REST API.
wowza.createStreamTargetGeoblock({
"stream_target_id": "",
"geoblock": null
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - geoblock required geoblock_create_input
- stream_target_id required
Output
- output
object
- geoblock required geoblock
listStreamTargetProperties
This operation shows the details of all of the properties assigned to a specific stream target. Properties can be applied to a CustomStreamTarget or WowzaStreamTarget whose provider is akamai_cupertino.
wowza.listStreamTargetProperties({
"stream_target_id": ""
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- stream_target_id required
Output
- output stream_target_properties
createStreamTargetProperty
This operation creates a property for a stream target. Properties can be applied to a CustomStreamTarget or WowzaStreamTarget whose provider is akamai_cupertino. For more information see the technical article How to set advanced properties by using the Wowza Streaming Cloud REST API.
wowza.createStreamTargetProperty({
"stream_target_id": "",
"property": {
"property": {
"section": "",
"key": "",
"value": ""
}
}
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - property required stream_target_property_create_input
- stream_target_id required
Output
- output
object
- property required stream_target_property
deleteStreamTargetProperty
This operation removes a property from a stream target.
wowza.deleteStreamTargetProperty({
"stream_target_id": "",
"id": ""
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - id required
string
: The unique string that identifies the stream target property. The string contains the section and the key, connected by a dash. For example, hls-chunkSize.
- stream_target_id required
Output
Output schema unknown
showStreamTargetProperty
This operation shows the details of a specific property assigned to a specific stream target. Properties can be applied to a CustomStreamTarget or WowzaStreamTarget whose provider is akamai_cupertino.
wowza.showStreamTargetProperty({
"stream_target_id": "",
"id": ""
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - id required
string
: The unique string that identifies the stream target property. The string contains the section and the key, connected by a dash. For example, hls-chunkSize.
- stream_target_id required
Output
- output
object
- property required stream_target_property
showStreamTargetTokenAuth
This operation shows the details of the token authorization applied to a stream target. Only stream targets whose type is WowzaStreamTarget can use token authorization.
wowza.showStreamTargetTokenAuth({
"stream_target_id": ""
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- stream_target_id required
Output
- output
object
- token_auth required token_auth
updateStreamTargetTokenAuth
This operation updates the token authorization applied to a stream target. Only stream targets whose type is WowzaStreamTarget can use token authorization.
wowza.updateStreamTargetTokenAuth({
"stream_target_id": "",
"token_auth": {
"token_auth": {}
}
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - token_auth required token_auth_update_input
- stream_target_id required
Output
- output
object
- token_auth required token_auth
createStreamTargetTokenAuth
This operation creates token authorization for a stream target. Only stream targets whose type is WowzaStreamTarget can use token authorization. For more information see the technical article How to protect stream targets with token authorization by using the Wowza Streaming Cloud REST API.
wowza.createStreamTargetTokenAuth({
"stream_target_id": "",
"token_auth": {
"token_auth": {
"enabled": true,
"trusted_shared_secret": ""
}
}
}, context)
Input
- input
object
- stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - token_auth required token_auth_create_input
- stream_target_id required
Output
- output
object
- token_auth required token_auth
listTranscoders
This operation shows the details of all of your transcoders.
wowza.listTranscoders({}, context)
Input
- input
object
- page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- page
Output
- output transcoders
createTranscoder
This operation creates a transcoder.
wowza.createTranscoder({
"transcoder": {
"transcoder": {
"name": "",
"transcoder_type": "",
"billing_mode": "",
"broadcast_location": "",
"protocol": "",
"delivery_method": ""
}
}
}, context)
Input
- input
object
- transcoder required transcoder_create_input
Output
- output
object
- transcoder required transcoder
deleteTranscoder
This operation deletes a transcoder, including all of its assigned output renditions and stream targets.
wowza.deleteTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
Output schema unknown
showTranscoder
This operation shows the details of a specific transcoder.
wowza.showTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required transcoder
updateTranscoder
This operation updates a transcoder.
wowza.updateTranscoder({
"id": "",
"transcoder": {
"transcoder": {
"name": "",
"protocol": "",
"delivery_method": ""
}
}
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder. - transcoder required transcoder_update_input
- id required
Output
- output
object
- transcoder required transcoder
disableAllStreamTargetsTranscoder
This operation disables all of the stream targets assigned to a specific transcoder.
wowza.disableAllStreamTargetsTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- stream_targets required
object
- state
string
(values: enabled, disabled): The state of the transcoder's stream targets.
- state
- stream_targets required
- transcoder required
enableAllStreamTargetsTranscoder
This operation enables all of the stream targets assigned to a specific transcoder.
wowza.enableAllStreamTargetsTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- stream_targets required
object
- state
string
(values: enabled, disabled): The state of the transcoder's stream targets.
- state
- stream_targets required
- transcoder required
listTranscoderRecordings
This operation shows the details of all of the recordings for a specific transcoder.
wowza.listTranscoderRecordings({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- recordings
array
: Array of recordings of this transcoder. See /recordings for more details.- items recording
- recordings
- transcoder required
resetTranscoder
This operation resets a transcoder.
wowza.resetTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- state
string
(values: starting, stopping, started, stopped, resetting): The state of the transcoder.
- state
- transcoder required
listTranscoderSchedules
This operation shows the details of all of the schedules for a specific transcoder.
wowza.listTranscoderSchedules({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- schedules
array
: Array of schedules of this transcoder. See /schedules for more details.- items schedule
- schedules
- transcoder required
startTranscoder
This operation starts a transcoder.
wowza.startTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- state
string
(values: starting, stopping, started, stopped, resetting): The state of the transcoder. - transcoding_uptime_id
string
: The transcoding_uptime_id parameter is deprecated and is replaced by uptime_id. The unique identifier associated with a specific uptime period of a transcoder.
- state
- transcoder required
showTranscoderState
This operation shows the current state and uptime ID of a transcoder.
wowza.showTranscoderState({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- state
string
(values: starting, stopping, started, stopped, resetting): The state of the transcoder. - transcoding_uptime_id
string
: The transcoding_uptime_id parameter is deprecated and is replaced by uptime_id. The unique identifier associated with a specific uptime period of a transcoder. - uptime_id
string
: The unique identifier associated with a specific uptime period of a transcoder.
- state
- transcoder required
showTranscoderStats
This operation responds with a hash of metrics (keys) for a currently running transcoder. Each key has a status, text (description), units, and value.
wowza.showTranscoderStats({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required shm_metrics
stopTranscoder
This operation stops a transcoder.
wowza.stopTranscoder({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- state
string
(values: starting, stopping, started, stopped, resetting): The state of the transcoder. - transcoding_uptime_id
string
: The transcoding_uptime_id parameter is deprecated and is replaced by uptime_id. The unique identifier associated with a specific uptime period of a transcoder.
- state
- transcoder required
showTranscoderThumbnailUrl
This operation shows the thumbnail URL of a started transcoder.
wowza.showTranscoderThumbnailUrl({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the transcoder.
- id required
Output
- output
object
- transcoder required
object
- thumbnail_url
string
: The URL to receive the preview thumbnail.
- thumbnail_url
- transcoder required
listTranscoderOutputs
This operation shows the details of all of the output renditions of a specific transcoder.
wowza.listTranscoderOutputs({
"transcoder_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder.
- transcoder_id required
Output
- output outputs
createTranscoderOutput
This operation creates an output rendition for a specific transcoder.
wowza.createTranscoderOutput({
"transcoder_id": "",
"output": null
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output required output_create_input
- transcoder_id required
Output
- output
object
- output required output
deleteTranscoderOutput
This operation deletes an output, including all of its assigned targets.
wowza.deleteTranscoderOutput({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the output rendition.
- transcoder_id required
Output
Output schema unknown
showTranscoderOutput
This operation shows the details of a specific output rendition for a specific transcoder.
wowza.showTranscoderOutput({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the output rendition.
- transcoder_id required
Output
- output
object
- output required output
updateTranscoderOutput
This operation updates an output rendition.
wowza.updateTranscoderOutput({
"transcoder_id": "",
"id": "",
"output": null
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the output rendition. - output required output_update_input
- transcoder_id required
Output
- output
object
- output required output
addStreamTargetToTranscoderOutput
The operation POST /transcoders/{transcoder_id}/outputs/{id}/add_stream_target is deprecated. Use POST /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets to add an existing stream target to an output.
wowza.addStreamTargetToTranscoderOutput({
"transcoder_id": "",
"id": "",
"output_stream_target": {
"output_stream_target": {
"stream_target_id": ""
}
}
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the output rendition. - output_stream_target required output_add_stream_target_input
- transcoder_id required
Output
- output
object
- output_stream_target required output_stream_target
removeStreamTargetToTranscoderOutput
The operation DELETE /transcoders/{transcoder_id}/outputs/{id}/remove_stream_target is deprecated. Use DELETE /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{id} to remove a stream target from an output.
wowza.removeStreamTargetToTranscoderOutput({
"transcoder_id": "",
"id": "",
"output_stream_target": {
"output_stream_target": {
"stream_target_id": ""
}
}
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the output rendition. - output_stream_target required output_remove_stream_target_input
- transcoder_id required
Output
Output schema unknown
listTranscoderOutputOutputStreamTargets
This operation shows the details of all of the output stream targets of an output of a transcoder.
wowza.listTranscoderOutputOutputStreamTargets({
"transcoder_id": "",
"output_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition.
- transcoder_id required
Output
- output output_stream_target
createTranscoderOutputOutputStreamTarget
This operation creates an output stream target. Targets whose type is UltraLowLatencyStreamTarget can't be added to output renditions.
wowza.createTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"output_stream_target": null
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - output_stream_target required output_stream_target_create_input
- transcoder_id required
Output
- output
object
- output_stream_target required output_stream_target
deleteTranscoderOutputOutputStreamTarget
This operation deletes an output stream target, including all of its assigned targets.
wowza.deleteTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- transcoder_id required
Output
Output schema unknown
showTranscoderOutputOutputStreamTarget
This operation shows the details of an output stream target.
wowza.showTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- transcoder_id required
Output
- output
object
- output_stream_target required output_stream_target
updateTranscoderOutputOutputStreamTarget
This operation updates an output stream target.
wowza.updateTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": "",
"output_stream_target": null
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target. - output_stream_target required output_stream_target_update_input
- transcoder_id required
Output
- output
object
- output_stream_target required output_stream_target
disableTranscoderOutputOutputStreamTarget
This operation disables an output stream target.
wowza.disableTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- transcoder_id required
Output
- output
object
- stream_target required
object
- state
string
(values: enabled, disabled, restarted): The state of the output stream target.
- state
- stream_target required
enableTranscoderOutputOutputStreamTarget
This operation enables an output stream target.
wowza.enableTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- transcoder_id required
Output
- output
object
- stream_target required
object
- state
string
(values: enabled, disabled, restarted): The state of the output stream target.
- state
- stream_target required
restartTranscoderOutputOutputStreamTarget
This operation restarts an output stream target.
wowza.restartTranscoderOutputOutputStreamTarget({
"transcoder_id": "",
"output_id": "",
"stream_target_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - output_id required
string
: The unique alphanumeric string that identifies the output rendition. - stream_target_id required
string
: The unique alphanumeric string that identifies the stream target.
- transcoder_id required
Output
- output
object
- stream_target required
object
- state
string
(values: enabled, disabled, restarted): The state of the output stream target.
- state
- stream_target required
listTranscoderProperties
This operation shows all of the properties of a specific transcoder.
wowza.listTranscoderProperties({
"transcoder_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder.
- transcoder_id required
Output
- output transcoder_properties
createTranscoderProperty
This operation creates a property for a transcoder. For more information see the technical article How to set advanced properties by using the Wowza Streaming Cloud REST API.
wowza.createTranscoderProperty({
"transcoder_id": "",
"property": {
"property": {
"section": "",
"key": "",
"value": ""
}
}
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - property required transcoder_property_create_input
- transcoder_id required
Output
- output
object
- property required transcoder_property
deleteTranscoderProperty
This operation deletes a specific property from a specific transcoder.
wowza.deleteTranscoderProperty({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, cupertino-cupertinoProgramDateTimeOffset.
- transcoder_id required
Output
Output schema unknown
showTranscoderProperty
This operation shows the details of a specific property for a specific transcoder.
wowza.showTranscoderProperty({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, cupertino-cupertinoProgramDateTimeOffset.
- transcoder_id required
Output
- output
object
- property required transcoder_property
indexUptimes
This operation shows all of the uptime records for a specific transcoder. An uptime record identifies a specific transcoding session.
wowza.indexUptimes({
"transcoder_id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - page
integer
: Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed first. Next and Previous links allow you to navigate multiple pages of results. Omit the page parameter or specify an integer that's less than or equal to 0 to view all (unpaginated) results. - per_page
integer
: For use with the page parameter. Indicates how many records should be included on each page of results. A valid value is any positive integer. The default is 10.
- transcoder_id required
Output
- output uptimes
showUptime
This operation shows the details of a specific uptime record for a specific transcoder. An uptime record identifies a transcoding session.
wowza.showUptime({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the uptime record.
- transcoder_id required
Output
- output uptime
showUptimeMetricsCurrent
This operation returns a snapshot of the current source connection and processing details of an active (running) transcoder.
wowza.showUptimeMetricsCurrent({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the uptime record. - fields
string
: A comma-separated list of fields to return.
- transcoder_id required
Output
- output
object
- current required shm_metrics
- limits required
object
- fields required
string
: A comma-separated list of fields that were returned in the request.
- fields required
showUptimeMetricsHistoric
This operation shows the historic source connection and processing details for a transcoding session (uptime record). The transcoder can be running or stopped. Metrics are recorded every 20 seconds.
wowza.showUptimeMetricsHistoric({
"transcoder_id": "",
"id": ""
}, context)
Input
- input
object
- transcoder_id required
string
: The unique alphanumeric string that identifies the transcoder. - id required
string
: The unique alphanumeric string that identifies the uptime record. - fields
string
: A comma-separated list of fields to return. - from
string
: The start of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC. - to
string
: The end of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.
- transcoder_id required
Output
- output
object
- historic required
array
- items shm_historic_metrics
- limits required
object
- fields required
string
: A comma-separated list of fields that were returned in the request. - from required
string
: The start of range of time when the metrics were aggregated for the query. - to required
string
: The end of the range of time when the metrics were aggregated for the query.
- fields required
- historic required
usageNetworkStreamSourcesIndex
This operation shows the amount of network usage for all stream sources in the account. The default time frame is from the last billing date to the end of the current day.
wowza.usageNetworkStreamSourcesIndex({}, context)
Input
- input
object
- from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The to default is the end of the current day.
- from
Output
- output usage_network_stream_sources
usageNetworkStreamTargetsIndex
This operation shows the amount of network usage for all stream targets in the account cumulatively and individually. The default time frame is from the last billing date to the end of the current day.
wowza.usageNetworkStreamTargetsIndex({}, context)
Input
- input
object
- from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The to default is the end of the current day.
- from
Output
- output usage_network_stream_targets
usageNetworkTranscodersIndex
This operation shows the amount of network usage (egress) for all transcoders in the account. The default time frame is from the last billing date to the end of the current day.
wowza.usageNetworkTranscodersIndex({}, context)
Input
- input
object
- from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The to default is the end of the current day. - transcoder_type
string
(values: transcoded, passthrough): The type of transcoder. The default is transcoded. - billing_mode
string
(values: pay_as_you_go, twentyfour_seven): The billing mode for the transcoder. The default is pay_as_you_go.
- from
Output
- output usage_network_transcoders
usageStoragePeakRecordingIndex
This operation shows the amount of peak recording storage used for the account. The default time frame is from the last billing date to the end of the current day.
wowza.usageStoragePeakRecordingIndex({}, context)
Input
- input
object
- from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The to default is the end of the current day.
- from
Output
- output usage_storage_peak_recording
usageTimeTranscodersIndex
This operation shows the amount of stream processing time used by all transcoders in the account. The default time frame is from the last billing date to the end of the current day.
wowza.usageTimeTranscodersIndex({}, context)
Input
- input
object
- from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The to default is the end of the current day. - transcoder_type
string
(values: transcoded, passthrough): The type of transcoder. The default is transcoded. - billing_mode
string
(values: pay_as_you_go, twentyfour_seven): The billing mode for the transcoder. The default is pay_as_you_go.
- from
Output
- output usage_time_transcoders
showViewerDataStreamTarget
This operation shows viewer data for a specific stream target. The default time frame is from the last billing date to the end of the current day.
wowza.showViewerDataStreamTarget({
"id": ""
}, context)
Input
- input
object
- id required
string
: The unique alphanumeric string that identifies the stream target. - from
string
: The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The from default is the last billing date. - to
string
: The end of the range of
- id required