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.

Fetch all players

This operation shows limited details for all of your players. For detailed information, fetch a single player.

Request
query Parameters
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. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Video REST API.

per_page
integer

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses
200

Success

Response Schema: application/json
required
Array of objects (players)
Array
created_at
string <date-time>

The date and time that the player was created.

id
string

The unique alphanumeric string that identifies the player.

transcoder_id
string

The unique alphanumeric string that identifies the transcoder.

type
string

The player you want to use.

Wowza Video subscribers
Wowza Video Player (wowza_video_player) 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 Video Player is a robust, industry standard player that 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.

updated_at
string <date-time>

The date and time that the player was updated.

401

Unauthorized

get/players
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/players"
Response samples
application/json
{
  • "players": [
    ]
}

Fetch a player

This operation shows details of a specific player.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the player.

Responses
200

Success

Response Schema: application/json
required
object (player)
countdown
boolean

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.

countdown_at
string <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.

created_at
string <date-time>

The date and time that the player was created.

embed_code
string

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

hls_playback_url
string

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

hosted_page
boolean

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.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_logo_image_url
string

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.

hosted_page_sharing_icons
string

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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_url
string

The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.

id
string

The unique alphanumeric string that identifies the player.

logo_image_url
string

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.

logo_position
string

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

responsive
boolean

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.

transcoder_id
string

The unique alphanumeric string that identifies the transcoder.

type
string

The player you want to use.

Wowza Video subscribers
Wowza Video Player (wowza_video_player) 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 Video Player is a robust, industry standard player that 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.

updated_at
string <date-time>

The date and time that the player was updated.

video_poster_image_url
string

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.

width
integer <int32>

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

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/players/2adffc17"
Response samples
application/json
{}

Update a player

This operation updates a player.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the player.

Request Body schema: application/json

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

required
object (player)
countdown
boolean

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

countdown_at
string <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"

hosted_page
boolean

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

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

Example: "hosted_page_description": "My Hosted Page Description"

hosted_page_logo_image
string

A Base64-encoded string representation of 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.

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

hosted_page_sharing_icons
boolean

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

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

Example: "hosted_page_sharing_icons": "My Hosted Page"

logo_image
string

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

logo_position
string

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

Example: "logo_position": "top-left"

remove_hosted_page_logo_image
boolean

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

Example: "remove_hosted_page_logo_image": true

remove_logo_image
boolean

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

Example: "remove_logo_image": true

remove_video_poster_image
boolean

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

Example: "remove_video_poster_image": true

responsive
boolean

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

type
string

The player you want to use.

Wowza Video subscribers
Wowza Video Player (wowza_video_player) 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 Video Player is a robust, industry standard player that 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_video_player, 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_video_player"

video_poster_image
string

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

width
integer <int32>

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

Example: "width": 640

Responses
200

Success

Response Schema: application/json
required
object (player)
countdown
boolean

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.

countdown_at
string <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.

created_at
string <date-time>

The date and time that the player was created.

embed_code
string

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

hls_playback_url
string

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

hosted_page
boolean

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.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_logo_image_url
string

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.

hosted_page_sharing_icons
string

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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_url
string

The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.

id
string

The unique alphanumeric string that identifies the player.

logo_image_url
string

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.

logo_position
string

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

responsive
boolean

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.

transcoder_id
string

The unique alphanumeric string that identifies the transcoder.

type
string

The player you want to use.

Wowza Video subscribers
Wowza Video Player (wowza_video_player) 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 Video Player is a robust, industry standard player that 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.

updated_at
string <date-time>

The date and time that the player was updated.

video_poster_image_url
string

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.

width
integer <int32>

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

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/players/{id}
Request samples
application/json
{
  • "player": {
    }
}
Response samples
application/json
{}

Rebuild player code

This operation rebuilds the player with the current configuration.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the player.

Responses
200

Success

Response Schema: application/json
required
object (player)
state
string

The state of the player.

Enum: "requested" "already_requested" "activated"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

post/players/{id}/rebuild
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "POST" \
  "${WV_HOST}/api/v1.9/players/2adffc17/rebuild"
Response samples
application/json
{
  • "player": {
    }
}

Fetch the state of a player

This operation shows the current state of a player.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the player.

Responses
200

