Initialization
This section describes how to run OvenPlayer and explains various configuration options. Also, it includes a way to access an OvenPlayer instance.

Instance Methods

Running OvenPlayer

You need to obtain the OvenPlayer Instance to use the OvenPlayer API. You can typically use the OvenPlayer Instance returned after OvenPlayer.create(). However, we will inform you of some ways to access the OvenPlayer Instance in debugging or unexpected situations.

create()

1
const player = OvenPlayer.create(container, options);
Copied!
Request
Params
Type
Memo
container
String
DOM Element
options
Object
Please see the Options section below.

Accessing default instance

You run the player with the DOM Element and Options with ID. It returns the Instance of the player.
1
const player = OvenPlayer.create(...);
2
...
3
player.play();
Copied!

Viewing all instances within a web page

1
OvenPlayer.getPlayerList()
2
(3) [{}, {}, {}]
3
0: {on: ƒ, trigger: ƒ, off: ƒ, once: ƒ, init: ƒ,}
4
1: {on: ƒ, trigger: ƒ, off: ƒ, once: ƒ, init: ƒ,}
5
2: {on: ƒ, trigger: ƒ, off: ƒ, once: ƒ, init: ƒ,}
6
length: 3
Copied!
example
1
for(let i = 0 ; i < OvenPlayer.getPlayerList().length; i++){
2
OvenPlayer.getPlayerList()[i].pause();
3
}
Copied!

Querying a single instance using an index

1
OvenPlayer.getPlayerByIndex(0)
2
{on: ƒ, trigger: ƒ, off: ƒ, once: ƒ, init: ƒ, …}
Copied!
// example
1
if(OvenPlayer.getPlayerByIndex(0)){
2
OvenPlayer.getPlayerByIndex(0).pause();
3
}
Copied!

Querying a single instance using the DOM Element ID

1
OvenPlayer.getPlayerByContainerId("player")
2
{on: ƒ, trigger: ƒ, off: ƒ, once: ƒ, init: ƒ, …}
Copied!

Setting the log

You set up to show all logs that occur in the OvenPlayer that is on the web page.
1
OvenPlayer.debug(true);
Copied!

Options

You can use the following options to initialize the player:

aspectRatio

You can set the aspect ratio of the player to match the aspect ratio of the video playing. Any aspect ratio can be set such as "21: 9", "4: 3", "1: 1".
Type
Default
Required
String
'16:9'
false

title

You can display a title.
Type
Default
Required
String
null
false

waterMark

You can set the watermark image on the player. See the following for detailed settings.

Using watermark Image

1
// watermark example
2
var player = OvenPlayer.create("player", {
3
waterMark: {
4
image: '/path/to/watermark/image.png',
5
position: 'top-left',
6
y: '20px',
7
x: '20px'
8
width: '40px',
9
height: '30px',
10
opacity: 0.7
11
},
12
sources: [...]
13
});
Copied!

waterMark.image

Sets the URL of the watermark image.
Type
Default
Required
String
null
true

Using watermark text

1
// watermark example
2
var player = OvenPlayer.create("player", {
3
waterMark: {
4
text: 'Text for water mark',
5
font: {
6
'font-size': '20px',
7
'color': '#fff',
8
'font-weight': 'bold'
9
}
10
position: 'bottom-right'
11
},
12
sources: [...]
13
});
Copied!

waterMark.text

Sets the text of the watermark.
Type
Default
Required
String
null
true

waterMark.font

Sets the font style of the watermark text. All Font CSS key-value available (e.g. font-size, font-weight, color...)
Type
Default
Required
Object
null
false

Watermark common settings

waterMark.position

Sets the location where the watermark is placed. top-right, top-left, bottom-right, bottom-left are available.
Type
Default
Required
String
'top-right'
false
waterMark.y
Sets the distance from the top or bottom specified by waterMark.position. All CSS value available (e.g. 10px, 5%, 1rem...)
Type
Default
Required
String
5%
false
waterMark.x
Sets the distance from the left or right specified by waterMark.position. All CSS value available (e.g. 10px, 5%, 1rem...)
Type
Default
Required
String
2.8%
false
waterMark.width
Sets the width of the watermark image. The default value auto means set to the original width of the image. All CSS value available (e.g. 10px, 5%, 1rem...)
Type
Default
Required
String
auto
false
waterMark.height
Sets the height of the watermark image. The default value auto means set to the original height of the image. All CSS value available (e.g. 10px, 5%, 1rem...)
Type
Default
Required
String
auto
false
waterMark.opacity
Sets the URL of the watermark image.
Type
Default
Required
Number
0.7
false

