# API Reference
เมื่อสร้าง bytearkPlayer instance แล้ว สามารถเรียกใช้งาน API ได้ผ่าน Player instance โดยตรง
Note
เนื่องจาก ByteArk Player พัฒนาบนพื้นฐานของ Video.js ทำให้สามารถใช้งาน Methods อื่นๆ ของ Video.js ได้เช่นกัน ดูเอกสารทั้งหมดที่ Video.js Player API (opens new window)
# Setup methods
| Method | Description |
|---|---|
player.dispose() | หยุดการทำงานและทำลาย Video Player พร้อมปล่อยทรัพยากร |
# Playback controller
| Method | Description |
|---|---|
player.play() | เริ่มเล่นวิดีโอ |
player.pause() | หยุดเล่นวิดีโอชั่วคราว |
player.paused() | คืนค่า true หากวิดีโอหยุดเล่นชั่วคราว, false หากกำลังเล่นอยู่ |
# Media controller
# player.src(source)
เปลี่ยน Source ของวิดีโอที่กำลังเล่นอยู่
Parameters
| Attribute | Description | Type |
|---|---|---|
| source | Source object สำหรับใช้ในการเล่นวิดีโอ | Object |
# Audio
# player.volume(volume)
ดึงค่าหรือตั้งค่าความดังของเสียงขณะเล่นวิดีโอ
Parameters
| Attribute | Description | Type |
|---|---|---|
| volume | ตั้งค่าความดังของเสียง มีค่าระหว่าง 0-1 | Number |
Returns
| Description | Type |
|---|---|
| ค่าความดังของเสียง มีค่าระหว่าง 0-1 | Number |
# player.muted(muted)
ดึงค่าหรือตั้งค่า เปิด/ปิด เสียงขณะเล่นวิดีโอ
Parameters
| Attribute | Description | Type |
|---|---|---|
| muted | true ปิดเสียง, false เปิดเสียง | Boolean |
Returns
| Description | Type |
|---|---|
true หากปิดเสียง, false หากเปิดเสียง | Boolean |
# Tracks & quality
# player.qualityLevels()
คืนค่ารายการความละเอียดทั้งหมดของวิดีโอที่กำลังเล่น
Returns
| Description | Type |
|---|---|
| ลิสต์ของ Quality Object | Array |
Quality Object
| Name | Type | Description |
|---|---|---|
| name | String | ชื่อของความละเอียด เช่น 720p, 480p |
| level | Number | Index ของความละเอียด |
| url | Array | ลิสต์ URL ของความละเอียด |
# player.qualityLevel(level)
ดึงค่าหรือตั้งค่าความละเอียดของวิดีโอ
Parameters
| Attribute | Description | Type |
|---|---|---|
| level | Index ของความละเอียดที่ต้องการตั้งค่า | Number |
Returns
| Name | Type | Description |
|---|---|---|
| name | String | ชื่อของความละเอียด |
| level | Number | Index ของความละเอียด |
| url | Array | ลิสต์ URL ของความละเอียด |
# player.hasQualityLevels()
คืนค่า true หากวิดีโอที่กำลังเล่นอยู่มีหลายความละเอียด, false หากไม่มี
# Playback speed
# player.playbackRate(rate)
ดึงค่าหรือตั้งค่าความเร็วในการเล่นวิดีโอ
Parameters
| Attribute | Description | Type |
|---|---|---|
| rate | ความเร็วในการเล่น (ค่าปกติคือ 1.0) | Number |
Returns
| Description | Type |
|---|---|
| ความเร็วในการเล่นปัจจุบัน | Number |
# Time & status
# player.duration()
ความยาวของวิดีโอที่กำลังเล่นอยู่ ขึ้นอยู่กับชนิดของวิดีโอ
Returns
| Media Type | Description | Type |
|---|---|---|
| VOD | ความยาวของวิดีโอ หน่วยเป็นวินาที | Number |
| Live | สำหรับ Live stream จะเป็น Infinity | Number |
# player.currentTime(seconds)
ดึงค่าหรือตั้งค่าเวลาในการเล่นวิดีโอ
Parameters
| Attribute | Description | Type |
|---|---|---|
| seconds | เวลาที่ต้องการตั้งค่า หน่วยเป็นวินาที | Number |
Returns
| Description | Type |
|---|---|
| เวลาปัจจุบันที่กำลังเล่น หน่วยเป็นวินาที | Number |
# player.error()
ดึงค่า Error object ของ Player
Returns
| Name | Type | Description |
|---|---|---|
| code | Number | รหัสของ Error ที่เกิดขึ้น |
| message | String | คำอธิบายของ Error |