Streamio API Documentation

Players - Create

Create a player on your account with the specified parameters. Don't forget to specify POST as the request method as GET will call the list action rather than create.

Request

Url

https://streamio.com/api/v1/players.format

Request Method

POST

Parameters

  • title The title of the player.
  • tags The tags you wish to set for the player. Multiple tags are separated by comma.
  • width The width in pixels to be used when publishing in an iframe.
  • height The height in pixels to be used when publishing in an iframe. Required for playlist players. If left blank on non playlist players the video publishing interface will calculate an appropriate height for the video.
  • skin Can be one of two available skin files (called color themes in the interface). Use goplayer-white-skin.swf for white or goplayer-skin.swf for black. Default is goplayer-skin.swf.
  • loop Set to true if you want the player to loop the video. Valid values are true or false. Defaults to false.
  • autoplay Set to true if you want the player to start playing the video on page load. Valid values are true or false. Defaults to false.
  • enable_rtmp Set to true if you want the player to start use rtmp streaming instead of progressive http download. Only possible when client supports flash. Valid values are true or false. Defaults to false.
  • show_title Toggles the visibility of the video title. Valid values are true or false. Defaults to false.
  • show_play_pause_button Toggles the visibility of the play/pause button. Valid values are true or false. Defaults to true.
  • show_elapsed_time Toggles the visibility of the elapsed time text. Valid values are true or false. Defaults to true.
  • show_seek_bar Toggles the visibility of the player seek bar. Valid values are true or false. Defaults to true.
  • show_total_time Toggles the visibility of the total video duration. Valid values are true or false. Defaults to true.
  • show_volume_control Toggles the visibility of the volume control. Valid values are true or false. Defaults to true.
  • show_full_screen_button Toggles the visibility of the full screen button. Valid values are true or false. Defaults to true.
  • show_share_button Toggles the visibility of the share button. Valid values are true or false. Defaults to false.
  • show_large_play_button Toggles the visibility of the large play button in the center of the player. Valid values are true or false. Defaults to true.
  • google_analytics_property_id Google Analytics property id to enable sending stats to Google Analytics.
  • smartclip_preroll_url Url for prerolls from smartclip for the flash player.
  • smartclip_html5_preroll_url Url for prerolls from smartclip for iPad / iPhone.
  • playlist Set to true if you want the player to behave as a Playlist Player. Valid values are true or false. Defaults to false.
  • limit The number of videos to display per page when using pagination on playlist players. Required only for playlist players.
  • css The stylesheet to be used when publishing. Only for playlist players.
  • playlist_template_id The id of a player template to use for the design of the player. Will override width, height, limit and css if specified. As player templates can not be queried through the API the most common use case for this attribute is to set it to a blank (empty string) value in order for css updates etc to take effect. Is blank by default.

Response

Code

201

Body

Examples

A simple create

Give it a title and the rest works out through default values.

curl -u username:password \
     -F title="My awesome player" \
     https://streamio.com/api/v1/players.json