autoStart

Type
Default
Required
boolean
false
false
You can choose whether to play OvenPlayer automatically when the source is loaded. However, depending on the Browser Policy, it may restrict autoplay at any time.

controls

Type
Default
Required
boolean
true
false
If you don't want to show the control bar on OvenPlayer, change this option to false.

loop

Type
Default
Required
boolean
false
false
You can play a video repeatedly using this option.

showBigPlayButton

Type
Default
Required
boolean
true
false
You can choose whether to show or hide the big play button.

disableSeekUI

Type
Default
Required
boolean
false
false
You can disable users to seek using a progress bar or keyboard interaction.

showSeekControl

Type
Default
Required
boolean
false
false
You can choose whether to show or hide the quick seek buttons.

seekControlInterval

pe
Default
Required
Number
10
false
You can set seek interval of the quickly seek button.

expandFullScreenUI

pe
Default
Required
boolean
false
false
You can enable users to enter or exit the full screen with double click the player.

mute

Type
Default
Required
boolean
false
false
If you set this option to true, it will run in mute mode.

timecode

Type
Default
Required
boolean
true
false
You set whether to display time or frame information in the control bar on OvenPlayer. Of course, framerate information is required when registering sources to display the correct frame information.

playbackRate

Type
Default
Required
Number
1
false
You can set the playback speed with this option.

playbackRates

Type
Default
Required
Array of Number
[2, 1.5, 1, 0.5, 0.25]
false
You can set the range of video playback speed. The playback speed range is 0.25 to 4x.

currentProtocolOnly

Type
Default
Required
Boolean
false
false
It shows only current protocols. (*If you want to show only quality information when there are various protocols and various quality information together, please use it.)

sources

Type
Default
Required
Object | Array of Object
-
true

source

You can register the URL of the content playback URL as shown below:
example
1
let player = OvenPlayer.create("player", {
2
type : "mp4",
3
file : "https://path.to/your_video",
4
label : "360P"
5
});
Copied!

sources

If you have multiple protocols or multiple resolutions for a single content, you can register them at once using sources. Also, multiple protocols can support a broader range of browsers, and multiple resolutions allow viewers to select video quality.
OvenPlayer will play a video in the order of the protocol or resolution you entered in sources and will automatically play the next source if playback fails.
example
1
let player = OvenPlayer.create("player", {sources : [
2
{
3
type : "mp4",
4
file : "https://path.to/your_video",
5
label : "360P"
6
},
7
{
8
type : "mpd",
9
file : "https://path.to/your_video.mpd",
10
label: "360P DASH"
11
},
12
{
13
type : "hls",
14
file : "https://path.to/your_video.m3u8",
15
label: "360P HLS"
16
},
17
{
18
type : "rtmp",
19
file : "rtmp://path.to/your_video",
20
label: "360P RTMP"
21
}
22
] });
Copied!

tracks

example
1
let player = OvenPlayer.create("player", {sources : {
2
type : "mp4",
3
file : "https://path.to/your_video",
4
label : "360P"
5
}});
Copied!
Type
Default
Required
Array of Object
-
false
You can register the URL information of the subtitle file shown with a video. OvenPlayer supports *.vtt, *.srt, and *.smi as subtitle file formats.
example
1
let player = OvenPlayer.create("player", {sources : {
2
type : "mp4",
3
file : "https://path.to/your_video",
4
label : "360P"
5
],
6
tracks : [
7
{
8
kind : "captions",
9
file : "https://path.to/your_caption.vtt",
10
label : "KO vtt"
11
},
12
{
13
kind : "captions",
14
file : "https://path.to/your_caption.srt",
15
label : "KO srt"
16
},
17
{
18
kind : "captions",
19
file : "https://path.to/your_caption.smi",
20
label : "KO smi"
21
}
22
]
23
});
Copied!

section

You can cut the playback before the time of sectionStart and cuts the playback after the time of sectionEnd. The example below will only play between 300 seconds to 600 seconds of the stream.
1
sources: [
2
{
3
type: 'hls',
4
file: 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8',
5
sectionStart: 300,
6
sectionStart: 600,
7
}
8
]
Copied!

volume

Type
Default
Required
Number
100
false
You can set the initial volume when a user plays a video in OvenPlayer.

adTagUrl

