# Player Options

You can configure ByteArk Player through the options object passed when creating the player.

# Common options

Name Type Default Description
autoplay Boolean/String - Automatically start playback. See Autoplay for details.
autoplayadsmuted Boolean false Allow muted autoplay when a preroll ad is present. See Autoplay.
audioOnlyMode Boolean false When true, hide UI except the control bar. Useful for audio-only playback.
audioPosterMode Boolean false When true, show the poster image instead of video. Useful for audio-only playback.
muted Boolean - Start playback muted.
volume Number - Volume level between 0 and 1.
aspectRatio String - Video aspect ratio (e.g., 16:9). Used with fluid: true.
controls Boolean true Show or hide the control bar.
fluid Boolean - Use fluid layout (player expands to fill its container).
loop Boolean - Restart playback when the video ends.
playsinline Boolean true Display video inline.
preload String - Whether the browser should preload the video. Values: auto (preload immediately if supported), none (no preload until play).
liveui Boolean - Show/hide the seek bar during DVR live streams.
autoSeekToLiveEdge Boolean - Seek to the live edge after pause/resume during live playback.
closedCaptionButton Boolean false Show the closed-caption/subtitle button if the video has captions.
downloadUrl String - Show a download button on the control bar when a download URL is provided.
poster String - URL of the poster image displayed before playback.
sources Object/Array - Video source(s) to play. See Source object.
plugins Object - Plugins that extend ByteArk Player.
errors Object - Custom images for HTTP error codes. See error object.
xhrSetup Function - XHR setup function: (xhr: XMLHttpRequest, url: string) => void.

Note

Because ByteArk Player is built on Video.js, you can use any Video.js options as well. See the Video.js options reference (opens new window) for the complete list.

# Source object

Name Type Required Description
src String Yes URL of the video
type String Yes Video MIME type
title String No Video title shown on the player. Required when using ByteArk Lighthouse.
subtitle String No Episode or short description
videoId String No Video ID in the ByteArk system. Required when using ByteArk Lighthouse.
poster String No Poster image URL for this source