Use Wowza Player configuration properties to customize a WowzaPlayer instance before embedding into a webpage. Certain configuration properties are required in the ConfigJSON parameter of the WowzaPlayer.create method, but most are optional. Use the following available configuration properties to configure and customize Wowza Player.
|license||string||(Required) Sets your Wowza Player license key (with dashes) to authorize player use.|
|sourceURL||string||(Required) Sets the full Apple HLS URL of your live or on-demand stream or the full WebSocket URL for your ultra low latency stream.|
|sources||array||(Required if using multiple sourceURL values) Sets an array of sourceURL values for fallback purposes. If Wowza Player is unable to connect to the first sourceURL value after three tries, it falls back to the second sourceURL value.
Note: You must set a source using either a single sourceURL or a sources array with multiple sourceURLs.
|abrAutoSwitching||Boolean||Toggles between manual and automatic adaptive bitrate switching. The default value is true, which makes Wowza Player select the highest quality bitrate that works best with your viewers' connections.|
|abrStartingBitrate||string||Determines how the player dynamically selects a bitrate when the stream begins (first, lowest, or highest). The default value is first.|
|audioOnly||Boolean||Specifies whether to use the audio-only version of Wowza Player. Set to true to use the audio-only version.|
|endPosterFrameURL||string||Specifies a URL for a static poster image to display in the player after the video plays. Use a JPG or PNG images that is close to the size of the player. Poster images can't be added to the audio-only player.|
|endTime||integer||Sets the time, in milliseconds, to end clip playback. A value of -1 specifies no clip end time.|
|debugLevel||string||Specifies the error message type to display in the browser console. OFF, ERROR, WARN, INFO, DEBUG. The default value is INFO.|
|description||string||Sets the description that appears when the viewer clicks on the video Title. Not available in audio-only mode.|
|loop||Boolean||Specifies whether to loop a VOD video. Set to true to replay the video after it ends.|
|mute||Boolean||Specifies whether to mute the video. Set to true to start playback with muted audio.|
|posterFrameURL||string||Specifies a URL for a static poster image to display in the player before the video plays. Use a JPG or PNG image that is close to the size of the player. Poster images can't be added to the audio-only player.|
|startTime||integer||Sets the time, in milliseconds, to begin clip playback. Set to 0 to play for the original start of the clip.|
|title||string||Sets the title that displays in the top-left corner of the player Action bar on mouse hover.|
|uiBackgroundColor||string||Sets the RGB background color of the player using a hexidecimal color value with the format 0x000000. Default value is #000000 (black). This color is seen if the player applies letterboxing (spacing) to the video or if no poster images are selected.|
|uiPosterFrameFillMode||string||Specifies how to format poster images. The aspect ratio of the image is maintained in both settings.
Enter fit to resize the poster image so the larger side of the image matches the size of the player, ensuring the entire image fits within the player. Black bars may appear to fill extra space.
Enter fill to resize the poster image so the shorter side of the image matches the size of the player, ensuring the image fills the entire player.
|uiShowBitrateSelector||Boolean||Includes the Bitrate Selector button in the player interface if set to the default, true. This allows the viewer to select the desired video bitrate. Set to false to hide the Bitrate Selector button.
Bitrate names are displayed based on the NAME values from your stream's SMIL file or calculated from the source media if you aren't using a SMIL file. By default, the player selects the highest quality bitrate that works best with the viewer's connection. This behavior is set with the abrStartingBitrate property. To learn how to customize the Bitrate Selector menu, see Customize video quality choices for adaptive bitrate streams in Wowza Player.
|uiShowDurationVsTimeRemaining||Boolean||Specifies where to display the elapsed time. Set to true to display the elapsed time of the video in the player on the left side of the Seek bar. Set to false to display the time remaining in the video on the left side of the Seek bar in the player interface.|
|uiShowFullscreen||Boolean||Includes the Full Screen icon in the player interface when set to the default, true. Set to false to hide the Full Screen icon.|
|uiShowQuickRewind||Boolean||Includes the Quick Rewind button in the player interface when set to the default, true. By default, clicking Quick Rewind rewinds video playback by 30 seconds. To set a custom value, use uiQuickRewindSeconds.|
|uiQuickRewindSeconds||integer||Sets the number of seconds that the player rewinds when a viewer clicks the Quick Rewind button. The default is 30.|
|volume||integer||Sets the starting volume of the video, although the viewer may also adjust the volume in the embedded player. The default value is 75 percent of maximum volume. Values range from 0 to 100.|
|withCredentials||Boolean||Specifies whether Wowza Player is enabled to make cross-site Access-Control requests using credentials such as cookies. Set to true to enable this functionality.
This enables Wowza Player to play streams secured with Wowza Streaming Engine SecureToken, Wowza Streaming Cloud token authorization, or Akamai CDN token authentication. To learn more, see Protect streaming using SecureToken in Wowza Streaming Engine or Protect a Wowza CDN stream target with token authorization in Wowza Streaming Cloud.
|flashWmode||string||Sets the Flash video Window Mode for transparency, layering, positioning, and rendering in the browser. Options are window, direct, opaque, transparent, and GPU. The default value is direct.
Note: The direct option isn't compatible with Flash objects within a Bootstrap modal in Firefox. Use either opaque or transparent instead.
|flashQuality||string||Sets the Flash video quality. Options are low, autolow, autohigh, medium, high, and best. The default value is high.|
|useHardwareDecoding||Boolean||Uses graphics hardware to accelerate rendering, removing some burden from the CPU. The default value is true. This may be unavailable on certain platforms, browsers, or when certain flashWmode options are enabled.|
For more information on these settings, see Apply OBJECT and EMBED tag attributes in Adobe Flash Professional.
Customizable strings for Wowza Player localizationYou can use the following properties to change labels and messages that appear in the player UI for localization purposes.
|stringAuto||Auto||Sets the label for the option in the Bitrate Selector menu that allows the player to dynamically select the optimal bitrate based on the viewer's connection.|
|stringBuffering||Buffering...||Sets the message displayed when the stream is buffering.|
|stringCountdownTimerLabel||Time until show||Sets the message displayed above the stream event's countdown timer.|
|stringErrorStreamUnavailable||Stream Unavailable||Sets the message displayed when the player experiences an error with the stream (for example, when stream URL is incorrect).|
|stringErrorCORSStreamUnavailable||Stream unavailable. Check cross-origin policy||Sets the message displayed when a CORS error occurs when loading a stream. This typically means that Cross-Origin headers aren't enabled for Apple HLS streams in the Wowza Streaming Engine application. For details, see How to enable cross-origin resource sharing (CORS) for HTTP-based connections.|
|stringLiveLabel||LIVE||Sets the label to indicate live events in the player's Control bar.|
|stringLiveEventEnded||This live event has ended.||Sets the message displayed when the player detects that a live streaming event has ended.|
|stringLiveSeekAlt||Seek to LIVE||Sets the message displayed on mouseover when using DVR feature during a live broadcast.|