Type
Default
Required
String
-
false
You can set the URL of the Video Ad Serving Template (VAST) to play in OvenPlayer. Also, OvenPlayer supports VAST 4, VAST 3, VAST 2, VPAID 2 (HTML 5), and VMAP 1.0.1.
For more information, see Support and Compatibility.
example
1
let player = OvenPlayer.create("player", {
2
adTagUrl : "https://pubads.g.doubleclick.net/gampad/ads?...",
3
sources : {
4
type : "mp4",
5
file : "https://path.to/your_video",
6
label : "360P"
7
]
8
});
Copied!

adClient

Type
Default
Required
String
"googleima"
false
Sets whether to Google IMA or Simple VAST the Ads client when player initialize. "googleima" or "vast".

playlist

Type
Default
Required
Array of Object
-
false
Field
Type
Default
Required
title
String
sources[0].label
false
image
String
-
false
duration
Number
-
false
adTagUrl
String
-
false
sources
Object | Array of Object
-
true
tracks
Array of Object
-
false
playlist has multiple sources mentioned above. You can explore between playlists, and it automatically plays the next content. Also, you can assign ads and captions for each playlist.
example
1
let player = OvenPlayer.create("player", {
2
playlist : [
3
{
4
title : "01",
5
adTagUrl : "https://pubads.g.doubleclick.net/gampad/ads?...",
6
image : "https://path.to/your_video_thumbnail.jpeg",
7
duration : 7343,
8
sources: [
9
{
10
type : "mp4",
11
file : "https://path.to/your_video",
12
label : "360P"
13
}
14
],
15
tracks: [
16
{
17
kind : "captions",
18
file : "https://path.to/your_caption.vtt",
19
label : "KO vtt"
20
}
21
]
22
},
23
{
24
title : "02",
25
adTagUrl : "https://pubads.g.doubleclick.net/gampad/ads?...",
26
image : "https://path.to/your_video_thumbnail2.jpeg",
27
duration : 8333,
28
sources: [
29
{
30
type : "mp4",
31
file : "https://path.to/your_video2",
32
label : "360P"
33
},
34
{
35
type : "mpd",
36
file : "https://path.to/your_video.mpd",
37
label: "360P DASH"
38
}
39
],
40
tracks: [
41
{
42
kind : "captions",
43
file : "https://path.to/your_caption2.vtt",
44
label : "KO vtt"
45
}
46
]
47
}
48
]
49
});
Copied!

hidePlaylistIcon

Type
Default
Required
boolean
false
false
You can set whether to show or hide the playlist button when the playlist is initialized.

loadingRetryCount

If set, HLS and DASH retry, reload source when an error occurs.
Type
Default
Required
number
0
false

webrtcConfig

When playing WebRTC, you can set WebRTC specific configurations.

webrtcConfig.iceServers

Type
Default
Required
Object
null
false
You can set a list of STUN or TURN servers.
1
let player = OvenPlayer.create("player", {
2
sources : [
3
{
4
type : "webrtc",
5
file : "ws://source"
6
}
7
],
8
webrtcConfig: {
9
iceServers: [
10
{
11
"urls": [
12
"stun:64.233.189.127:19302",
13
"stun:[2404:6800:4008:c07::7f]:19302"
14
]
15
},
16
{
17
"urls": [
18
"turn:108.177.125.127:19305?transport=udp",
19
"turn:[2404:6800:4008:c01::7f]:19305?transport=udp",
20
"turn:108.177.125.127:19305?transport=tcp",
21
"turn:[2404:6800:4008:c01::7f]:19305?transport=tcp"
22
],
23
"username": "username",
24
"credential": "credential"
25
}
26
]
27
}
28
);
Copied!

webrtcConfig.iceTransportPolicy

Type
Default
Required
Object
null
false
You can ice transport policy, which can limit the transport policies of the ICE candidates to be considered during the connection process.
iceTransportPolicy
Description
"all"
All ICE candidates will be considered.
"public"
Only ICE candidates with public IP addresses will be considered. Removed from the specification's May 13, 2016 working draft.
"relay"
Only ICE candidates whose IP addresses are being relayed, such as those passed through a TURN server, will be considered.
1
let player = OvenPlayer.create("player", {
2
sources : [
3
{
4
type : "webrtc",
5
file : "ws://source"
6
}
7
],
8
webrtcConfig: {
9
iceTransportPolicy: "all"
10
}
11
);
Copied!

hlsConfig

When playing HLS, you can set hls.js detailed tuning options (https://github.com/video-dev/hls.js/blob/master/docs/API.md#fine-tuning).
Type
Default
Required
Object
null
false

dashConfig

When playing DASH, you can set configuration(http://cdn.dashjs.org/latest/jsdoc/module-Settings.html) parameters of Dash.js MediaPlayer.
Type
Default
Required
Object
null
false
Last modified 1mo ago