Success

Response Schema: application/json
required
object (player)
state
string

The state of the player.

Enum: "requested" "activated"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{id}/state
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/players/2adffc17/state"
Response samples
application/json
{
  • "player": {
    }
}

Create a player URL

This operation creates a new player URL.

Request
path Parameters
player_id
required
string

The unique alphanumeric string that identifies the player.

Request Body schema: application/json

Provide the details of the player URL to create in the body of the request.

required
object (url)
bitrate
integer <int32>

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.

height
integer <int32>

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.

label
string

A descriptive name for the player URL. Maximum 255 characters.

url
string

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.

width
integer <int32>

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.

Responses
200

Success

Response Schema: application/json
required
object (url)
bitrate
integer <int32>

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.

created_at
string <date-time>

The date and time that the player URL was created.

height
integer <int32>

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.

id
string

The unique alphanumeric string that identifies the player URL.

label
string

A descriptive name for the player URL. Maximum 255 characters.

player_id
string

The unique alphanumeric string that identifies the player.

updated_at
string <date-time>

The date and time that the player URL was updated.

url
string

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.

width
integer <int32>

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.

401

Unauthorized

422

Unprocessable Entity

post/players/{player_id}/urls
Request samples
application/json
{}
Response samples
application/json
{}

Fetch all player URLs

This operation shows the details of all player URLs.

Request
path Parameters
player_id
required
string

The unique alphanumeric string that identifies the player.

Responses
200

Success

Response Schema: application/json
required
Array of objects (url)
Array
bitrate
integer <int32>

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.

created_at
string <date-time>

The date and time that the player URL was created.

height
integer <int32>

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.

id
string

The unique alphanumeric string that identifies the player URL.

label
string

A descriptive name for the player URL. Maximum 255 characters.

player_id
string

The unique alphanumeric string that identifies the player.

updated_at
string <date-time>

The date and time that the player URL was updated.

url
string

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.

width
integer <int32>

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.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{player_id}/urls
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/players/2adffc17/urls"
Response samples
application/json
{}

Fetch a player URL

This operation shows the details of a player URL.

Request
path Parameters
player_id
required
string

The unique alphanumeric string that identifies the player.

id
required
string

The unique alphanumeric string that identifies the player URL.

Responses
200

Success

Response Schema: application/json
required
object (url)
bitrate
integer <int32>

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.

created_at
string <date-time>

The date and time that the player URL was created.

height
integer <int32>

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.

id
string

The unique alphanumeric string that identifies the player URL.

label
string

A descriptive name for the player URL. Maximum 255 characters.

player_id
string

The unique alphanumeric string that identifies the player.

updated_at
string <date-time>

The date and time that the player URL was updated.

url
string

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.

width
integer <int32>

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.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{player_id}/urls/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/players/2adffc17/urls/1acfg43d"
Response samples
application/json
{}

Update a player URL

This operation updates a player URL.

Request
path Parameters
player_id
required
string

The unique alphanumeric string that identifies the player.

id
required
string

The unique alphanumeric string that identifies the player URL.

Request Body schema: application/json

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

required
object (url)
bitrate
integer <int32>

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.

height
integer <int32>

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.

label
string

A descriptive name for the player URL. Maximum 255 characters.

url
string

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.

width
integer <int32>

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.

Responses
200

Success

Response Schema: application/json
required
object (url)
bitrate
integer <int32>

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.

created_at
string <date-time>

The date and time that the player URL was created.

height
integer <int32>

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.

id
string

The unique alphanumeric string that identifies the player URL.

label
string

A descriptive name for the player URL. Maximum 255 characters.

player_id
string

The unique alphanumeric string that identifies the player.

updated_at
string <date-time>

The date and time that the player URL was updated.

url
string

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.

width
integer <int32>

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.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/players/{player_id}/urls/{id}
Request samples
application/json
{}
Response samples
application/json
{}

Delete a player URL

This operation deletes a player URL.

Request
path Parameters
player_id
required
string

The unique alphanumeric string that identifies the player.

id
required
string

The unique alphanumeric string that identifies the player URL.

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/players/{player_id}/urls/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.9/players/2adffc17/urls/1acfg43d"
Response samples
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}
Copyright © Wowza Video. All right reserved.