（以下內容均翻譯自英文版文件，最新資訊及內容敬請切換至英文語系參考原文）
目錄
播放器初始化/非初始化和加載媒體
播放控制
設置播放器參數
取得播放器參數
播放器介面
初始化
初始化一個播放器實例。
import createPlayer from '@blendvision/player'
player = createPlayer(target, config)
參數
const target = 'playerId'
const config =
{
license: '',
title: '',
autoplay: true,
metadata: {
share: [],
description: '',
watermark: {
position: '',
image_url: '',
text: ''
}
},
ui: {
locale: '',
uiMode: ''
},
source,
}
const source = [
{
type: 'dash',
src: '',
drm: {
widevine: {
licenseUri: '',
headers: {},
},
playready: {
licenseUri: '',
headers: {},
},
},
type: 'hls',
src: '',
drm: {
fairplay: {
licenseUri: '',
certificateUri: '',
headers: {},
certificateHeaders: {},
}
},
}
])
自： 2.1.0
釋出
銷毀播放器，並刪除所有插入的 HTML 元素和事件處理程序。
player.release()
自： 2.1.0
加載
設置一個新的影片源，並回傳一個解析為播放器的承諾。
player.load(SourceConfig)
參數
SourceConfig =
{
type: 'vod | live',
src: '',
drm: {
fairplay: {
licenseUri: '',
certificateUri: '',
}
},
}
自： 2.1.0
播放控制
播放
開始播放或暫停後繼續播放。如果在 初始化 播放器時已將自動播放設置為 true，則不需要呼叫它。
如果播放器已在播放中，則沒有效果。
player.play()
自： 2.1.0
暫停
暫停正在播放的影片。如果播放器已經暫停，則不起作用。
player.pause()
自： 2.1.0
跳轉
跳轉到參數 time（秒）指定的播放時間。不得大於影片的總時長。在觀看直播時無效，因為不可能跳轉。
player.seek(seconds)
參數
seconds: float
註解：
由於以跳轉來結束影片可能會導致故障和重播無回應。為了避免這些問題，我們將持續時間設置為 0.7。
範例：
播放時長為 120 秒的影片
player.seek(10) -> player seek 10s player.seek(120) -> player seek 119.3s
自： 2.1.0
快轉
快轉到參數 time 指定的播放時間（以秒為單位）。不得大於影片的總時長。
player.forward(seconds)
參數
seconds: float
自： 2.1.0
倒帶
倒帶至參數 time 指定的播放時間（以秒為單位）。不得大於影片的總時長。
player.rewind(seconds)
參數
seconds: float
自： 2.1.0
取得播放狀態
回傳播放狀態。
player.getPlaybackState()
回傳
State = string init: player is initialized loading: source file is loading paused: playback is paused playing: playback is playing buffering: playback is buffering ended: playback is ended
自： 2.1.0
取得/設定播放器資訊
取得音量
以浮動類型，回傳播放器在 0.0（無聲）和 1.0（最大音量）之間的音量。
player.getVolume()
回傳
volume: float (0.0 ~ 1.0)
自： 2.1.0
設置音量
在 0.0（靜音）到 1.0（最大音量）的範圍內設置播放器的音量。解除播放器的靜音模式。
player.setVolume(volume)
參數
volume: float (0.0 ~ 1.0)
自： 2.1.0
靜音
如果有音軌，則將播放器靜音。如果播放器已經靜音，則不起作用。
player.mute()
自： 2.1.0
解除靜音
如果播放器處於靜音狀態，則解除靜音。
player.unmute()
自： 2.1.0
取得當前時間
回傳影片的當前播放時間，以毫秒為單位。
player.currentTime()
回傳
timeInterval: float
自： 2.1.0
取得總時長
返回當前影片的總時長（以毫秒為單位）。如果是直播串流，則沒有參考值。
player.getDuration()
回傳
timeInterval: float
自： 2.1.0
取得畫質
回傳一個數組，其中包含播放器可適用的所有可用影片畫質。
player.getQualities()
回傳
quality = [{
width,
height,
bitrate,
framerate
}]
自： 2.1.0
取得當前畫質
如果使用者手動選擇了影片畫質，則回傳當前選擇的影片畫質。
在這種情況下，它會返回 getQualities 的其中一個元素。
player.getCurrentQuality()
回傳
quality = [{
width,
height,
bitrate,
framerate
}]
自： 2.1.0
設置畫質
手動將影片串流設置為固定畫質，如：高度範圍、指定位元率，或 null（表示自動重置為動態切換）。 可通過呼叫 getQualities 來取得列表。
player.setQuality(quality)
參數
quality = [{maxHeight, minHeight}]
quality = [{maxHeight: 720}]
quality = null
自： 2.1.0
取得音軌
回傳一個包含所有可用音軌的數組。
player.getAudioTracks()
回傳
language = [{
language: 'en'},{
language: 'zh-TW'}
]
自： 2.1.0
取得當前音軌
如果使用者手動選擇了音軌，則回傳當前選擇的音軌。在這種情況下，它會回傳 getAudioTracks 的其中一個元素。
player.getCurrentAudioTrack()
回傳
language = [{language: 'en'}]
自： 2.1.0
設置音軌
手動將音軌設置為指定語言。可用 getAudioTracks 取得可用的音軌列表。
player.setAudioTrack(language)
參數
language = [{language: 'en'}]
自： 2.1.0
取得字幕
回傳一個包含所有可用字幕的數組。
player.getSubtitles()
回傳
language = [{
language: 'en'},{
language: 'zh-TW'}
]
自： 2.1.0
取得當前字幕
如果使用者手動選擇了字幕，則回傳當前選擇的字幕。在這種情況下，它會回傳 getSubtitles 的其中一個元素。
player.getCurrentSubtitle()
Returns
language = [{language: 'en'}]
自： 2.1.0
設置字幕
手動將字幕設置為指定語言或關閉。可用 getSubtitles 取得可用的字幕列表。
player.setSubtitle(language)
參數
language = [{language: 'en'}]
language = ['off']
自： 2.1.0
取得播放速度
回傳播放器當前的播放速度。1 是默認播放速度，介於 0 和 1 之間的值表示慢動作，大於 1 的值表示快進。小於或等於 0 的值將被忽略。
player.gerPlaybackSpeed()
回傳
speed: number
自： 2.1.0
設置播放速度
設置播放器的播放速度。支援快進和慢動作。數值在 0 和 1 之間時使用慢動作，數值大於 1 時使用快進。
player.setPlaybackSpeed(speed)
參數
speed: number
自： 2.1.0
播放器介面
設置介面模式
將播放器設置為特定的介面模式
player.setViewMode(viewMode)
參數
viewMode: fullscreen | inline
自： 2.1.0
切換控制模式
自動設置使用者界面狀態。當使用者與控制器交互時顯示控制器，當 3 秒內無交互時顯示控制器。控制器包括進度條、跳轉功能、標題、返回按鈕、播放、暫停、倒帶、縮圖等。
player.switchControlMode(viewMode)
參數
viewMode: AUTO | SHOW | HIDE
自： 2.1.0
設置播放器語言
設置播放器語言，而不套用瀏覽器語言設定。
kksPlayer(target, config)
參數
const config = {
ui: {
locale: 'en' | 'ja' | 'zh-TW'
}
}
自： 2.1.0