Rebuild player code

Live Streams

Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.

Operations

Players

Operations related to players, which are created through the /live_streams resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video.

Operations

Update a player

Request

This operation updates a player.

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.

Path

idstringrequired

The unique alphanumeric string that identifies the player.

Bodyapplication/jsonrequired

Provide the details of the player to update in the body of the request.

playerobject(player)required

Example: {"hosted_page":{"title":"My Updated Hosted Page"},"responsive":true}

player.customizationsobject

Configuration of the player customizations.

player.countdownboolean

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": true

Example: true

player.countdown_atstring(date-time)

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: "countdown_at": "2020-02-01T17:00:00.000Z"

Example: "2020-02-01T17:00:00.000Z"

player.hosted_pageobject(hosted_page_request_object)

Configuration of the hosted page.

player.logo_imagestring

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.

Example: "logo_image": "[Base64-encoded string representation of an image]"

Example: "[Base64-encoded string representation of an image]"

player.logo_positionstring

The corner of the player in which you want the player logo to appear. The default is top-left.

Example: "logo_position": "top-left"

Example: "top-left"

player.pluginsobject

Configuration of the plugins.

player.remove_logo_imageboolean

If true, removes the logo file from the output. The default is false.

Example: "remove_logo_image": true

Example: true

player.remove_video_poster_imageboolean

If true, removes the poster image from the output. The default is false.

Example: "remove_video_poster_image": true

Example: true

player.responsiveboolean

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: "responsive": true

Example: true

player.typestring

The player you want to use.

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.

The 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 if you embed it in your site.

Note: If you update a live stream from original_html5 or wowza_player to wowza_flowplayer, it cannot be changed later.

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: "type": "wowza_flowplayer"

Example: "wowza_flowplayer"

player.video_poster_imagestring

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.

Example: "video_poster_image": "[Base64-encoded string representation of an image]"

Example: "[Base64-encoded string representation of an image]"

player.widthinteger(int32)

The width, in pixels, of a fixed-size player. The default is 640.

Example: "width": 640

Example: 640

curl -i -X PATCH \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/players/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "player": {
      "hosted_page": {
        "title": "My Updated Hosted Page"
      },
      "responsive": true
    }
  }'

Responses

Success

Bodyapplication/json

playerobject(player)required

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.customizationsobject

Configuration of the player customizations.

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.

Example: {"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"}

player.countdownboolean

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: true

player.countdown_atstring(date-time)

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: "2020-02-01T17:00:00.000Z"

player.created_atstring(date-time)

The date and time that the player was created.

Example: "2020-01-29T17:16:21.968Z"

player.embed_codestring

The HTML code that can be used in an external webpage to host the Wowza Flowplayer.

Example: ""

player.hls_playback_urlstring

The address that can be used to configure playback of the stream using the HLS protocol.

Example: "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"

player.hosted_pageobject(hosted_page_response_object)

Configuration of the hosted page.

player.idstring

The unique alphanumeric string that identifies the player.

Example: "e8dk5bf6"

player.logo_image_urlstring

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: "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg"

player.logo_positionstring

The corner of the player in which you want the player logo to appear. The default is top-left.

Example: "top-right"

player.pluginsobject

Configuration of the plugins.

Example: {"airplay":false,"chromecast":false}

player.responsiveboolean

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: ""

player.transcoder_idstring

The unique alphanumeric string that identifies the transcoder.

Example: "6Qbymbbq"

player.typestring

The player you want to use.

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.

The 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 if you embed it in your site.

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: "wowza_flowplayer"

player.updated_atstring(date-time)

The date and time that the player was updated.

Example: "2020-01-31T16:08:26.990Z"

player.video_poster_image_urlstring

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: "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg"

player.widthinteger(int32)

The width, in pixels, of a fixed-size player. The default is 640.

Example: 640

Response

application/json

{
  "player": {
    "customizations": { … },
    "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": { … },
    "id": "e8dk5bf6",
    "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
    "logo_position": "top-right",
    "plugins": { … },
    "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
  }
}

Rebuild player code

Request

This operation rebuilds the player with the current configuration.

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.

Path

idstringrequired

The unique alphanumeric string that identifies the player.

curl -i -X POST \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/players/{id}/rebuild'

Responses

Success

Bodyapplication/json

playerobject(player)required

player.statestring

The state of the player.

Enum"requested""already_requested""activated"

Example: "requested"

Response

application/json

{
  "player": {
    "state": "requested"
  }
}

Fetch the state of a player

Request

This operation shows the current state of a player.

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.

Path

idstringrequired

The unique alphanumeric string that identifies the player.

curl -i -X GET \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/players/{id}/state'

Responses

Success

Bodyapplication/json

playerobject(player)required

player.statestring

The state of the player.

Enum"requested""activated"

Example: "activated"

Response

application/json

{
  "player": {
    "state": "activated"
  }
}

Transcoders

Operations related to transcoders, output renditions, and output stream targets.

Operations

Stream Sources

Operations related to stream sources. You can create a Wowza stream source and associate it to a live stream or transcoder.

Operations

Stream Targets

Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Video edge resources; custom, external destinations target destinations.

Operations

Assets

Operations related to assets, which are created through the /assets resources. The Wowza Video service can store and transcode mp4 files that you can tag, manage, and restream.

Operations

Recordings

Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.

Operations

Schedules

Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.

Operations

VOD Streams

Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.

Operations

Real-Time Streams

Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.

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.

Operations

Viewers

Operations related to viewer analytics.

Operations

Ingest

Operations related to ingest analytics for a live stream.

Operations

Engagement

Operations related to engagement analytics for a VOD stream.

Operations

Popularity

Operations related to popularity analytics.

Operations

Account

Operations related to stream analytics for an account.

Operations

Transcoders

Operations related to transcoder analytics.

Operations

Stream Targets

Operations related to stream target analytics, including CDN usage and viewer data.

Operations

Storage

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.

Operations

VOD Streams

Operations related to video on demand (VOD) stream analytics.

Operations

Real Time Streams

Operations related to real-time streams analytics.

Operations

Live Streams

Players

Update a player

Request

Responses

Was this helpful?

Rebuild player code

Request

Responses

Was this helpful?

Fetch the state of a player

Request

Responses

Was this helpful?

Transcoders

Stream Sources

Stream Targets

Assets

Recordings

Schedules

VOD Streams

Real-Time Streams

Viewers

Ingest

Engagement

Popularity

Account

Transcoders

Stream Targets

Storage

VOD Streams

Real Time Streams

Live Streams

Players

Update a player

RequestExpand all

Responses

Was this helpful?

Rebuild player code

Request

Responses

Was this helpful?

Fetch the state of a player

Request

Responses

Was this helpful?

Transcoders

Stream Sources

Stream Targets

Assets

Recordings

Schedules

VOD Streams

Real-Time Streams

Viewers

Ingest

Engagement

Popularity

Account

Transcoders

Stream Targets

Storage

VOD Streams

Real Time Streams

Request